Method: projects.androidApps.deliveryData.list

Répertoriez les données de livraison globales pour l’application Android donnée.

Requête HTTP

GET https://fcmdata.googleapis.com/v1beta1/{parent=projects/*/androidApps/*}/deliveryData

L'URL utilise la syntaxe de transcodage gRPC .

Paramètres du chemin

Paramètres
parent

string

Requis. L'application pour laquelle répertorier les données de livraison. Format : projects/{project_id}/androidApps/{appId}

Paramètres de requête

Paramètres
pageSize

integer

Le nombre maximum d'entrées à renvoyer. Le service peut renvoyer moins que cette valeur. Si rien n’est spécifié, au maximum 1 000 entrées seront renvoyées. La valeur maximale est de 10 000 ; les valeurs supérieures à 10 000 seront plafonnées à 10 000. Cette valeur par défaut peut changer avec le temps.

pageToken

string

Un jeton de page, reçu lors d’un précédent appel ListAndroidDeliveryDataRequest . Fournissez ceci pour récupérer la page suivante. Lors de la pagination, tous les autres paramètres fournis à ListAndroidDeliveryDataRequest doivent correspondre à l'appel qui a fourni le jeton de page.

Corps de la demande

Le corps de la requête doit être vide.

Corps de réponse

En cas de succès, le corps de la réponse contient des données avec la structure suivante :

Message de réponse pour deliveryData.list.

Représentation JSON
{
  "androidDeliveryData": [
    {
      object (AndroidDeliveryData)
    }
  ],
  "nextPageToken": string
}
Des champs
androidDeliveryData[]

object ( AndroidDeliveryData )

Les données de livraison pour l'application fournie. Il y aura une entrée par combinaison d’application, de date et d’étiquette d’analyse.

nextPageToken

string

Un jeton, qui peut être envoyé sous forme de pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas de pages suivantes.

Portées des autorisations

Nécessite le champ d'application OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Données de livraison Android

Données de livraison des messages pour une combinaison donnée de date, d'application et d'étiquette d'analyse.

Représentation JSON
{
  "appId": string,
  "date": {
    object (Date)
  },
  "analyticsLabel": string,
  "data": {
    object (Data)
  }
}
Des champs
appId

string

L'ID de l'application à laquelle les messages ont été envoyés.

date

object ( Date )

La date représentée par cette entrée.

analyticsLabel

string

Étiquette d'analyse associée aux messages envoyés. Tous les messages envoyés sans étiquette d'analyse seront regroupés dans une seule entrée.

data

object ( Data )

Les données pour l' appId , date et analyticsLabel spécifiés.

Date

Représente une date du calendrier entière ou partielle, comme un anniversaire. L'heure et le fuseau horaire sont soit indiqués ailleurs, soit insignifiants. La date est relative au calendrier grégorien. Cela peut représenter l'un des éléments suivants :

  • Une date complète, avec des valeurs d'année, de mois et de jour non nulles.
  • Un mois et un jour, avec une année nulle (par exemple, un anniversaire).
  • Une année à elle seule, avec un mois zéro et un jour zéro.
  • Une année et un mois, avec un jour zéro (par exemple, la date d'expiration d'une carte de crédit).

Types associés :

Représentation JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
Des champs
year

integer

Année de la date. Doit être compris entre 1 et 9999, ou 0 pour spécifier une date sans année.

month

integer

Mois d'un an. Doit être compris entre 1 et 12, ou 0 pour spécifier une année sans mois ni jour.

day

integer

Jour d'un mois. Doit être compris entre 1 et 31 et valable pour l'année et le mois, ou 0 pour spécifier une année seule ou une année et un mois où le jour n'est pas significatif.

Données

Données détaillant la livraison des messages

Représentation JSON
{
  "countMessagesAccepted": string,
  "messageOutcomePercents": {
    object (MessageOutcomePercents)
  },
  "deliveryPerformancePercents": {
    object (DeliveryPerformancePercents)
  },
  "messageInsightPercents": {
    object (MessageInsightPercents)
  }
}
Des champs
countMessagesAccepted

string ( int64 format)

Nombre de messages acceptés par FCM destinés aux appareils Android. L'appareil ciblé doit avoir accepté la collecte d'informations d'utilisation et de diagnostic.

messageOutcomePercents

object ( MessageOutcomePercents )

