Accounts.reports: generate

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

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

Запрос

HTTP-запрос

GET https://www.googleapis.com/adsense/v1.4/accounts/accountId/reports

Параметры

Имя параметра Значение Описание
Параметры пути
accountId string Аккаунт, для которого нужно создать отчет.
Обязательные параметры запроса
endDate string Дата окончания отчетного периода в формате ГГГГ-ММ-ДД включительно.
startDate string Дата начала отчетного периода в формате ГГГГ-ММ-ДД включительно.
Необязательные параметры запроса
currency string Валюта (если показатели отчета имеют денежное выражение). По умолчанию используется валюта аккаунта.
dimension string Параметры, на основе которых формируется отчет. Доступные варианты описаны в этой статье. Подробную информацию по каждому параметру можно найти в глоссарии AdSense.
filter string Фильтры, применяемые к отчету.
locale string Язык, на котором должен быть представлен отчет. Если не указано другое, по умолчанию используется en_US.
maxResults integer Максимальное количество возвращаемых строк данных отчета. Если параметр startIndex не задан или равен нулю, API возвращает столько строк, сколько указано в параметре maxResults. Если параметр maxResults не указан, API возвращает максимальное количество строк, но не более 50 000.

Если параметру startIndex присвоено ненулевое значение, сумма startIndex и maxResults не должна превышать 5000. В противном случае возникнет ошибка, поскольку разбивка на страницы поддерживается не более чем для 5000 строк.
Возможные значения: от 0 до 50000 включительно.
metric string Столбцы числовых значений, включаемые в отчет. Доступные варианты описаны в этой статье. Подробную информацию по каждому показателю можно найти в глоссарии AdSense.
sort string Название параметра или показателя, по которому сортируется отчет. Может содержать префикс "+" или "-" для упорядочивания по возрастанию/убыванию. Если префикс не указан, данные сортируются по возрастанию.
startIndex integer Индекс первой строки возвращаемых данных отчета. Если параметр startIndex не задан или равен нулю, API возвращает столько строк, сколько указано в параметре maxResults. Если параметр maxResults не указан, API возвращает максимальное количество строк, но не более 50 000.

Если параметру startIndex присвоено ненулевое значение, сумма startIndex и maxResults не должна превышать 5000. В противном случае возникнет ошибка, поскольку разбивка на страницы поддерживается не более чем для 5000 строк.  Возможные значения: от 0 до 5000 включительно.
useTimezoneReporting boolean Показывает, нужно ли создавать отчет в часовом поясе, выбранном в аккаунте AdSense. По умолчанию (значение false) используется тихоокеанское стандартное время или тихоокеанское летнее время.

Авторизация

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

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

Тело запроса

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

Ответ

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

JSON

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

Возможные значения:
  • "DIMENSION":
  • "METRIC_CURRENCY":
  • "METRIC_RATIO":
  • "METRIC_TALLY":
headers[].currency string Валюта данного столбца (только для заголовков типа METRIC_CURRENCY).
rows[] list Строки выходных данных отчета. Каждая строка – это список ячеек для всех параметров и показателей в запросе. Ячейки параметров содержат строковые значения, а ячейки показателей – численные значения.
totals[] list Суммарные данные отчета. Длина строк равна длине остальных строк в отчете. Ячейки, которые соответствуют столбцам параметров, остаются пустыми.
averages[] list Средние значения отчета. Длина строк равна длине остальных строк в отчете. Ячейки, которые соответствуют столбцам параметров, остаются пустыми.
warnings[] list Предупреждения, связанные с процедурой создания отчета.
startDate string Запрашиваемая дата начала в формате гггг-мм-дд.
endDate string Запрашиваемая дата окончания в формате гггг-мм-дд.

CSV

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

Попробуйте!

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

Оставить отзыв о...

Текущей странице
AdSense Management API
AdSense Management API