Method: projects.androidApps.deliveryData.list

Выведите совокупные данные о доставке для данного приложения Android.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
parent

string

Необходимый. Приложение, для которого перечисляются данные о доставке. Формат: projects/{projectId}/androidApps/{appId}

Параметры запроса

Параметры
pageSize

integer

Максимальное количество возвращаемых записей. Служба может возвращать меньшее значение, чем это значение. Если не указано, будет возвращено не более 1000 записей. Максимальное значение — 10 000; значения выше 10 000 будут ограничены до 10 000. Это значение по умолчанию может со временем измениться.

pageToken

string

Токен страницы, полученный в результате предыдущего вызова ListAndroidDeliveryDataRequest . Предоставьте это, чтобы получить следующую страницу. При разбиении на страницы все остальные параметры, предоставляемые ListAndroidDeliveryDataRequest , должны соответствовать вызову, который предоставил токен страницы.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Ответное сообщение для DeliveryData.list.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "androidDeliveryData": [
    {
      object (AndroidDeliveryData)
    }
  ],
  "nextPageToken": string
}
Поля
androidDeliveryData[]

object ( AndroidDeliveryData )

Данные о доставке для предоставленного приложения. Для каждой комбинации приложения, даты и метки аналитики будет одна запись.

nextPageToken

string

Токен, который можно отправить как pageToken для получения следующей страницы. Если это поле опущено, последующие страницы отсутствуют.

Области авторизации

Требуется следующая область действия OAuth:

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

AndroidDeliveryData

Данные о доставке сообщений для определенной даты, приложения и комбинации меток аналитики.

JSON-представление 
{
  "appId": string,
  "date": {
    object (Date)
  },
  "analyticsLabel": string,
  "data": {
    object (Data)
  }
}
Поля
appId

string

Идентификатор приложения, которому были отправлены сообщения.

date

object ( Date )

Дата, представленная этой записью.

analyticsLabel

string

Метка аналитики, связанная с отправленными сообщениями. Все сообщения, отправленные без метки аналитики, будут сгруппированы в одну запись.

data

object ( Data )

Данные для указанных appId , date и analyticsLabel .

Дата

Представляет полную или частичную календарную дату, например день рождения. Время суток и часовой пояс либо указаны в другом месте, либо не имеют значения. Дата указана по григорианскому календарю. Это может представлять собой одно из следующих действий:

  • Полная дата с ненулевыми значениями года, месяца и дня.
  • Месяц и день с нулевым годом (например, годовщина).
  • Год сам по себе, с нулевым месяцем и нулевым днем.
  • Год и месяц с нулевым днем ​​(например, дата истечения срока действия кредитной карты).

Связанные типы:

JSON-представление 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Поля
year

integer

Год даты. Должно быть от 1 до 9999 или 0, чтобы указать дату без года.

month

integer

Месяц года. Должно быть от 1 до 12 или 0, чтобы указать год без месяца и дня.

day

integer

День месяца. Должно быть от 1 до 31 и действительно для года и месяца, или 0, чтобы указать год отдельно или год и месяц, если день не имеет значения.

Данные

Данные с подробным описанием доставки сообщений

JSON-представление 
{
  "countMessagesAccepted": string,
  "countNotificationsAccepted": string,
  "messageOutcomePercents": {
    object (MessageOutcomePercents)
  },
  "deliveryPerformancePercents": {
    object (DeliveryPerformancePercents)
  },
  "messageInsightPercents": {
    object (MessageInsightPercents)
  },
  "proxyNotificationInsightPercents": {
    object (ProxyNotificationInsightPercents)
  }
}
Поля
countMessagesAccepted

string ( int64 format)

Количество сообщений, принятых FCM, предназначенных для устройств Android. Целевое устройство должно быть включено в сбор информации об использовании и диагностике.

countNotificationsAccepted

string ( int64 format)

Количество уведомлений, принятых FCM, предназначенных для устройств Android. Целевое устройство должно быть включено в сбор информации об использовании и диагностике.

messageOutcomePercents

object ( MessageOutcomePercents )

Взаимоисключающая разбивка результатов доставки сообщений.

deliveryPerformancePercents

object ( DeliveryPerformancePercents )

Дополнительная информация о производительности доставки успешно доставленных сообщений.

messageInsightPercents

object ( MessageInsightPercents )

Дополнительные общие сведения о доставке сообщений.

proxyNotificationInsightPercents

object ( ProxyNotificationInsightPercents )

Дополнительные сведения о доставке уведомлений через прокси.

СообщениеOutcomePercents

Процентная разбивка результатов доставки сообщений. Эти категории являются взаимоисключающими. Все проценты рассчитываются с использованием countMessagesAccepted в качестве знаменателя. Эти категории могут не учитывать все результаты сообщений.

