Method: accounts.reports.search

Получает отчет, определенный поисковым запросом. Ответ может содержать меньше строк, чем указано в pageSize . Положитесь на nextPageToken , чтобы определить, нужно ли запрашивать еще строки.

HTTP-запрос

POST https://merchantapi.googleapis.com/reports/v1beta/{parent=accounts/*}/reports:search

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

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

Параметры
parent

string

Необходимый. Идентификатор аккаунта, с которого осуществляется звонок. Должен быть отдельным аккаунтом или субаккаунтом MCA. Формат: аккаунты/{аккаунт}

Тело запроса

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

JSON-представление 
{
  "query": string,
  "pageSize": integer,
  "pageToken": string
}
Поля
query

string

Необходимый. Запрос, определяющий извлекаемый отчет.

Подробную информацию о том, как составить запрос, см. в руководстве по языку запросов. Полный список доступных таблиц и полей см. в разделе Доступные поля.

page Size

integer

Необязательный. Количество ReportRows , которые нужно получить на одной странице. По умолчанию — 1000. Значения выше 5000 приводятся к 5000.

page Token

string

Необязательный. Токен страницы, которую нужно получить. Если не указано, возвращается первая страница результатов. Чтобы запросить следующую страницу результатов, следует использовать значение, полученное из nextPageToken в предыдущем ответе.

Тело ответа

Ответное сообщение для метода ReportService.Search .

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

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

object ( ReportRow )

Строки, соответствующие поисковому запросу.

next Page Token

string

Токен, который можно отправить как pageToken для получения следующей страницы. Если этот параметр опущен, последующие страницы отсутствуют.

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

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/content

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