Configuração de entrega de alta velocidade

Visão geral

Na Pushwoosh, os segmentos de audiência são definidos usando Segmentos.

Para campanhas push padrão, o segmento é compilado após o envio da solicitação /createMessage. Isso significa que pode haver um pequeno atraso antes que a mensagem seja enviada, especialmente se o segmento for complexo.

Com a entrega de alta velocidade, os segmentos são pré-compilados a cada 10 minutos. Isso os mantém atualizados e prontos para uso, para que as mensagens possam ser enviadas instantaneamente — sem esperar pela compilação do segmento.

A entrega de alta velocidade é especialmente útil quando o tempo é crítico. Por exemplo, organizações esportivas como a UEFA e a FIBA podem usá-la para fornecer atualizações em tempo real onde cada segundo importa.

Este guia explica como configurar a entrega de alta velocidade usando um aplicativo de esportes como exemplo. Você aprenderá como criar segmentos de audiência para notificar os usuários sobre as próximas partidas e eventos ao vivo.

Por que entrega de alta velocidade

Os pré-requisitos para usar a entrega de alta velocidade por organizações esportivas são os seguintes:

• Todas as partidas são agendadas com antecedência, então você sabe quando criar os respectivos Segmentos e pode pré-compilar segmentos de audiência
• Cada partida está associada a um ID único. Por exemplo, o ID da partida para a Final da Liga dos Campeões é 0123
• Cada time está associado a um ID único. Por exemplo, o ID da Juventus é 111, o ID do Real Madrid é 222, etc.
• Há um conjunto de eventos ao vivo sobre os quais você gostaria de notificar os usuários (gols, escalações, início da partida, etc.)

Configuração

Assistência de desenvolvedor necessária

---

A configuração da entrega de alta velocidade requer assistência de desenvolvedor. Por favor, compartilhe este guia com eles para a implementação adequada.

Todos os segmentos para entrega de alta velocidade devem ser criados com antecedência — idealmente antes do início da partida no caso de uso de exemplo. A Pushwoosh aplica condições de segmento à base de usuários do aplicativo e pré-compila segmentos a cada 10 minutos (este intervalo é ajustável).

Quando você envia uma solicitação de API /createMessage com o conteúdo do push e o nome do segmento, a Pushwoosh já possui uma lista pré-compilada de destinatários, permitindo que a notificação push seja enviada instantaneamente.

Importante

---

A compilação de segmentos consome recursos, e sua velocidade depende de:

• a complexidade das condições do Segmento (o número de Tags usadas, uma alta cardinalidade de valores de Tag);
• o número de Segmentos únicos pré-compilados simultaneamente;
• o número de usuários inscritos no aplicativo.

Portanto, todos os Segmentos para um jogo devem ser criados via API antes do início do jogo e excluídos depois para manter o número de Segmentos pré-compilados ativos no mínimo e economizar recursos de computação.

Criar Tags

Primeiro, crie um conjunto de Tags para aplicar e defina valores de Tag para os dispositivos dos usuários. Crie Tags do tipo LIST correspondentes a eventos de partidas ao vivo, como início, gol, cartão vermelho, etc.

Por exemplo: MATCH-KICKOFF, MATCH-GOAL, MATCH-RED_CARD

Crie o mesmo conjunto de Tags descrevendo eventos de partidas ao vivo para times. Por exemplo: TEAM-KICKOFF, TEAM-GOAL, TEAM-RED_CARD

Dica

Para criar Tags via API, chame /addTag.

Ao se inscrever nessas Tags, os usuários do aplicativo podem escolher quais notificações gostariam de receber:

• notificações sobre a partida específica (ex: partida Juventus - Real Madrid);
• notificações sobre as partidas do time favorito (ex: apenas partidas da Juventus);
• notificações sobre eventos ocorrendo durante a partida (ex: gols apenas na partida Juventus - Real Madrid);
• notificações sobre eventos específicos do time favorito (ex: gols e escalações das partidas da Juventus).

Definir Tags

Agora você pode preencher os valores de Tag especificados anteriormente via solicitação de API setTags e inscrever usuários em categorias específicas de notificações push.

Por exemplo: Quando um usuário se inscreve para receber atualizações de início e gols da Final da Liga dos Campeões, chame o /setTags contendo o ID da partida:

{
  "request": {
    "application": "app_code",
    "hwid": "device_hardware_id",
    "tags": {
      "MATCH_KICKOFF": "0123", // ID da partida
      "MATCH_GOAL": "0123"     // ID da partida
    }
  }
}

