Authentication

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

Клиентские библиотеки Ad Manager используют учетные данные по умолчанию для приложения (Application Default Credentials) для генерации токенов доступа с областями действия API Ad Manager. В этом руководстве показано, как настроить учетные данные по умолчанию для приложения.

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

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

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

Тип аутентификации Описание
Сервисный аккаунт Выберите этот вариант, если хотите проходить аутентификацию как отдельная учетная запись, а не как учетная запись конкретного человека.
Узнать больше .
Веб-приложение Выберите этот вариант, если хотите проходить аутентификацию как любой пользователь, предоставивший вашему приложению разрешение на доступ к своим данным в Ad Manager.
Узнать больше
Местное развитие Выберите этот вариант, если хотите пройти аутентификацию под своей учетной записью Google или под учетной записью службы из локальной среды разработки.

Включите API менеджера рекламы.

  1. Включите API Ad Manager в своем проекте Google API Console Cloud.

  2. При появлении запроса выберите проект или создайте новый.

Создать учетные данные

Щелкните вкладку, соответствующую вашему типу аутентификации, и следуйте инструкциям для создания учетных данных:

Сервисный аккаунт

В облаке Google

Для аутентификации рабочей нагрузки, работающей в Google Cloud, используются учетные данные сервисной учетной записи, привязанной к вычислительному ресурсу, на котором выполняется ваш код.

Например, вы можете привязать учетную запись службы к экземпляру виртуальной машины Compute Engine, службе Cloud Run или заданию Dataflow. Этот подход является предпочтительным методом аутентификации для кода, работающего на вычислительных ресурсах Google Cloud.

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

В локальной сети или у другого облачного провайдера.

Предпочтительный метод настройки аутентификации вне Google Cloud — использование федерации идентификации рабочих нагрузок ; вы создаете файл конфигурации учетных данных и устанавливаете переменную среды GOOGLE_APPLICATION_CREDENTIALS , указывающую на него. Этот подход более безопасен, чем создание ключа учетной записи службы.

Если вам не удаётся настроить федерацию идентификации рабочих нагрузок, необходимо создать учетную запись службы и создать ключ для этой учетной записи:

  1. Откройте страницу «Учетные данные» в консоли Google API .

  2. На странице «Учетные данные» выберите «Создать учетные данные» , затем выберите «Учетная запись службы» .

  3. Щелкните по адресу электронной почты учетной записи службы, для которой вы хотите создать ключ.

  4. Нажмите вкладку « Клавиши» .

  5. Щелкните раскрывающееся меню «Добавить ключ» , затем выберите «Создать новый ключ» .

  6. Выберите JSON в качестве типа ключа и нажмите «Создать» .

  7. Установите переменную среды GOOGLE_APPLICATION_CREDENTIALS указав путь к JSON-файлу.

Linux или macOS 

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows 

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Веб-приложение

  1. Откройте страницу «Учетные данные» в консоли Google API .

  2. При появлении запроса выберите проект, в котором вы включили API Ad Manager.

  3. На странице «Учетные данные» выберите «Создать учетные данные» , затем выберите «Идентификатор клиента OAuth» .

  4. Выберите тип приложения: Веб-приложение .

  5. Заполните форму и нажмите «Создать» . Приложения, использующие языки и фреймворки, такие как PHP, Java, Python, Ruby и .NET, должны указывать авторизованные URI перенаправления . URI перенаправления — это конечные точки, на которые сервер OAuth 2.0 может отправлять ответы. Эти конечные точки должны соответствовать правилам проверки Google .

  6. После создания учетных данных загрузите файл client_secret.json . Надежно сохраните этот файл в месте, доступном только вашему приложению.

Далее выполните следующие шаги для получения токенов доступа OAuth 2.0.

Местное развитие

Настройте учетные данные приложения по умолчанию (ADC) в локальной среде.

Установите Google Cloud CLI, а затем инициализируйте его, выполнив следующую команду:

gcloud init

Создайте локальные учетные данные для аутентификации в вашей учетной записи Google и укажите идентификатор проекта, в котором включен API Ad Manager:

gcloud auth application-default login --scopes="https://www.googleapis.com/auth/admanager"
gcloud auth application-default set-quota-project PROJECT_ID

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

Linux или macOS 

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows 

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Настройте свою рекламную сеть в Ad Manager.

Сервисный аккаунт

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

Веб-приложение

  1. Перейдите в свою рекламную сеть в Ad Manager .
  2. Перейдите во вкладку «Администрирование» .
  3. Убедитесь, что доступ к API включен.

Местное развитие

  1. Перейдите в свою рекламную сеть в Ad Manager .
  2. Перейдите во вкладку «Администрирование» .
  3. Убедитесь, что доступ к API включен.

Без клиентской библиотеки

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

Подробные инструкции по получению токенов доступа см. в разделе «Использование OAuth2 с API Google» .

токены доступа

Включите свой токен доступа в запрос к API, указав либо параметр запроса access_token , либо значение Bearer в заголовке HTTP Authorization . По возможности предпочтительнее использовать заголовок HTTP, поскольку строки запроса обычно видны в логах сервера.

Например:

GET /v1/networks/1234
Host: admanager.googleapis.com
Authorization: Bearer ya29.a0Ad52N3_shYLX

GET https://admanager.googleapis.com/v1/networks/1234?access_token=1/fFAGRNJru1FTz70BzhT3Zg

Объем

Каждый токен доступа связан с одной или несколькими областями действия (scopes). Область действия определяет набор ресурсов и операций, разрешенных токеном доступа. API Ad Manager имеет две области действия. Мы рекомендуем использовать более узкую область действия admanager.readonly если вашему приложению не требуется записывать данные.

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