Method: accounts.networkReport.generate

Генерирует отчет по сети AdMob на основе предоставленной спецификации отчета. Возвращает результат потокового RPC-запроса на стороне сервера. Результат возвращается в виде последовательности ответов.

HTTP-запрос

POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/networkReport:generate

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

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

Параметры
parent

string

Имя ресурса учетной записи, для которой нужно сгенерировать отчет. Пример: accounts/pub-9876543210987654

Текст запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "reportSpec": {
    object (NetworkReportSpec)
  }
}
Поля
reportSpec

object ( NetworkReportSpec )

Спецификация сетевого отчета.

Ответный текст

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

Например:

[{
  "header": {
    "dateRange": {
      "startDate": {"year": 2018, "month": 9, "day": 1},
      "endDate": {"year": 2018, "month": 9, "day": 1}
    },
    "localizationSettings": {
      "currencyCode": "USD",
      "languageCode": "en-US"
    }
  }
},
{
  "row": {
    "dimensionValues": {
      "DATE": {"value": "20180918"},
      "APP": {
        "value": "ca-app-pub-8123415297019784~1001342552",
         displayLabel: "My app name!"
      }
    },
    "metricValues": {
      "ESTIMATED_EARNINGS": {"microsValue": 6500000}
    }
  }
},
{
  "footer": {"matchingRowCount": 1}
}]

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

JSON-представление 
{

  // Union field payload can be only one of the following:
  "header": {
    object (ReportHeader)
  },
  "row": {
    object (ReportRow)
  },
  "footer": {
    object (ReportFooter)
  }
  // End of list of possible types for union field payload.
}
Поля
Поле объединения payload . Каждое сообщение ответа потока содержит один тип полезной нагрузки. payload может быть только одной из следующих:
header

object ( ReportHeader )

Настройки генерации отчета, описывающие его содержимое, такие как диапазон дат отчета и параметры локализации.

row

object ( ReportRow )

Фактические данные отчета.

footer

object ( ReportFooter )

Дополнительная информация о сгенерированном отчете, например, предупреждения о данных.

Области полномочий

Требуется один из следующих диапазонов аутентификации OAuth:

  • https://www.googleapis.com/auth/admob.readonly
  • https://www.googleapis.com/auth/admob.report

Для получения более подробной информации см.OAuth 2.0 Overview .

NetworkReportSpec

Спецификация для создания отчета по сети AdMob. Например, спецификация для получения данных о кликах и предполагаемом доходе только для стран «США» и «Китай» может выглядеть следующим образом:

{
  'dateRange': {
    'startDate': {'year': 2021, 'month': 9, 'day': 1},
    'endDate': {'year': 2021, 'month': 9, 'day': 30}
  },
  'dimensions': ['DATE', 'APP', 'COUNTRY'],
  'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'],
  'dimensionFilters': [
    {
      'dimension': 'COUNTRY',
      'matchesAny': {'values': [{'value': 'US', 'value': 'CN'}]}
    }
  ],
  'sortConditions': [
    {'dimension':'APP', order: 'ASCENDING'},
    {'metric':'CLICKS', order: 'DESCENDING'}
  ],
  'localizationSettings': {
    'currencyCode': 'USD',
    'languageCode': 'en-US'
  }
}

Для лучшего понимания, приведенное выше описание можно рассматривать как следующий псевдо-SQL-запрос:

SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS
FROM NETWORK_REPORT
WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30'
    AND COUNTRY IN ('US', 'CN')
GROUP BY DATE, APP, COUNTRY
ORDER BY APP ASC, CLICKS DESC;
JSON-представление 
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "dimensionFilters": [
    {
      object (DimensionFilter)
    }
  ],
  "sortConditions": [
    {
      object (SortCondition)
    }
  ],
  "localizationSettings": {
    object (LocalizationSettings)
  },
  "maxReportRows": integer,
  "timeZone": string
}
Поля
dateRange

object ( DateRange )

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

dimensions[]

enum ( Dimension )

Список параметров отчета. Комбинация значений этих параметров определяет строку отчета. Если параметры не указаны, отчет возвращает одну строку запрошенных показателей для всей учетной записи.

metrics[]

enum ( Metric )

Список показателей отчета. В отчете должен быть указан как минимум один показатель.

dimensionFilters[]

object ( DimensionFilter )

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

sortConditions[]

object ( SortCondition )

Описывает сортировку строк отчета. Порядок условия в списке определяет его приоритет; чем раньше условие, тем выше его приоритет. Если условия сортировки не указаны, порядок строк не определен.

localizationSettings

object ( LocalizationSettings )

Настройки локализации отчета.

maxReportRows

integer

Максимальное количество строк данных отчета, которое может быть возвращено. Если значение не задано, API возвращает максимально возможное количество строк, до 100000. Допустимые значения: от 1 до 100000 включительно. Значения, превышающие 100000, приводят к ошибке.

timeZone

string

Часовой пояс для отчета. Принимает значения имени часового пояса IANA, например, "America/Los_Angeles". Если часовой пояс не определен, используется значение по умолчанию для учетной записи. Проверить значение по умолчанию можно с помощью действия "Получить учетную запись".

