Method: accounts.campaignReport.generate

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

HTTP-запрос

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

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

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

Параметры
parent

string

Имя ресурса учетной записи, для которой нужно сгенерировать отчет. Пример: accounts/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 Overview .

CampaignReportSpec

Спецификация для создания отчета по кампании. Например, спецификация для получения данных о показах и кликах с разбивкой по 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 Количество взаимодействий пользователя с рекламой. Сюда входят клики и взаимодействия.