Авторизация и заголовки HTTP

Для вызова API отчётности Search Ads 360 вам потребуются учётные данные приложения OAuth 2.0. Если вы выполняете вызовы API от имени управляющего аккаунта Search Ads 360, вам также необходимо указывать заголовок login-customer-id в каждом запросе. На этой странице описывается, как задать эти значения, а также документируются несколько дополнительных HTTP-заголовков, специфичных для API, которые отправляются и принимаются при использовании интерфейса REST.

Учетные данные OAuth 2.0

API отчётности Search Ads 360 использует учётные данные приложения для идентификации и авторизации запросов API. Можно настроить клиентов OAuth 2.0. Все вызовы API отчётности Search Ads 360 должны быть авторизованы через OAuth2. OAuth2 позволяет вашему клиентскому приложению API отчётности Search Ads 360 получать доступ к учётной записи пользователя Search Ads 360 без необходимости обработки или хранения его регистрационных данных.

Если вы новичок в API Google, вы можете использовать oauth2l или OAuth 2.0 Playground для экспериментов с учётными данными приложения и API отчётности Search Ads 360 перед написанием кода для своего приложения. Вы также можете сгенерировать токен обновления OAuth, запустив предоставленный скрипт генерации учётных данных пользователя .

Генерация новых токенов доступа

Получив идентификатор клиента , секрет клиента и токен обновления , вы можете сгенерировать новый токен доступа для использования в вызовах API с помощью инструмента командной строки curl :

curl \
  --data "grant_type=refresh_token" \
  --data "client_id=CLIENT_ID" \
  --data "client_secret=CLIENT_SECRET" \
  --data "refresh_token=REFRESH_TOKEN" \
  https://www.googleapis.com/oauth2/v3/token

Затем вы используете токен доступа, возвращаемый запросом curl, в заголовке HTTP Authorization каждого вызова API к API отчетов Search Ads 360:

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN

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

Идентификатор клиента для входа

Для вызовов API отчётности Search Ads 360, совершаемых менеджером к клиентскому аккаунту (то есть при входе в систему как менеджер для выполнения вызовов API к одному из своих клиентских аккаунтов), необходимо также предоставить HTTP-заголовок login-customer-id . Это значение представляет собой идентификатор клиента Search Ads 360, к которому относится менеджер, выполняющий вызов API.

Добавление этого заголовка эквивалентно выбору аккаунта в интерфейсе Search Ads 360 после входа в систему или нажатия на изображение профиля в правом верхнем углу страницы. При указании идентификатора клиента обязательно удалите все дефисы (—), например: 1234567890 , а не 123-456-7890 .

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

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

В HTTP-ответах от API возвращаются следующие заголовки.

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

Идентификатор request-id — это строка, которая однозначно идентифицирует запрос API. При отладке или устранении неполадок с определёнными вызовами API идентификатор request-id — важный идентификатор, который необходимо иметь под рукой при обращении в службу поддержки разработчиков Google.

request-id: 2a5Cj89VV7CNhya1DZjjrC