Répartition mutuellement exclusive des résultats de livraison des messages.

deliveryPerformancePercents

object ( DeliveryPerformancePercents )

Informations supplémentaires sur les performances de livraison pour les messages qui ont été livrés avec succès.

messageInsightPercents

object ( MessageInsightPercents )

Informations générales supplémentaires sur la livraison des messages.

MessageRésultatPourcentages

Répartition en pourcentage des résultats de la livraison des messages. Ces catégories s'excluent mutuellement. Tous les pourcentages sont calculés avec countMessagesAccepted comme dénominateur. Ces catégories peuvent ne pas représenter tous les résultats des messages.

Représentation JSON
{
  "delivered": number,
  "pending": number,
  "droppedTooManyPendingMessages": number,
  "droppedAppForceStopped": number,
  "droppedDeviceInactive": number
}
Des champs
delivered

number

Pourcentage de tous les messages acceptés qui ont été transmis avec succès à l'appareil.

pending

number

Pourcentage de messages acceptés ce jour-là qui n'ont pas été abandonnés ni remis, en raison de la déconnexion de l'appareil (à la fin de la journée America/Los_Angeles lorsque le message a été envoyé à FCM). Une partie de ces messages sera délivrée le lendemain lors de la connexion de l'appareil mais d'autres pourront être destinés à des appareils qui ne se reconnecteront finalement jamais.

droppedTooManyPendingMessages

number

Pourcentage de messages acceptés qui ont été abandonnés en raison d' un trop grand nombre de messages non remis et non réductibles . Plus précisément, chaque instance d'application ne peut avoir que 100 messages en attente stockés sur nos serveurs pour un appareil déconnecté. Lorsque cet appareil se reconnecte, ces messages sont transmis. Lorsqu'il y a plus que le nombre maximum de messages en attente, nous appelons OnDeletedMessages() dans notre SDK au lieu de transmettre les messages.

droppedAppForceStopped

number

Pourcentage de messages acceptés qui ont été abandonnés parce que l'application a été arrêtée de force sur l'appareil au moment de la livraison et que les tentatives ont échoué.

droppedDeviceInactive

number

Pourcentage de messages acceptés qui ont été abandonnés car le périphérique cible est inactif. FCM supprimera les messages si l'appareil cible est jugé inactif par nos serveurs. Si un appareil se reconnecte, nous appelons OnDeletedMessages() dans notre SDK au lieu de transmettre les messages.

Pourcentages de performances de livraison

Présentation des performances de livraison pour les messages qui ont été livrés avec succès. Tous les pourcentages sont calculés avec countMessagesAccepted comme dénominateur. Ces catégories ne s’excluent pas mutuellement ; un message peut être retardé pour plusieurs raisons.

Représentation JSON
{
  "deliveredNoDelay": number,
  "delayedDeviceOffline": number,
  "delayedDeviceDoze": number,
  "delayedMessageThrottled": number,
  "delayedUserStopped": number
}
Des champs
deliveredNoDelay

number

Pourcentage de messages acceptés qui ont été transmis sans délai à l'appareil par le système FCM.

delayedDeviceOffline

number

Pourcentage de messages acceptés qui ont été retardés parce que le périphérique cible n'était pas connecté au moment de l'envoi. Ces messages ont finalement été délivrés lorsque l'appareil s'est reconnecté.

delayedDeviceDoze

number

Pourcentage de messages acceptés qui ont été retardés parce que l'appareil était en mode veille. Seuls les messages prioritaires normaux doivent être retardés en raison du mode veille.

delayedMessageThrottled

number

Pourcentage de messages acceptés qui ont été retardés en raison de la limitation des messages, telle que la limitation des messages réductibles ou la limitation du débit maximal des messages .

delayedUserStopped

number

Pourcentage de messages acceptés qui ont été retardés parce que le profil utilisateur de périphérique prévu a été arrêté sur le périphérique cible au moment de l'envoi. Les messages ont finalement été délivrés lorsque le profil utilisateur a été redémarré.

MessageInsightPercents

Informations supplémentaires sur la livraison des messages. Tous les pourcentages sont calculés avec countMessagesAccepted comme dénominateur.

Représentation JSON
{
  "priorityLowered": number
}
Des champs
priorityLowered

number

Pourcentage de messages acceptés dont la priorité a été abaissée d'élevée à normale. Consultez la documentation pour définir la priorité des messages .