Reports: generate

Требуется авторизация

Создает отчет AdSense на основе параметров отправленного запроса. Возвращает ответ в виде объекта JSON; чтобы получить данные в формате CSV, необходимо указать параметр запроса alt=csv. Попробовать

Запрос

HTTP-запрос

GET https://www.googleapis.com/adsensehost/v4.1/reports

Параметры

Имя параметра Значение Описание
Обязательные параметры
endDate string Дата окончания отчетного периода в формате ГГГГ-ММ-ДД включительно.
startDate string Дата начала отчетного периода в формате ГГГГ-ММ-ДД включительно.
Необязательные параметры
dimension string

Параметры, на основе которых формируется отчет. Доступны следующие параметры:

  • DATE
  • WEEK
  • MONTH
  • AD_CLIENT_ID
  • HOSTED_AD_CLIENT_ID
  • PRODUCT_CODE
  • PRODUCT_NAME
  • CUSTOM_CHANNEL_ID
  • CUSTOM_CHANNEL_CODE
  • CUSTOM_CHANNEL_NAME
  • URL_CHANNEL_ID
  • URL_CHANNEL_NAME
  • AD_FORMAT_CODE
  • AD_FORMAT_NAME
  • BID_TYPE_CODE
  • BID_TYPE_NAME
  • TARGETING_TYPE_CODE
  • TARGETING_TYPE_NAME
filter string Фильтры, которые необходимо применить к отчету.
locale string Необязательный параметр, используемый для перевода данных отчета на местный язык. Если не указано другое, по умолчанию используется en_US.
maxResults unsigned integer

Максимальное количество строк данных отчета, которые должны быть возвращены.

Если параметр startIndex не задан или равен нулю, API возвращает столько строк, сколько указано в параметре maxResults. Если параметр maxResults не указан, API возвращает максимальное количество строк, но не более 50 000.

Если параметру startIndex присвоено ненулевое значение, сумма startIndex и maxResults не должна превышать 5000. В противном случае возникнет ошибка, поскольку разбивка на страницы поддерживается не более чем для 5000 строк.

Возможные значения: от 0 до 50000 включительно.
metric string Столбцы числовых значений, которые необходимо включить в отчет. Доступные показатели:
  • PAGE_VIEWS
  • PAGE_VIEWS_CTR
  • PAGE_VIEWS_RPM
  • AD_REQUESTS
  • AD_REQUESTS_COVERAGE
  • AD_REQUESTS_CTR
  • AD_REQUESTS_RPM
  • MATCHED_AD_REQUESTS
  • MATCHED_AD_REQUESTS_CTR
  • MATCHED_AD_REQUESTS_RPM
  • INDIVIDUAL_AD_IMPRESSIONS
  • INDIVIDUAL_AD_IMPRESSIONS_CTR
  • INDIVIDUAL_AD_IMPRESSIONS_RPM
  • CLICKS
  • EARNINGS
  • TOTAL_EARNINGS
  • COST_PER_CLICK
sort string

Имя параметра или показателя, по которому следует сортировать полученный отчет. Может содержать префикс "+" для сортировки по возрастанию или "-" для сортировки по убыванию. Если префикс не указан, выполняется упорядочивание по возрастанию.

Это комбинация показателей и параметров:

  • DATE
  • WEEK
  • MONTH
  • AD_CLIENT_ID
  • HOSTED_AD_CLIENT_ID
  • PRODUCT_CODE
  • PRODUCT_NAME
  • CUSTOM_CHANNEL_ID
  • CUSTOM_CHANNEL_CODE
  • CUSTOM_CHANNEL_NAME
  • URL_CHANNEL_ID
  • URL_CHANNEL_NAME
  • AD_FORMAT_CODE
  • AD_FORMAT_NAME
  • BID_TYPE_CODE
  • BID_TYPE_NAME
  • TARGETING_TYPE_CODE
  • TARGETING_TYPE_NAME
  • PAGE_VIEWS
  • PAGE_VIEWS_CTR
  • PAGE_VIEWS_RPM
  • AD_REQUESTS
  • AD_REQUESTS_COVERAGE
  • AD_REQUESTS_CTR
  • AD_REQUESTS_RPM
  • MATCHED_AD_REQUESTS
  • MATCHED_AD_REQUESTS_CTR
  • MATCHED_AD_REQUESTS_RPM
  • INDIVIDUAL_AD_IMPRESSIONS
  • INDIVIDUAL_AD_IMPRESSIONS_CTR
  • INDIVIDUAL_AD_IMPRESSIONS_RPM
  • CLICKS
  • EARNINGS
  • TOTAL_EARNINGS
  • COST_PER_CLICK
startIndex unsigned integer

Индекс первой строки данных отчета, которые должны быть возвращены.

Если параметр startIndex не задан или равен нулю, API возвращает столько строк, сколько указано в параметре maxResults. Если параметр maxResults не указан, API возвращает максимальное количество строк, но не более 50 000.

Если параметру startIndex присвоено ненулевое значение, сумма startIndex и maxResults не должна превышать 5000. В противном случае возникнет ошибка, поскольку разбивка на страницы поддерживается не более чем для 5000 строк.

Возможные значения: от 0 до 5000 включительно.

Авторизация

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

Диапазон
https://www.googleapis.com/auth/adsensehost

Тело запроса

При работе с данным методом тело запроса не используется.

Ответ

В случае успеха этот метод возвращает тело ответа со следующей структурой:

JSON

{
  "kind": "adsensehost#report",
  "totalMatchedRows": long,
  "headers": [
    {
      "name": string,
      "type": string,
      "currency": string
    }
  ],
  "rows": [
    [
      string
    ]
  ],
  "totals": [
    string
  ],
  "averages": [
    string
  ],
  "warnings": [
    string
  ]
}
Имя свойства Значение Описание Примечания
kind string Тип, в данном случае adsensehost#report.
totalMatchedRows long Общее количество строк, которые соответствуют запросу отчета. Строк может быть возвращено меньше из-за имеющихся в запросе ограничений по их длине или количеству.
headers[] list Информация о заголовках столбцов, запрошенная в отчете. Это список заголовков для всех параметров и показателей в запросе.
headers[].name string Название заголовка.
headers[].type string Тип заголовка (DIMENSION, METRIC_TALLY, METRIC_RATIO или METRIC_CURRENCY).
headers[].currency string Валюта данного столбца (только для заголовков типа METRIC_CURRENCY).
rows[] list Строки выходных данных отчета. Каждая строка – это список ячеек для всех параметров и показателей в запросе. Ячейки параметров содержат строковые значения, а ячейки показателей – численные значения.
totals[] list Суммарные данные отчета. Длина строк равна длине остальных строк в отчете. Ячейки, которые соответствуют столбцам параметров, остаются пустыми.
averages[] list Средние значения отчета. Длина строк равна длине остальных строк в отчете. Ячейки, которые соответствуют столбцам параметров, остаются пустыми.
warnings[] list Предупреждения, возникшие в процессе создания отчета.

CSV

"(dynamic)"
(foreach)
  (value)
(/foreach)
Имя свойства Значение Описание Примечания
(dynamic)"> (dynamic) (any)

Попробуйте!

Воспользуйтесь Обозревателем API, чтобы вызвать этот метод и посмотреть на результат.