O usuário receberá notificações sobre o início e gols marcados na Final da Liga dos Campeões. Quando um usuário se inscreve para receber atualizações de gols e cartões vermelhos das partidas do Real Madrid, chame o /setTags da seguinte forma:

{
  "request": {
    "application": "app_code",
    "hwid": "device_hardware_id",
    "tags": {
      "TEAM_KICKOFF": "222", // ID do time
      "TEAM_GOAL": "222"     // ID do time
    }
  }
}

Este usuário receberá notificações sobre inícios de partidas e gols sempre que o Real Madrid estiver jogando.

Criar Segmentos

Agora você pode criar Segmentos para eventos de partidas com base em Tags e seus valores (IDs de partidas e IDs de times). Os Segmentos devem ser criados via solicitação de API /createFilter 30 minutos antes do início da partida.

Para notificar os usuários sobre gols marcados na Final da Liga dos Campeões do exemplo acima, chame o /createFilter com os seguintes parâmetros: Nome do segmento: 0123_GOAL Condições do segmento: #TEAM-GOAL(111, 222) OR #MATCH-GOAL(0123)

{
  "request": {
    "auth": "auth_token",
    "name": "0123_GOAL",
    "conditions": [
      ["TEAM-GOAL", "IN", ["111", "222"]],
      ["MATCH-GOAL", "IN", ["0123"]]
    ],
    "operator": "OR", // opcional. Valores do operador: 'AND', 'OR'
    "application" : "AAAAA-00000"
  }
}

Esta solicitação compilará o segmento de usuários inscritos para atualizações de gols da Final da Liga dos Campeões (ID da partida=0123) OU usuários que seguem a Juventus ou o Real Madrid (ID do time=111,222).

Para configurar uma Entrega de Alta Velocidade no seu Painel de Controle Pushwoosh, crie um novo Segmento com os valores de Tag correspondentes e associe-o ao aplicativo para o qual você enviará pushes. Segmentos específicos do aplicativo são pré-compilados a cada 10 minutos para manter os segmentos de audiência sempre atualizados.

Quando o evento da partida ocorrer (gol marcado, início da partida, cartão vermelho, etc.), chame o /createMessage contendo o conteúdo da notificação push e o nome do Segmento:

{
  "request": {
    "application": "AAAAA_00000",
    "auth": "auth_token",
    "notifications": [
      {
        "content": "12’ Juventus goal! Juventus 1 – 0 Real Madrid",
        "filter": "0123_GOAL",
        "send_date": "now"
      }
    ]
  }
}

Assim que recebermos a chamada /createMessage, já teremos uma lista pré-compilada de dispositivos que correspondem aos critérios do Segmento, e enviaremos imediatamente a notificação para os gateways APNs e FCM.

Importante

---

Segmentos de Entrega de Alta Velocidade não suportam o uso do operador daysago. Se você tentar criar um Segmento com este operador, receberá uma mensagem de erro.

Essa restrição existe porque, para funcionar corretamente, os Segmentos de Entrega de Alta Velocidade dependem de mudanças que aconteceram no aplicativo nos dispositivos dos usuários (como se inscrever para notificações push ou definir um valor de Tag específico). O operador daysago não envolve tais mudanças, então o Segmento não funcionará como pretendido. Além disso, observe que os Segmentos de Entrega de Alta Velocidade não podem ser usados com mensagens agendadas.

Excluir Segmentos

Após o término da partida, todos os Segmentos correspondentes devem ser excluídos para que os recursos de computação não sejam gastos em recompilação adicional de Segmentos que não são mais relevantes, especialmente às custas de Segmentos para partidas que estão agendadas a seguir. Exclua Segmentos via solicitação de API /deleteFilter, por exemplo:

{
  "request": {
    "auth": "auth_token",
    "name": "0123_GOAL"
  }
}

Para evitar a exclusão manual de Segmentos, defina a data de expiração do Segmento via solicitação /createFilter para que o Segmento seja excluído automaticamente na data especificada:

{
  "request": {
    "auth": "auth_token",
    "name": "0123_GOAL",
    "conditions": [
      ["TEAM-GOAL", "IN", ["111", "222"]],
      ["MATCH-GOAL", "IN", ["0123"]]
    ],
    "operator": "OR",  // opcional. Valores: 'AND', 'OR'
    "application": "AAAAA-00000",
    "expiration_date": "YYYY-MM-DD"  // opcional. Expiração do Segmento (Filtro)
  }
}