Method: accounts.campaignReport.generate

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

HTTP-запрос

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

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

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

Параметры
parent

string

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

Тело запроса

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

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

object ( CampaignReportSpec )

Спецификация отчета о кампании.

Тело ответа

Ответ API отчета о кампании.

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

JSON-представление 
{
  "rows": [
    {
      object (ReportRow)
    }
  ]
}
Поля
rows[]

object ( ReportRow )

Данные отчета о кампании от указанного издателя. Из API будет возвращено не более 100 000 строк.

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

Требуется одна из следующих областей OAuth:

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

Спецификация отчета кампании

Спецификация для создания отчета о кампании. Например, спецификация для получения ПОКАЗОВ и КЛИКОВ, разделенных по CAMPAIGN_ID, может выглядеть следующим образом: 

{
  "dateRange": {
    "startDate": {"year": 2021, "month": 12, "day": 1},
    "endDate": {"year": 2021, "month": 12, "day": 30}
  },
  "dimensions": ["CAMPAIGN_ID"],
  "metrics": ["IMPRESSIONS", "CLICKS"],
}
JSON-представление 
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "languageCode": string
}
Поля
dateRange

object ( DateRange )

Диапазон дат, за который создается отчет. Максимальный диапазон — 30 дней.

dimensions[]

enum ( Dimension )

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

metrics[]

enum ( Metric )

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

languageCode

string

Язык, используемый для любого локализованного текста, например некоторых применимых значений размеров. Языковой тег определен в IETF BCP47. По умолчанию используется значение «en-US», если оно не указано или недействительно.

Измерение

Размеры отчета о кампании.

Перечисления
DIMENSION_UNSPECIFIED Значение по умолчанию неопределенного измерения. Не используйте.
DATE Дата в формате ГГГГММДД (например, «20210701»).
CAMPAIGN_ID Уникальный идентификатор кампании, например «123456789», который соответствует идентификатору кампании из API списка кампаний.
CAMPAIGN_NAME Название кампании.
AD_ID Уникальный идентификатор объявления, например «123456789».
AD_NAME Название объявления, которое не может быть уникальным.
PLACEMENT_ID Уникальный идентификатор поставщика приложения, в котором размещается реклама. Например, com.goog.bar для Android и 123456789 для приложений iOS.
PLACEMENT_NAME Название приложения, в котором размещается реклама.
PLACEMENT_PLATFORM Платформа приложения, на которой размещается реклама.
COUNTRY Название целевой страны.
FORMAT Формат рекламного блока (например, «Баннер», «Нативный»), параметр показа рекламы.

Метрика

Метрики отчета о кампании.

Перечисления
METRIC_UNSPECIFIED Значение по умолчанию для неустановленного поля. Не используйте.
IMPRESSIONS Сколько раз реклама была показана пользователю.
CLICKS Сколько раз пользователь нажимает на объявление.
CLICK_THROUGH_RATE Количество кликов, которое получает объявление, разделенное на количество показов объявления.
INSTALLS Сколько раз приложения были загружены на устройства.
ESTIMATED_COST Ориентировочная стоимость показа объявления кампании вместо объявления, приносящего доход. Валюта — это валюта отчетности для кампаний.
AVERAGE_CPI Средняя стоимость установки. Это означает среднюю сумму, потраченную на приобретение нового пользователя. Валюта — это валюта отчетности для кампаний.
INTERACTIONS Сколько раз пользователь взаимодействует с рекламой. Это состоит из кликов и взаимодействий.