Внимание: на данный момент поддерживается только значение "America/Los_Angeles".

Измерение

Размеры отчета по сети. Размеры — это атрибуты данных, позволяющие детализировать или уточнять количественные измерения (метрики) по определенным параметрам, таким как формат объявления или платформа, на которой было просмотрено объявление.

Перечисления
DIMENSION_UNSPECIFIED Значение по умолчанию для незаданного поля. Не использовать.
DATE Дата в формате ГГГГММДД (например, "20210701"). В запросе можно указать не более одного временного параметра.
MONTH Месяц в формате ГГГГММ (например, "202107"). В запросе можно указать не более одного временного параметра.
WEEK Дата первого дня недели в формате ГГГГММДД (например, "20210701"). В запросе можно указать не более одного временного параметра.
AD_UNIT Уникальный идентификатор рекламного блока (например, "ca-app-pub-1234/1234"). Если указан параметр AD_UNIT, то APP включается автоматически.
APP Уникальный идентификатор мобильного приложения (например, "ca-app-pub-1234~1234").
AD_TYPE

Тип объявления (например, «текст» или «изображение»), параметр показа объявления.

Предупреждение: Данное измерение несовместимо с метриками AD_REQUESTS , MATCH_RATE и IMPRESSION_RPM .

COUNTRY Код страны CLDR, в которой происходит просмотр/клики по объявлению (например, «США» или «Франция»). Это географический параметр.
FORMAT Формат рекламного блока (например, «баннер», «нативная реклама»), параметр показа рекламы.
PLATFORM Мобильная ОС-платформа приложения (например, «Android» или «iOS»).
MOBILE_OS_VERSION Версия мобильной операционной системы, например, «iOS 13.5.1».
GMA_SDK_VERSION Версия GMA SDK, например, "iOS 7.62.0".
APP_VERSION_NAME Для Android название версии приложения можно найти в параметре versionName в PackageInfo. Для iOS название версии приложения можно найти в параметре CFBundleShortVersionString.
SERVING_RESTRICTION Режим ограничения показа рекламы (например, «Неперсонализированная реклама»).

Метрическая система

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

Перечисления
METRIC_UNSPECIFIED Значение по умолчанию для незаданного поля. Не использовать.
AD_REQUESTS

Количество запросов на показ рекламы. Значение — целое число.

Предупреждение: метрика несовместима с измерением AD_TYPE .

CLICKS Количество кликов пользователя по рекламному объявлению. Значение — целое число.
ESTIMATED_EARNINGS Предполагаемый доход издателя AdMob. Валюта (USD, EUR или другая) показателей дохода определяется настройками локализации для валюты. Сумма указывается в микросекундах. Например, 6,50 долларов США будут представлены как 6 500 000.
IMPRESSIONS Общее количество показов рекламы пользователям. Значение — целое число.
IMPRESSION_CTR Соотношение кликов к показам. Значение представляет собой десятичное число двойной точности (приблизительное).
IMPRESSION_RPM

Расчетный доход за тысячу показов рекламы. Значение указано в микросекундах. Например, 1,03 доллара США будет представлено как 1030000. Эквивалентно eCPM в пользовательском интерфейсе AdMob.

Предупреждение: метрика несовместима с измерением AD_TYPE .

MATCHED_REQUESTS Количество показов рекламы в ответ на запрос. Значение — целое число.
MATCH_RATE

Отношение количества соответствующих рекламных запросов к общему количеству рекламных запросов. Значение представляет собой десятичное число двойной точности (приблизительное).

Предупреждение: метрика несовместима с измерением AD_TYPE .

SHOW_RATE Соотношение количества показанных объявлений к количеству возвращенных объявлений, определяемое как количество показов / количество соответствующих запросов. Значение представляет собой десятичное число двойной точности (приблизительное).

DimensionFilter

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

JSON-представление 
{
  "dimension": enum (Dimension),

  // Union field operator can be only one of the following:
  "matchesAny": {
    object (StringList)
  }
  // End of list of possible types for union field operator.
}
Поля
dimension

enum ( Dimension )

Применяет критерий фильтрации к указанному параметру.

operator объединения полей. Применяемый оператор фильтра. operator может принимать только одно из следующих значений:
matchesAny

object ( StringList )

Соответствует строке, если значение по указанному параметру совпадает с одним из значений, указанных в этом условии.

SortCondition

Направление сортировки, применяемое к измерению или метрике.

JSON-представление 
{
  "order": enum (SortOrder),

  // Union field sort_on can be only one of the following:
  "dimension": enum (Dimension),
  "metric": enum (Metric)
  // End of list of possible types for union field sort_on.
}
Поля
order

enum ( SortOrder )

Порядок сортировки по размерности или метрике.

Поле объединения sort_on определяет, по каким значениям следует производить сортировку. sort_on может принимать только одно из следующих значений:
dimension

enum ( Dimension )

Сортировка по указанному параметру.

metric

enum ( Metric )

Отсортировать по указанному показателю.