Authentication

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

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

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

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

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

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

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

  1. Включите API Менеджера рекламы в своем облачном проекте консоли Google API.

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

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

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

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

В облаке Google

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

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

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

Локально или у другого облачного провайдера

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

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

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

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

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

  4. Откройте вкладку «Ключи» .

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

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

  7. Задайте для переменной среды GOOGLE_APPLICATION_CREDENTIALS путь к файлу JSON.

Линукс или МакОС 

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Окна 

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

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

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

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

  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 Менеджера рекламы:

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

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

Линукс или МакОС 

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Окна 

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Настройте свою сеть Менеджера рекламы

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

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

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

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

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

  1. Перейдите в свою сеть Менеджера рекламы .
  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

Объем

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

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