Authentication

Все вызовы Google Ad Manager API должны быть авторизованы с помощью OAuth2 – открытого стандарта, который позволяет пользователям предоставлять разрешения сторонним приложениям, чтобы они могли взаимодействовать с веб-сервисами от имени пользователя. OAuth2 позволяет клиентскому приложению Ad Manager API получать доступ к аккаунту Менеджера рекламы без необходимости обрабатывать или хранить имя пользователя и пароль.

Создание учетных данных OAuth2

Чтобы создать учетные данные OAuth2, выполните следующие действия:

1. Определите тип аутентификации

В таблице ниже указано, какой тип аутентификации лучше всего подходит для вашего приложения Ad Manager API.

Выберите тип аутентификации OAuth2
Сервисный аккаунт

Выберите этот вариант, если вам нужен доступ только к собственным данным Менеджера рекламы.

Подробнее…
Веб-приложение

Выберите этот вариант, если вы хотите выполнять аутентификацию от имени любого пользователя, который предоставит вашему приложению разрешение на доступ к своим данным Менеджера рекламы.

Подробнее…

2. Создайте учетные данные OAuth2

Определив тип аутентификации, перейдите на соответствующую вкладку ниже и следуйте инструкциям по созданию учетных данных OAuth2.

Сервисный аккаунт
  1. Откройте страницу учетных данных Google API Console.
  2. В раскрывающемся списке проектов выберите Create a new project (Создать проект), введите название проекта и при необходимости измените идентификатор проекта. Нажмите Создать.
  3. На странице Credentials (Учетные данные) выберите Create credentials (Создать учетные данные), а затем – Service account key (Ключ сервисного аккаунта).
  4. Выберите Новый сервисный аккаунт и нажмите JSON.
  5. Нажмите Создать, чтобы скачать файл с закрытым ключом.
Веб-приложение
  1. Откройте страницу учетных данных Google API Console.
  2. В раскрывающемся списке проектов выберите Создать проект, введите название проекта (при необходимости измените идентификатор проекта) и нажмите Создать.
  3. На странице "Учетные данные" нажмите Создать учетные данные и выберите Идентификатор клиента OAuth.
  4. Если вам будет предложено указать название продукта на странице Consent Screen (Окно запроса доступа), нажмите Configure consent screen (Настроить окно запроса доступа), укажите нужную информацию и нажмите Save (Сохранить), чтобы вернуться на страницу Credentials (Учетные данные).
  5. В разделе Тип приложения выберите Веб-приложение. Следуйте инструкциям, чтобы указать источники JavaScript, URI перенаправления или и то, и другое.
  6. Нажмите Создать.
  7. На открывшейся странице скопируйте идентификатор клиента и секретный код клиента в буфер обмена. Они понадобятся вам при настройке клиентской библиотеки.
Скриншот с идентификатором и секретным кодом клиента

3. Как настроить сеть Менеджера рекламы

Если вы сторонний разработчик, попросите клиента выполнить этот шаг.

Сервисный аккаунт
  1. Перейдите в сеть Менеджера рекламы.
  2. Перейдите на вкладку Администратор.
  3. Убедитесь, что доступ к API включен.
  4. Нажмите кнопку Добавить пользователя аккаунта сервиса.
  5. Заполните форму, указав адрес электронной почты сервисного аккаунта. Пользователю сервисного аккаунта необходимо предоставить разрешения на доступ к объектам, как если бы он получал доступ к ним через интерфейс.
  6. Нажмите кнопку Сохранить. Должно появиться сообщение, подтверждающее добавление сервисного аккаунта.
  7. Чтобы посмотреть список существующих пользователей сервисного аккаунта, перейдите на вкладку "Пользователи" и нажмите на фильтр Сервисный аккаунт.
Веб-приложение
  1. Перейдите в сеть Менеджера рекламы.
  2. Перейдите на вкладку Администратор.
  3. Убедитесь, что доступ к API включен.

4. Настройка клиентской библиотеки

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

Если вы не хотите использовать наши клиентские библиотеки, вам нужно будет самостоятельно реализовать процесс OAuth2 для сервисного аккаунта или веб-приложения.

Кадры со съемок

Наши клиентские библиотеки автоматически выполняют все описанные ниже действия, поэтому вы можете пропустить этот раздел, если вас не интересуют технические подробности. Этот раздел предназначен для опытных пользователей, которые уже знакомы со спецификацией OAuth2 и знают, как использовать OAuth2 с API Google.

Заголовок HTTP-запроса

В HTTP-заголовок каждого запроса к Ad Manager API необходимо включать токен доступа в следующем формате:

Authorization: Bearer ACCESS_TOKEN

Пример:

POST … HTTP/1.1
Host: …
Authorization: Bearer 1/fFAGRNJru1FTz70BzhT3Zg
Content-Type: text/xml;charset=UTF-8
Content-Length: …

<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope">
…
</soap:Envelope>

Область действия

Один токен доступа может предоставлять разные уровни доступа к нескольким API. Переменный параметр scope определяет набор ресурсов и операций, которые разрешены токеном доступа. При запросе токена доступа приложение отправляет одно или несколько значений в параметре scope.

В Менеджере рекламы есть только одна область действия, которая показана ниже. Авторизация должна выполняться на уровне пользователя в продукте.

Область действия Разрешения
https://www.googleapis.com/auth/admanager Просмотр кампаний в Менеджере рекламы и управление ими.