Структура вызова API отчетов Search Ads 360

Вызовы API отчетов Search Ads 360 обычно выполняются через вашу клиентскую библиотеку . Дополнительные сведения см. в разделе «Описание клиентских библиотек» . Однако знание структуры базовых деталей запроса может быть полезно при тестировании и отладке.

Search Ads 360 Reporting API – это API gRPC с привязками REST. Это означает, что вы можете вызывать API двумя альтернативными способами:

Предпочтительный метод
Используйте клиентскую библиотеку :
  • Создайте тело запроса как буфер протокола .
  • Отправьте запрос на сервер, используя HTTP/2 .
  • Десериализовать ответ в буфер протокола.
  • Интерпретируйте результаты.
Дополнительный альтернативный метод
Используйте ОТДЫХ :
  • Создайте тело запроса как объект JSON .
  • Отправьте запрос на сервер, используя HTTP 1.1.
  • Десериализуйте ответ как объект JSON.
  • Интерпретируйте результаты.

Дополнительную информацию см. в разделе Google Cloud API .

Следующие разделы относятся как к протоколам gRPC, так и к REST.

Имена ресурсов

Большинство объектов в API идентифицируются по строкам имен ресурсов. Эти строки также служат URL-адресами при использовании интерфейса REST.

См . «Справочник» > «REST» для получения дополнительной информации о поддерживаемых ресурсах и представлении их путей. Тот же формат используется для других сервисов.

Составные идентификаторы

Если идентификатор объекта не является глобально уникальным , составной идентификатор для этого объекта создается путем добавления его родительского идентификатора и тильды (~).

Например, поскольку идентификатор объявления группы объявлений не является глобально уникальным, к нему добавляется идентификатор родительского объекта (группы объявлений), в результате чего получается уникальный составной идентификатор.

Пример: AdGroupId 123 + ~ + AdGroupAdId 45678 = идентификатор объявления составной группы объявлений 123~45678 .

Заголовки запросов

Заголовки HTTP (или метаданные gRPC ) в следующих разделах должны быть включены в текст запроса.

Авторизация

Вам необходимо включить токен доступа OAuth2 в форме:

Authorization: Bearer [OAUTH_2.0_ACCESS_TOKEN]

Токен должен идентифицировать либо управляющий аккаунт, действующий от имени клиента, либо рекламодателя, непосредственно управляющего своим подчиненным управляющим или клиентским аккаунтом. Дополнительную информацию см . в разделе Об управляющих аккаунтах Search Ads 360 и аутентификации .

Заголовок идентификатора клиента для входа в систему

Заголовок login-customer-id необходим при использовании управляющего аккаунта для доступа к подчиненному управляющему или клиентскому аккаунту. Это не требуется при прямом доступе к аккаунту субменеджера или клиента. Хотя это и не является строго необходимым, мы рекомендуем всегда указывать login-customer-id для прошедших проверку пользователей, которые имеют доступ к более чем одной учетной записи. Это позволяет избежать двусмысленности и предотвращает непреднамеренную настройку контекста для неправильной учетной записи.

В запросе должен быть указан идентификатор авторизованного пользователя без дефисов ( - ), например:

https://searchads360.googleapis.com/VERSION_NUMBER/customers/CUSTOMER_ID/campaignBudgets

Установка login-customer-id эквивалентна выбору учетной записи в пользовательском интерфейсе Search Ads 360 после входа в систему или нажатия на изображение вашего профиля в правом верхнем углу.

Заголовки ответов

Следующие заголовки (или конечные метаданные gRPC ) возвращаются вместе с телом ответа. Мы рекомендуем записать эти значения в журнал в целях отладки.

Идентификатор запроса

Заголовок request-id — это строка, которая однозначно идентифицирует запрос.