Protocolo XMPP do Firebase Cloud Messaging

Este parâmetro especifica o destinatário de uma mensagem.

O valor pode ser o token de registro de um dispositivo, a chave de notificação de um grupo de dispositivos ou um único tópico (prefixado com /topics/). Para enviar a vários tópicos, use o parâmetro condition.

Este parâmetro especifica uma expressão lógica de condições que determina o destino da mensagem.

Condição aceita: tópico, formatado como "'seuTópico' em tópicos". Esse valor não diferencia minúsculas de maiúsculas.

Operadores compatíveis: &&, ||. No máximo dois operadores são permitidos por mensagem de tópico.

Com esse parâmetro, uma mensagem é identificada de modo exclusivo em uma conexão XMPP.

Um parâmetro identifica um grupo de mensagens (p.ex., com collapse_key: "Updates Available") que podem ser recolhidas, para que apenas a última seja enviada quando a entrega é retomada. Isso evita o envio de muitas mensagens repetidas quando o dispositivo retorna on-line ou sai do estado de soneca.

Não há garantia quanto à ordem de envio das mensagens.

No máximo quatro chaves de recolhimento diferentes são permitidas a qualquer momento. Isso significa que o FCM pode armazenar simultaneamente quatro mensagens diferentes por app cliente. Se você exceder esse limite, não há garantia de qual das quatro chaves recolhidas será mantida pelo FCM.

Define a prioridade da mensagem. Os valores válidos são "normal" e "high" (alta). Nas plataformas Apple, eles correspondem às prioridades 5 e 10 de APNs.

Por padrão, as mensagens de notificação são enviadas com prioridade alta e as mensagens de dados com prioridade normal. A prioridade normal otimiza o consumo de bateria do app cliente e deve ser sempre usada, exceto quando a entrega imediata é necessária. Mensagens com prioridade normal podem ser recebidas pelo app com atraso não especificado.

Uma mensagem com prioridade alta é enviada imediatamente, e o app pode exibir uma notificação.

Nas plataformas Apple, use este campo para representar content-available no payload de APNs. Quando uma notificação ou mensagem é enviada e este campo está definido como true, um app cliente inativo é ativado, e a mensagem é enviada por APNs como uma notificação silenciosa e não pelo servidor de conexão do FCM. Observe que não é garantido que essas notificações silenciosas em APNs sejam entregues, e isso pode depender de fatores como o usuário ativar o Modo de baixo consumo, saída forçada do app etc. No Android, as mensagens de dados ativam o app por padrão. Ainda não há compatibilidade com o Chrome.

Nas plataformas Apple, use este campo para representar mutable-content no payload de APNs. Quando uma notificação é enviada e este campo está definido como true, o conteúdo dela pode ser modificado antes da exibição por uma extensão de app do serviço de notificação. No Android e na Web, esse parâmetro é ignorado.

Este parâmetro especifica por quanto tempo (em segundos) a mensagem deverá ser mantida no armazenamento do FCM se o dispositivo ficar off-line. A vida útil máxima permitida é quatro semanas. Esse também é o valor padrão. Para mais informações, consulte Como configurar a vida útil de uma mensagem.

Quando definido como true, este parâmetro permite que os desenvolvedores testem uma solicitação sem realmente enviar uma mensagem.

O valor padrão é false.

Este parâmetro especifica os pares de chave-valor do payload da mensagem.

Por exemplo, com data:{"score":"3x1"}:

Nas plataformas Apple, se a mensagem é entregue por APNs, ela é representada por campos de dados personalizados. Quando ela é enviada pelo FCM, ela é representada como um dicionário de chave-valor no AppDelegate application:didReceiveRemoteNotification:.

No Android, isso resulta em um intent adicional chamado score com o valor de string 3x1.

A chave não pode ser uma palavra reservada, por exemplo, "from", "message_type" ou qualquer palavra que comece com "google" ou "gcm". Não use palavras definidas nesta tabela como, por exemplo, collapse_key.

É recomendável usar valores do tipo string. É preciso converter os valores nos objetos ou outros tipos de dados sem string (por exemplo, números inteiros ou booleanos) para string.

O título da notificação.

Este campo não está visível em smartphones e tablets.

O texto do corpo da notificação.

O som a ser reproduzido quando o dispositivo recebe a notificação.

String que especifica arquivos de som no pacote principal do app cliente ou na pasta Library/Sounds do contêiner de dados do app. Consulte mais informações na Biblioteca dos desenvolvedores do iOS.

O valor do indicador no ícone do app da tela inicial.

Se não é especificado, o indicador não é alterado.

Se é definido como 0, o indicador é removido.

A ação associada a um clique de usuário na notificação.

Corresponde a category no payload de APNs.

A legenda da notificação.

A chave da string de corpo nos recursos de string do app, a ser usada para identificar o texto do corpo na localização atual do usuário.

Corresponde a loc-key no payload de APNs.

Para mais informações, consulte Referência da chave de payload e Como localizar o conteúdo de notificações remotas.

Valores de string variáveis a serem usados no lugar dos especificadores de formato em body_loc_key para identificar o texto do corpo na localização atual do usuário.

