- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- AndroidDeliveryData (link em inglês)
- Date
- Dados
- MessageOutcomePercents (link em inglês)
- DeliveryPerformancePercents (em inglês)
- MessageInsightPercents (link em inglês)
- ProxyNotificationInsightPercents (link em inglês)
- Faça um teste
Lista dados de entrega agregados para um determinado app Android.
Solicitação HTTP
GET https://fcmdata.googleapis.com/v1beta1/{parent=projects/*/androidApps/*}/deliveryData
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
parent |
Obrigatório. O aplicativo para o qual os dados de entrega serão listados. Formato: |
Parâmetros de consulta
Parâmetros | |
---|---|
pageSize |
O número máximo de entradas a serem retornadas. O serviço pode retornar menos que esse valor. Se não for especificado, serão retornadas no máximo 1.000 entradas. O valor máximo é 10.000; valores acima de 10.000 serão limitados a 10.000. Esse padrão pode mudar com o tempo. |
pageToken |
Um token de página recebido de uma chamada |
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Mensagem de resposta para deliveryData.list.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{
"androidDeliveryData": [
{
object ( |
Campos | |
---|---|
androidDeliveryData[] |
Os dados de entrega do app fornecido. Haverá uma entrada por combinação de app, data e marcador de análise. |
nextPageToken |
Um token, que pode ser enviado como |
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/cloud-platform
Dados de entrega do Android
Dados de entrega de mensagens para determinada combinação de rótulos de data, app e análise.
Representação JSON |
---|
{ "appId": string, "date": { object ( |
Campos | |
---|---|
appId |
O ID do app para o qual as mensagens foram enviadas. |
date |
A data representada por esta entrada. |
analyticsLabel |
O marcador de análise associado às mensagens enviadas. Todas as mensagens enviadas sem um marcador de análise serão agrupadas em uma única entrada. |
data |
Os dados para os |
Data
Representa uma data inteira ou parcial do calendário, como um aniversário. A hora do dia e o fuso horário são especificados em outro lugar ou são insignificantes. A data é referente ao calendário gregoriano. Isso pode representar uma das seguintes opções:
- uma data completa, com valores de ano, mês e dia diferentes de zero;
- um mês e dia, com um ano zero (por exemplo, uma data comemorativa);
- um ano sozinho, com um mês zero e um dia zero;
- um ano e mês, com um dia zero (por exemplo, uma data de validade de cartão de crédito).
Tipos relacionados:
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
Representação JSON |
---|
{ "year": integer, "month": integer, "day": integer } |
Campos | |
---|---|
year |
Ano da data. Precisa ser de 1 a 9.999 ou 0 para especificar uma data sem ano. |
month |
Mês do ano. Precisa ser de 1 a 12, ou 0 para especificar um ano sem um mês e dia. |
day |
Dia do mês. Precisa ser de 1 a 31 e válido para o ano e o mês, ou 0 para especificar um ano sozinho ou um ano e mês em que o dia não é significativo. |
Dados
Dados que detalham a entrega de mensagens
Representação JSON |
---|
{ "countMessagesAccepted": string, "countNotificationsAccepted": string, "messageOutcomePercents": { object ( |
Campos | |
---|---|
countMessagesAccepted |
Contagem de mensagens aceitas pelo FCM destinadas a dispositivos Android. É necessário que o dispositivo segmentado tenha ativado a coleta de informações de uso e diagnóstico. |
countNotificationsAccepted |
Contagem de notificações aceitas pelo FCM destinadas a dispositivos Android. É necessário que o dispositivo segmentado tenha ativado a coleta de informações de uso e diagnóstico. |
messageOutcomePercents |
Detalhamento mutuamente exclusivo dos resultados de entrega de mensagens. |
deliveryPerformancePercents |
Informações adicionais sobre o desempenho da entrega de mensagens que foram entregues. |
messageInsightPercents |
Outros insights gerais sobre a entrega de mensagens. |
proxyNotificationInsightPercents |
Mais insights sobre a entrega de notificações de proxy. |
MessageOutcomePercents
Detalhamento percentual dos resultados da entrega de mensagens. Essas categorias são mutuamente exclusivas. Todas as porcentagens são calculadas com countMessagesAccepted
como denominador. Essas categorias podem não considerar todos os resultados de mensagens.
Representação JSON |
---|
{ "delivered": number, "pending": number, "collapsed": number, "droppedTooManyPendingMessages": number, "droppedAppForceStopped": number, "droppedDeviceInactive": number, "droppedTtlExpired": number } |
Campos | |
---|---|
delivered |
A porcentagem de todas as mensagens aceitas que foram entregues ao dispositivo. |
pending |
A porcentagem de mensagens aceitas nesse dia que não foram descartadas e não entregues devido à desconexão do dispositivo (a partir do final do dia nos EUA/Los_Angeles, quando a mensagem foi enviada ao FCM). Uma parte dessas mensagens será entregue no dia seguinte, quando o dispositivo for conectado, mas outras podem ser destinadas a dispositivos que nunca se reconectam. |
collapsed |
A porcentagem de mensagens aceitas que foram recolhidas por outra mensagem. |
droppedTooManyPendingMessages |
A porcentagem de mensagens aceitas que foram descartadas devido a muitas mensagens não recolhíveis não entregues. Especificamente, cada instância do app pode ter apenas 100 mensagens pendentes armazenadas nos nossos servidores para um dispositivo desconectado. Quando esse dispositivo é reconectado, as mensagens são entregues. Quando há mais mensagens pendentes do que o número máximo permitido, chamamos OnDeleteMessages() no SDK em vez de entregar as mensagens. |
droppedAppForceStopped |
A porcentagem de mensagens aceitas que foram descartadas porque o aplicativo foi interrompido de forma forçada no dispositivo no momento da entrega, e as novas tentativas falharam. |
droppedDeviceInactive |
A porcentagem de mensagens aceitas que foram descartadas porque o dispositivo de destino está inativo. O FCM descartará mensagens se o dispositivo de destino for considerado inativo por nossos servidores. Se um dispositivo se reconectar, chamaremos OnDeleteMessages() no nosso SDK em vez de entregar as mensagens. |
droppedTtlExpired |
A porcentagem de mensagens aceitas que expiraram porque o Time to Live (TTL) passou antes da reconexão do dispositivo de destino. |
Percentual de desempenho de entrega
Visão geral do desempenho da entrega de mensagens que foram entregues. Todas as porcentagens são calculadas com countMessagesAccepted
como denominador. Essas categorias não são mutuamente exclusivas; uma mensagem pode atrasar por vários motivos.
Representação JSON |
---|
{ "deliveredNoDelay": number, "delayedDeviceOffline": number, "delayedDeviceDoze": number, "delayedMessageThrottled": number, "delayedUserStopped": number } |
Campos | |
---|---|
deliveredNoDelay |
A porcentagem de mensagens aceitas que foram entregues ao dispositivo sem atraso pelo sistema do FCM. |
delayedDeviceOffline |
A porcentagem de mensagens aceitas que foram atrasadas porque o dispositivo de destino não estava conectado no momento do envio. Essas mensagens foram entregues quando o dispositivo foi reconectado. |
delayedDeviceDoze |
A porcentagem de mensagens aceitas que foram atrasadas porque o dispositivo estava no modo Soneca. Somente mensagens de prioridade normal devem ser atrasadas devido ao modo Soneca. |
delayedMessageThrottled |
A porcentagem de mensagens aceitas que foram atrasadas devido à limitação, como limitação de mensagens recolhíveis ou limitação máxima da taxa de mensagens. |
delayedUserStopped |
A porcentagem de mensagens aceitas que foram atrasadas porque o perfil de usuário do dispositivo pretendido foi interrompido no dispositivo de destino no momento do envio. As mensagens foram entregues quando o perfil do usuário foi reiniciado. |
MessageInsightPercents
Informações adicionais sobre a entrega de mensagens. Todas as porcentagens são calculadas com countMessagesAccepted
como denominador.
Representação JSON |
---|
{ "priorityLowered": number } |
Campos | |
---|---|
priorityLowered |
A porcentagem de mensagens aceitas que tiveram a prioridade reduzida de alta para normal. Consulte a documentação para definir a prioridade de mensagens. |
ProxyNotificationInsightPercents
Mais informações sobre a entrega de notificações de proxy. Todas as porcentagens são calculadas com countNotificationsAccepted
como denominador.
Representação JSON |
---|
{ "proxied": number, "failed": number, "skippedUnsupported": number, "skippedNotThrottled": number, "skippedUnconfigured": number, "skippedOptedOut": number } |
Campos | |
---|---|
proxied |
A porcentagem de notificações aceitas que foram encaminhadas por proxy pelo Google Play Services. |
failed |
A porcentagem de notificações aceitas que não foram encaminhadas por proxy. Isso geralmente é causado por exceções que ocorreram durante a chamada de notifyAsPackage. |
skippedUnsupported |
A porcentagem de notificações aceitas que foram ignoradas porque a notificação de proxy não é compatível com o destinatário. |
skippedNotThrottled |
A porcentagem de notificações aceitas que foram ignoradas porque as mensagens não foram limitadas. |
skippedUnconfigured |
A porcentagem de notificações aceitas que foram ignoradas porque as configurações necessárias para que as notificações sejam transmitidas por proxy estavam ausentes. |
skippedOptedOut |
A porcentagem de notificações aceitas que foram ignoradas porque o app não permitiu o uso de proxy dessas mensagens. |