JSON-представление 
{
  "delivered": number,
  "pending": number,
  "collapsed": number,
  "droppedTooManyPendingMessages": number,
  "droppedAppForceStopped": number,
  "droppedDeviceInactive": number,
  "droppedTtlExpired": number
}
Поля
delivered

number

Процент всех принятых сообщений, которые были успешно доставлены на устройство.

pending

number

Процент сообщений, принятых в этот день, которые не были удалены и не доставлены из-за отключения устройства (на конец дня в Америке/Лос-Анджелесе, когда сообщение было отправлено в FCM). Часть этих сообщений будет доставлена ​​на следующий день, когда устройство подключится, но другие могут быть отправлены на устройства, которые в конечном итоге никогда не подключатся повторно.

collapsed

number

Процент принятых сообщений, которые были свернуты другим сообщением.

droppedTooManyPendingMessages

number

Процент принятых сообщений, которые были удалены из-за слишком большого количества недоставленных несворачиваемых сообщений . В частности, каждый экземпляр приложения может хранить на наших серверах только 100 ожидающих сообщений для отключенного устройства. Когда это устройство повторно подключается, эти сообщения доставляются. Если количество ожидающих сообщений превышает максимальное количество, мы вызываем OnDeletedMessages() в нашем SDK вместо доставки сообщений.

droppedAppForceStopped

number

Процент принятых сообщений, которые были удалены из-за того, что приложение было принудительно остановлено на устройстве во время доставки и повторные попытки оказались неудачными.

droppedDeviceInactive

number

Процент принятых сообщений, которые были удалены из-за неактивности целевого устройства. FCM будет удалять сообщения, если наши серверы считают целевое устройство неактивным. Если устройство повторно подключается, мы вызываем OnDeletedMessages() в нашем SDK вместо доставки сообщений.

droppedTtlExpired

number

Процент принятых сообщений, срок действия которых истек, поскольку время жизни (TTL) истекло до повторного подключения целевого устройства.

ДоставкаПроизводительностьПроценты

Обзор эффективности доставки успешно доставленных сообщений. Все проценты рассчитываются с использованием countMessagesAccepted в качестве знаменателя. Эти категории не являются взаимоисключающими; сообщение может быть задержано по нескольким причинам.

JSON-представление 
{
  "deliveredNoDelay": number,
  "delayedDeviceOffline": number,
  "delayedDeviceDoze": number,
  "delayedMessageThrottled": number,
  "delayedUserStopped": number
}
Поля
deliveredNoDelay

number

Процент принятых сообщений, доставленных на устройство без задержки из системы FCM.

delayedDeviceOffline

number

Процент принятых сообщений, которые были задержаны из-за того, что целевое устройство не было подключено во время отправки. Эти сообщения в конечном итоге были доставлены при повторном подключении устройства.

delayedDeviceDoze

number

Процент принятых сообщений, которые были задержаны из-за того, что устройство находилось в спящем режиме. Из-за режима ожидания следует задерживать только обычные приоритетные сообщения .

delayedMessageThrottled

number

Процент принятых сообщений, которые были задержаны из-за регулирования количества сообщений, например регулирования свертываемости сообщений или регулирования максимальной скорости сообщений .

delayedUserStopped

number

Процент принятых сообщений, которые были задержаны из-за того, что профиль пользователя предполагаемого устройства был остановлен на целевом устройстве во время отправки. Сообщения в конечном итоге были доставлены, когда профиль пользователя был снова запущен.

СообщениеInsightPercents

Дополнительная информация о доставке сообщений. Все проценты рассчитываются с использованием countMessagesAccepted в качестве знаменателя.

JSON-представление 
{
  "priorityLowered": number
}
Поля
priorityLowered

number

Процент принятых сообщений, приоритет которых понижен с высокого до нормального. См. документацию по настройке приоритета сообщения .

Проксинотификатионинсайтперцентс

Дополнительная информация о доставке уведомлений через прокси . Все проценты рассчитываются с использованием countNotificationsAccepted в качестве знаменателя.

JSON-представление 
{
  "proxied": number,
  "failed": number,
  "skippedUnsupported": number,
  "skippedNotThrottled": number,
  "skippedUnconfigured": number,
  "skippedOptedOut": number
}
Поля
proxied

number

Процент принятых уведомлений, которые были успешно проксированы сервисами Google Play .

failed

number

Процент принятых уведомлений, которые не удалось проксировать. Обычно это вызвано исключениями, возникшими при вызове notifyAsPackage .

skippedUnsupported

number

Процент принятых уведомлений, которые были пропущены, поскольку уведомление прокси-сервера не поддерживается получателем.

skippedNotThrottled

number

Процент принятых уведомлений, которые были пропущены, поскольку сообщения не были ограничены.

skippedUnconfigured

number

Процент принятых уведомлений, которые были пропущены из-за отсутствия конфигураций, необходимых для проксирования уведомлений.

skippedOptedOut

number

Процент принятых уведомлений, которые были пропущены, поскольку приложение запретило пересылку этих сообщений.