Pular para o conteúdo principal

Limites

Referência rápida do que cada campo da AI Web Push API aceita. Os valores abaixo são os mesmos que a API valida; fora deles a resposta é 400 com a mensagem correspondente em Erros.

POST /campaign/create

CampoRegra
titleObrigatório, de 3 a 100 caracteres
bodyObrigatório, de 3 a 300 caracteres
linkObrigatório
topics / countriesPelo menos um dos dois, com ao menos um valor; use os nomes como GET /topics e GET /countries devolvem (minúsculas, países com country__)
callToActionOpcional, até 20 caracteres
icon / imageOpcionais; se enviados, precisam começar com https://
statuspublished, draft ou failed
scheduleModenow ou scheduled
scheduleDateObrigatório quando scheduleMode é scheduled; data UTC
ttlNúmero inteiro até 2419200 segundos (28 dias); o padrão é 2419200 e enviar 0 também resulta no padrão
utmSource / utmMedium / utmCampaignOpcionais; são anexados ao link

POST /campaigns

CampoRegra
limitDe 1 a 60; o padrão é 10 e valores acima de 60 viram 60
startDate / endDateDatas UTC; startDate não pode ser maior que endDate
dateFieldcreatedAt ou scheduleDate; padrão createdAt
statusdraft, scheduled, sent ou failed
cursorUse exatamente o valor devolvido em nextCursor

Dicas para a notificação render mais

Os limites acima são o máximo aceito, não o tamanho ideal. Navegadores e sistemas cortam textos longos, então:

  • Título curto. É o que aparece inteiro na maioria dos dispositivos; coloque a informação principal no começo.
  • Texto direto. O body aceita 300 caracteres, mas muitos dispositivos mostram bem menos antes de truncar.
  • Botão de até 20 caracteres (callToAction): um verbo e um objeto, como Ver ofertas.
  • Ícone quadrado em HTTPS, 192×192 recomendado. Imagem grande (image) opcional, também em HTTPS.
  • TTL coerente com a oferta. Se a promoção acaba em 24 h, ttl: 86400 evita entregar a notificação depois do prazo a quem estava offline.
  • UTMs para ver o tráfego da campanha no seu analytics: utmSource, utmMedium e utmCampaign são anexados ao link.