Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

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

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

Видео: Аутентификация

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

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

Google Ads API использует учетные данные приложения для идентификации и авторизации запросов API. Можно настроить как клиентов OAuth 2.0, так и учетные записи служб . Дополнительные сведения о настройке авторизации на стороне клиента см. в разделе OAuth2 в Google Ads API .

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

Использование потоков рабочего стола или веб-приложений

Следуйте инструкциям по настройке проекта Google API Console для Google Ads API . Запишите идентификатор клиента и секрет клиента , а затем вернитесь на эту страницу.

Создав клиент OAuth, следуйте инструкциям потока рабочего стола приложения или веб-приложения, чтобы сгенерировать маркер обновления и маркер доступа .

Использование сервисных аккаунтов

Следуйте общим инструкциям в руководстве по учетным записям служб , чтобы настроить доступ к учетной записи службы для Google Ads API.

После того, как вы настроили учетную запись службы для доступа к своей учетной записи Google Ads, следуйте руководству по использованию OAuth 2.0 для межсерверных приложений , обязательно выбрав вкладку HTTP/REST . scope использования для доступа к Google Ads API: https://www.googleapis.com/auth/adwords .

Создание новых токенов доступа

Когда у вас есть идентификатор клиента, секрет клиента и токен обновления , вы можете сгенерировать новый токен доступа для использования в вызовах 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 к Google Ads API:

GET /v11/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

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

Токен разработчика

Google Ads API также требует токена разработчика для вызовов API. Вы можете подать заявку на токен для своего управляющего аккаунта прямо из пользовательского интерфейса Google Реклама. Дополнительные сведения о настройке токена разработчика см. в статье Получение токена разработчика .

Вам необходимо включать значение токена developer-token при каждом вызове API Google Ads API:

GET /v11/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

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

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

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

GET /v11/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

Идентификатор связанного клиента

Этот заголовок используется только сторонними поставщиками аналитики приложений при загрузке данных о конверсиях в связанный аккаунт Google Реклама . Дополнительные сведения см. в руководстве по структуре вызовов API .

...
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
linked-customer-id: LINKED_CUSTOMER_ID

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

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

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

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

request-id: 2a5Cj89VV7CNhya1DZjjrC