Corresponde a loc-args no payload de APNs.

Para mais informações, consulte Referência da chave de payload e Como localizar o conteúdo de notificações remotas.

A chave da string de título nos recursos de string do app a ser usada para identificar o texto do título na localização atual do usuário.

Corresponde a title-loc-key no payload de APNs.

Para mais informações, consulte Referência da chave de payload e Como localizar o conteúdo de notificações remotas.

Valores de string variáveis a serem usados no lugar de especificadores de formato em title_loc_key para identificar o texto do título na localização atual do usuário.

Corresponde a title-loc-args no payload de APNs.

Para mais informações, consulte Referência da chave de payload e Como localizar o conteúdo de notificações remotas.

O título da notificação.

O texto do corpo da notificação.

O código do canal da notificação (novo no Android O).

O app precisa criar um canal com este ID do canal antes que qualquer notificação com esse ID seja recebida.

Se você não enviar esse ID do canal na solicitação ou se o ID do canal fornecido ainda não foi criado pelo app, o FCM usará o ID do canal especificado no manifesto do app.

O ícone da notificação.

Define o ícone da notificação como myicon para o recurso drawable myicon. Se você não envia essa chave na solicitação, o FCM exibe o ícone do inicializador especificado no manifesto do app.

O som a ser reproduzido quando o dispositivo recebe a notificação.

Aceita "default" ou o nome do arquivo de um recurso de som no pacote do app. Arquivos de som precisam residir em /res/raw/.

Identificador usado para substituir notificações existentes na gaveta de notificações.

Se não está especificado, cada solicitação cria uma nova notificação.

Se está especificado e uma notificação com a mesma tag já está sendo mostrada, a nova notificação substitui a existente na gaveta das notificações.

A cor do ícone da notificação, expressa no formato #rrggbb.

A ação associada a um clique de usuário na notificação.

Se especificado, uma atividade com um filtro de intent correspondente é iniciada quando um usuário clica na notificação.

A chave da string de corpo nos recursos de string do app, a ser usada para identificar o texto do corpo na localização atual do usuário.

Consulte Recursos de string para mais informações.

Valores de string variáveis a serem usados no lugar dos especificadores de formato em body_loc_key para identificar o texto do corpo na localização atual do usuário.

Consulte Como formatar e definir estilo para mais informações.

A chave da string de título nos recursos de string do app a ser usada para identificar o texto do título na localização atual do usuário.

Consulte Recursos de string para mais informações.

Valores de string variáveis a serem usados no lugar de especificadores de formato em title_loc_key para identificar o texto do título na localização atual do usuário.

Consulte Como formatar e definir estilo para mais informações.

O título da notificação.

O texto do corpo da notificação.

O URL a ser usado para o ícone da notificação.

A ação associada a um clique de usuário na notificação.

Um HTTPS é obrigatório para todos os valores de URL.

O remetente da mensagem é especificado nesse parâmetro.

O valor é o token de registro do app cliente.

Este parâmetro especifica uma mensagem ack ou nack do FCM para o servidor do app.

Quando o valor é definido como nack, o servidor do app verifica error e error_description para receber as informações da falha.

• Se o app cliente cancelar o registro com o FCM.
• Se o app cliente tiver o registro cancelado automaticamente, algo que pode ocorrer se o usuário desinstalar o aplicativo. Por exemplo, no iOS, isso ocorre se o token dos APNs é considerado inválido nos APNs.
• Quando o token de registro expira. Por exemplo, isso ocorre se o Google atualizar os tokens de registro ou se o token de APNs tiver expirado para dispositivos.
• Quando o app cliente está atualizado, mas a nova versão não está configurada para receber mensagens.

A solicitação não foi processada a tempo no servidor. Tente enviar a mesma solicitação novamente. Para isso, é necessário:

• Implementar uma espera exponencial no mecanismo de nova tentativa. Por exemplo, se você esperou um segundo antes da primeira nova tentativa, aguarde pelo menos dois segundos antes da próxima, depois quatro segundos e assim por diante. Se estiver enviando várias mensagens, atrase cada uma de maneira independente por um período aleatório adicional para evitar emitir uma nova solicitação para todas as mensagens ao mesmo tempo.
• Definir o atraso inicial para a nova tentativa como 1 segundo.

Observação: os remetentes que causam problemas podem ser incluídos na lista negra.

O remetente da mensagem é especificado nesse parâmetro.

O valor é o token de registro do app cliente.

O destinatário de uma mensagem de resposta é especificado nesse parâmetro.

O valor é, obrigatoriamente, um token de registro do app cliente que enviou a mensagem upstream.

Este parâmetro especifica o tipo da mensagem: control.

Ele é definido como control para indicar que a mensagem original control_type foi recebida pelo dispositivo.

O tipo de mensagem de controle enviada a partir do FCM é especificado nesse parâmetro.

Atualmente, somente CONNECTION_DRAINING é aceito. O FCM envia essa mensagem de controle antes de encerrar uma conexão para fazer o balanceamento de carga. À medida que a conexão é diminuída, as novas mensagens não podem ser enviadas a ela, mas as que já estão no pipeline continuam sendo processadas.