REST Resource: projects.messages

{
  "name": string,
  "data": {
    string: string,
    ...
  },
  "notification": {
    object (Notification)
  },
  "android": {
    object (AndroidConfig)
  },
  "webpush": {
    object (WebpushConfig)
  },
  "apns": {
    object (ApnsConfig)
  },
  "fcm_options": {
    object (FcmOptions)
  },

  // Union field target can be only one of the following:
  "token": string,
  "topic": string,
  "condition": string
  // End of list of possible types for union field target.
}

string

Somente saída. O identificador da mensagem enviada, no formato de projects/*/messages/{message_id} .

map (key: string, value: string)

Apenas entrada. Carga útil de chave/valor arbitrária, que deve ser codificada em UTF-8. A chave não deve ser uma palavra reservada ("from", "message_type" ou qualquer palavra que comece com "google" ou "gcm"). Ao enviar cargas contendo apenas campos de dados para dispositivos iOS, apenas a prioridade normal ( "apns-priority": "5" ) é permitida em ApnsConfig .

Um objeto que contém uma lista de pares "key": value . Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

object ( Notification )

Apenas entrada. Modelo básico de notificação para usar em todas as plataformas.

object ( AndroidConfig )

Apenas entrada. Opções específicas do Android para mensagens enviadas através do servidor de conexão FCM .

object ( WebpushConfig )

Apenas entrada. Opções de protocolo Webpush .

object ( ApnsConfig )

Apenas entrada. Opções específicas do Apple Push Notification Service .

object ( FcmOptions )

Apenas entrada. Modelo para opções de recursos do SDK do FCM para uso em todas as plataformas.

string

Token de registro para enviar uma mensagem.

string

Nome do tópico para o qual enviar uma mensagem, por exemplo, "clima". Nota: o prefixo "/topics/" não deve ser fornecido.

string

Condição para enviar uma mensagem, por exemplo, "'foo' nos tópicos && 'bar' nos tópicos".

{
  "title": string,
  "body": string,
  "image": string
}

string

O título da notificação.

string

O texto do corpo da notificação.

string

Contém o URL de uma imagem que será baixada no dispositivo e exibida em uma notificação. JPEG, PNG, BMP têm suporte total em todas as plataformas. GIF animado e vídeo só funcionam no iOS. WebP e HEIF têm vários níveis de suporte entre plataformas e versões de plataforma. O Android tem limite de tamanho de imagem de 1 MB. Uso de cota e implicações/custos para hospedagem de imagens no Firebase Storage: https://firebase.google.com/pricing

{
  "collapse_key": string,
  "priority": enum (AndroidMessagePriority),
  "ttl": string,
  "restricted_package_name": string,
  "data": {
    string: string,
    ...
  },
  "notification": {
    object (AndroidNotification)
  },
  "fcm_options": {
    object (AndroidFcmOptions)
  },
  "direct_boot_ok": boolean
}

string

Um identificador de um grupo de mensagens que pode ser recolhido, para que apenas a última mensagem seja enviada quando a entrega puder ser retomada. São permitidas no máximo 4 chaves de recolhimento diferentes a qualquer momento.

enum ( AndroidMessagePriority )

Prioridade da mensagem. Pode assumir valores "normais" e "altos". Para obter mais informações, consulte Definir a prioridade de uma mensagem .

string ( Duration format)

Por quanto tempo (em segundos) a mensagem deve ser mantida no armazenamento do FCM se o dispositivo estiver off-line. O tempo máximo de vida suportado é de 4 semanas e o valor padrão é de 4 semanas se não for definido. Defina como 0 se quiser enviar a mensagem imediatamente. No formato JSON, o tipo Duration é codificado como uma string em vez de um objeto, onde a string termina com o sufixo "s" (indicando segundos) e é precedida pelo número de segundos, com nanossegundos expressos como segundos fracionários. Por exemplo, 3 segundos com 0 nanossegundos devem ser codificados no formato JSON como "3s", enquanto 3 segundos e 1 nanossegundo devem ser expressos no formato JSON como "3.000000001s". O ttl será arredondado para o segundo mais próximo.

Uma duração em segundos com até nove dígitos fracionários, terminando com ' s '. Exemplo: "3.5s" .

string

Nome do pacote do aplicativo ao qual o token de registro deve corresponder para receber a mensagem.

map (key: string, value: string)

Carga útil de chave/valor arbitrária. Se presente, substituirá google.firebase.fcm.v1.Message.data .

Um objeto que contém uma lista de pares "key": value . Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

object ( AndroidNotification )

Notificação para enviar para dispositivos Android.

object ( AndroidFcmOptions )

Opções de recursos fornecidos pelo SDK do FCM para Android.

boolean

Se definido como verdadeiro, as mensagens poderão ser entregues ao aplicativo enquanto o dispositivo estiver no modo de inicialização direta. Consulte Suporte ao modo de inicialização direta .

{
  "title": string,
  "body": string,
  "icon": string,
  "color": string,
  "sound": string,
  "tag": string,
  "click_action": string,
  "body_loc_key": string,
  "body_loc_args": [
    string
  ],
  "title_loc_key": string,
  "title_loc_args": [
    string
  ],
  "channel_id": string,
  "ticker": string,
  "sticky": boolean,
  "event_time": string,
  "local_only": boolean,
  "notification_priority": enum (NotificationPriority),
  "default_sound": boolean,
  "default_vibrate_timings": boolean,
  "default_light_settings": boolean,
  "vibrate_timings": [
    string
  ],
  "visibility": enum (Visibility),
  "notification_count": integer,
  "light_settings": {
    object (LightSettings)
  },
  "image": string,
}

string

O título da notificação. Se presente, substituirá google.firebase.fcm.v1.Notification.title .

string

O texto do corpo da notificação. Se presente, substituirá google.firebase.fcm.v1.Notification.body .

string

O ícone da notificação. Define o ícone de notificação como myicon para o recurso drawable myicon. Se você não enviar essa chave na solicitação, o FCM exibirá o ícone do iniciador especificado no manifesto do seu aplicativo.

string

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

string

O som a ser reproduzido quando o dispositivo recebe a notificação. Suporta "padrão" ou o nome do arquivo de um recurso de som incluído no aplicativo. Os arquivos de som devem residir em /res/raw/.

string

Identificador usado para substituir notificações existentes na gaveta de notificações. Se não for especificado, cada solicitação criará uma nova notificação. Se especificado e uma notificação com a mesma tag já estiver sendo mostrada, a nova notificação substituirá a existente na gaveta de notificações.

string

A ação associada a um clique do usuário na notificação. Se especificado, uma atividade com um filtro de intenção correspondente será iniciada quando um usuário clicar na notificação.

string

A chave para a string do corpo nos recursos de string do aplicativo a serem usados ​​para localizar o texto do corpo para a localização atual do usuário. Consulte Recursos de String para obter mais informações.

string

Valores de string variáveis ​​a serem usados ​​no lugar dos especificadores de formato em body_loc_key a serem usados ​​para localizar o texto do corpo para a localização atual do usuário. Consulte Formatação e estilo para obter mais informações.

string

A chave para a string de título nos recursos de string do aplicativo a serem usados ​​para localizar o texto do título para a localização atual do usuário. Consulte Recursos de String para obter mais informações.

string

Valores de string variáveis ​​a serem usados ​​no lugar dos especificadores de formato em title_loc_key a serem usados ​​para localizar o texto do título para a localização atual do usuário. Consulte Formatação e estilo para obter mais informações.

string

O ID do canal da notificação (novo no Android O). O aplicativo deve criar um canal com esse ID de canal antes que qualquer notificação com esse ID de canal seja recebida. Se você não enviar esse ID de canal na solicitação ou se o ID de canal fornecido ainda não tiver sido criado pelo aplicativo, o FCM usará o ID de canal especificado no manifesto do aplicativo.

string

Define o texto do “ticker”, que é enviado aos serviços de acessibilidade. Antes do nível 21 da API ( Lollipop ), define o texto que é exibido na barra de status quando a notificação chega pela primeira vez.

boolean

Quando definida como falsa ou não definida, a notificação é automaticamente dispensada quando o usuário clica nela no painel. Quando definida como verdadeira, a notificação persiste mesmo quando o usuário clica nela.

string ( Timestamp format)

Defina a hora em que ocorreu o evento na notificação. As notificações no painel são classificadas por esse horário. Um ponto no tempo é representado usando protobuf.Timestamp .

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z" .

boolean

Defina se esta notificação é ou não relevante apenas para o dispositivo atual. Algumas notificações podem ser transferidas para outros dispositivos para exibição remota, como um relógio Wear OS. Esta dica pode ser definida para recomendar que esta notificação não seja interligada. Consulte os guias do Wear OS

enum ( NotificationPriority )

Defina a prioridade relativa para esta notificação. A prioridade é uma indicação de quanto da atenção do usuário deve ser consumida por esta notificação. As notificações de baixa prioridade podem ficar ocultas do usuário em determinadas situações, enquanto o usuário pode ser interrompido para uma notificação de prioridade mais alta. O efeito de definir as mesmas prioridades pode diferir ligeiramente em plataformas diferentes. Observe que esta prioridade difere de AndroidMessagePriority . Essa prioridade é processada pelo cliente após a entrega da mensagem, enquanto AndroidMessagePriority é um conceito do FCM que controla quando a mensagem é entregue.

boolean

Se definido como verdadeiro, use o som padrão da estrutura do Android para a notificação. Os valores padrão são especificados em config.xml .

boolean

Se definido como verdadeiro, use o padrão de vibração padrão da estrutura Android para a notificação. Os valores padrão são especificados em config.xml . Se default_vibrate_timings estiver definido como true e vibrate_timings também estiver definido, o valor padrão será usado em vez do vibrate_timings especificado pelo usuário.

boolean

Se definido como verdadeiro, use as configurações de luz LED padrão da estrutura do Android para a notificação. Os valores padrão são especificados em config.xml . Se default_light_settings estiver definido como true e light_settings também estiver definido, o light_settings especificado pelo usuário será usado em vez do valor padrão.

string ( Duration format)

Defina o padrão de vibração a ser usado. Passe uma série de protobuf.Duration para ligar ou desligar o vibrador. O primeiro valor indica o Duration de espera antes de ligar o vibrador. O próximo valor indica a Duration para manter o vibrador ligado. Os valores subsequentes alternam entre Duration para desligar o vibrador e para ligar o vibrador. Se vibrate_timings estiver definido e default_vibrate_timings estiver definido como true , o valor padrão será usado em vez do vibrate_timings especificado pelo usuário.

Uma duração em segundos com até nove dígitos fracionários, terminando com ' s '. Exemplo: "3.5s" .

enum ( Visibility )

Defina o Notification.visibility da notificação.

integer

Define o número de itens que esta notificação representa. Pode ser exibido como uma contagem de emblemas para lançadores que suportam emblemas. Consulte Emblema de notificação . Por exemplo, isso pode ser útil se você estiver usando apenas uma notificação para representar várias mensagens novas, mas quiser que a contagem aqui represente o número total de novas mensagens. Se for zero ou não especificado, os sistemas que suportam crachás usam o padrão, que é incrementar um número exibido no menu pressionado cada vez que uma nova notificação chega.

object ( LightSettings )

Configurações para controlar a taxa de intermitência e a cor do LED da notificação se o LED estiver disponível no dispositivo. O tempo total de piscar é controlado pelo sistema operacional.

string

Contém o URL de uma imagem que será exibida em uma notificação. Se presente, substituirá google.firebase.fcm.v1.Notification.image .

{
  "color": {
    object (Color)
  },
  "light_on_duration": string,
  "light_off_duration": string
}

object ( Color )

Obrigatório. Defina color do LED com google.type.Color .

string ( Duration format)

Obrigatório. Junto com light_off_duration , defina a taxa de intermitência dos flashes do LED. Resolução definida por proto.Duration

Uma duração em segundos com até nove dígitos fracionários, terminando com ' s '. Exemplo: "3.5s" .

string ( Duration format)

Obrigatório. Junto com light_on_duration , defina a taxa de intermitência dos flashes do LED. Resolução definida por proto.Duration

Uma duração em segundos com até nove dígitos fracionários, terminando com ' s '. Exemplo: "3.5s" .

{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}

number

A quantidade de vermelho na cor como um valor no intervalo [0, 1].

number

A quantidade de verde na cor como um valor no intervalo [0, 1].

number

A quantidade de azul na cor como um valor no intervalo [0, 1].

number

A fração desta cor que deve ser aplicada ao pixel. Ou seja, a cor final do pixel é definida pela equação:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

Isso significa que um valor de 1,0 corresponde a uma cor sólida, enquanto um valor de 0,0 corresponde a uma cor completamente transparente. Isso usa uma mensagem wrapper em vez de um simples escalar flutuante para que seja possível distinguir entre um valor padrão e o valor que não está definido. Se omitido, esse objeto de cor será renderizado como uma cor sólida (como se o valor alfa tivesse recebido explicitamente um valor de 1,0).

{
  "analytics_label": string
}

string

Rótulo associado aos dados analíticos da mensagem.

{
  "headers": {
    string: string,
    ...
  },
  "data": {
    string: string,
    ...
  },
  "notification": {
    object
  },
  "fcm_options": {
    object (WebpushFcmOptions)
  }
}

map (key: string, value: string)

Cabeçalhos HTTP definidos no protocolo webpush. Consulte o protocolo Webpush para cabeçalhos suportados, por exemplo, "TTL": "15".

Um objeto que contém uma lista de pares "key": value . Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

map (key: string, value: string)

Carga útil de chave/valor arbitrária. Se presente, substituirá google.firebase.fcm.v1.Message.data .

Um objeto que contém uma lista de pares "key": value . Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

object ( Struct format)

Opções de notificação da Web como um objeto JSON. Suporta propriedades de instância de notificação conforme definido na API de notificação da Web . Se presentes, os campos "title" e "body" substituem google.firebase.fcm.v1.Notification.title e google.firebase.fcm.v1.Notification.body .

object ( WebpushFcmOptions )

Opções de recursos fornecidos pelo FCM SDK for Web.

{
  "link": string,
  "analytics_label": string
}

string

O link a ser aberto quando o usuário clica na notificação. Para todos os valores de URL, HTTPS é obrigatório.

string

Rótulo associado aos dados analíticos da mensagem.

{
  "headers": {
    string: string,
    ...
  },
  "payload": {
    object
  },
  "fcm_options": {
    object (ApnsFcmOptions)
  }
}

map (key: string, value: string)

Cabeçalhos de solicitação HTTP definidos no Apple Push Notification Service. Consulte os cabeçalhos de solicitação de APNs para ver os cabeçalhos suportados, como apns-expiration e apns-priority .

O back-end define um valor padrão para apns-expiration de 30 dias e um valor padrão para apns-priority de 10, se não for definido explicitamente.

Um objeto que contém uma lista de pares "key": value . Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

object ( Struct format)

Carga útil de APNs como um objeto JSON, incluindo dicionário aps e carga útil personalizada. Consulte Referência de chave de carga útil . Se presente, substitui google.firebase.fcm.v1.Notification.title e google.firebase.fcm.v1.Notification.body .

object ( ApnsFcmOptions )

Opções de recursos fornecidos pelo SDK do FCM para iOS.

{
  "analytics_label": string,
  "image": string
}

string

Rótulo associado aos dados analíticos da mensagem.

string

Contém o URL de uma imagem que será exibida em uma notificação. Se presente, substituirá google.firebase.fcm.v1.Notification.image .

{
  "analytics_label": string
}

string

Rótulo associado aos dados analíticos da mensagem.