Настройте доступ к API

Вот как настроить доступ к API Data Manager с помощью SDK или REST.

Предварительные требования

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

  1. Проект Google Cloud . Вы можете использовать существующий проект или создать новый проект специально для API Data Manager.

  2. Для доступа к вашему проекту Google Cloud требуется учетная запись Google, имеющая разрешение serviceusage.services.enable , или роль, включающая это разрешение. Например, roles/owner и roles/serviceusage.serviceUsageAdmin содержат разрешение serviceusage.services.enable . Чтобы проверить свои разрешения, см. раздел «Просмотр текущего доступа» .

  3. Установлен Google Cloud CLI.

Включить API

Если вы еще этого не сделали, включите API диспетчера данных, нажав кнопку «Включить API диспетчера данных» , или следуйте инструкциям , чтобы выполнить этот шаг вручную.

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

Если вы не можете найти API Data Manager или включение API Data Manager не удается, убедитесь, что ваша учетная запись Google соответствует необходимым требованиям .

Настройка аутентификации

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

Два распространенных метода аутентификации — это учетные записи пользователей и служебные учетные записи :

  • Учетные записи пользователей : представляют людей, которые напрямую взаимодействуют с API и сервисами Google.
  • Служебные учетные записи : представляют приложения, а не людей, в качестве пользователей. Они позволяют вашим приложениям управлять аутентификацией и авторизацией. Например, если приложению необходимо получить доступ к ресурсам Google Cloud.

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

Для настройки ADC выберите учетную запись пользователя или учетную запись службы :

Учетная запись пользователя

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

  1. Настройте параметры платформы аутентификации Google для вашего проекта.

    1. Откройте страницу «Брендинг» в консоли Google Cloud.

    2. Выберите свой проект.

    3. Заполните форму и нажмите «Создать» .

  2. Поскольку область действия API Data Manager является конфиденциальной , необходимо выполнить следующие шаги:

    1. Перейдите в настройки доступа к данным для вашего проекта.

    2. Нажмите «Добавить или удалить области действия» .

    3. Установите флажок рядом с пунктом «API менеджера данных» в списке областей действия и нажмите «Обновить» .

    4. Нажмите « Сохранить ».

    5. Перейдите в раздел «Аудитория» в консоли Google Cloud и обновите статус публикации и тип пользователя . Подробнее об этих настройках см. в разделе «Управление аудиторией приложений» .

  3. Нажмите «Создать клиент OAuth2» , чтобы создать клиент OAuth2 в проекте, или следуйте инструкциям для создания настольного клиента OAuth2. Вы можете пропустить этот шаг, если у вас уже есть настольный клиент OAuth2, который вы хотите использовать для API Data Manager.

    Если вы нажмете «Создать клиент OAuth2» , при появлении запроса выберите « Настроить настольное приложение» , чтобы использовать клиент на следующих шагах.

    Создание клиента OAuth2

    На последнем шаге нажмите кнопку СКАЧАТЬ КОНФИГУРАЦИЮ КЛИЕНТА и запомните выбранное вами место для загрузки.

  4. Создайте локальный файл ADC, выполнив следующую команду. Эта команда запускает веб-процесс, в котором вам будет предложено войти в учетную запись Google, которую вы используете с API.

    Замените PATH_TO_CLIENT_JSON на имя загруженного вами JSON-файла.

    gcloud auth application-default login \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/cloud-platform" \
  --client-id-file="PATH_TO_CLIENT_JSON"

    Если вы хотите использовать одни и те же учетные данные для API Data Manager и API Google Ads , добавьте область действия API Google Ads в список --scopes :

    gcloud auth application-default login \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/adwords,https://www.googleapis.com/auth/cloud-platform" \
  --client-id-file="PATH_TO_CLIENT_JSON"

    Если вы хотите использовать одни и те же учетные данные для API Data Manager и API Display & Video 360 , добавьте область действия API Display & Video 360 в список --scopes :

    gcloud auth application-default login \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/display-video,https://www.googleapis.com/auth/cloud-platform" \
  --client-id-file="PATH_TO_CLIENT_JSON"

  5. Подтвердите правильность настройки учетных данных с помощью следующей команды. В случае успеха команда выведет токен доступа в консоль. 

    gcloud auth application-default print-access-token

Служебный аккаунт

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

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

    Создать учетную запись службы

  2. Предоставьте учетной записи службы роль IAM «Потребитель использования службы » ( roles/serviceusage.serviceUsageConsumer ), которая включает разрешение serviceusage.services.use , позволяющее учетной записи службы отправлять API-запросы для проекта.

    gcloud projects add-iam-policy-binding PROJECT_ID \
  --member="serviceAccount:SERVICE_ACCOUNT_EMAIL" \
  --role="roles/serviceusage.serviceUsageConsumer"

  3. Предоставьте своему аккаунту Google роль IAM « Создатель токена сервисного аккаунта » ( roles/iam.serviceAccountTokenCreator ) для сервисного аккаунта.

    gcloud iam service-accounts add-iam-policy-binding SERVICE_ACCOUNT_EMAIL \
  --member="user:USER_EMAIL" \
  --role="roles/iam.serviceAccountTokenCreator"

  4. Настройте свой АЦП, выполнив следующую команду:

    gcloud auth application-default login \
  --impersonate-service-account=SERVICE_ACCOUNT_EMAIL \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/cloud-platform"

    Если вы хотите использовать одни и те же учетные данные для API Data Manager и API Google Ads , добавьте область действия API Google Ads в список --scopes :

    gcloud auth application-default login \
  --impersonate-service-account=SERVICE_ACCOUNT_EMAIL \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/adwords,https://www.googleapis.com/auth/cloud-platform"

    Если вы хотите использовать одни и те же учетные данные для API Data Manager и API Display & Video 360 , добавьте область действия API Display & Video 360 в список --scopes :

    gcloud auth application-default login \
  --impersonate-service-account=SERVICE_ACCOUNT_EMAIL \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/display-video,https://www.googleapis.com/auth/cloud-platform"

    При появлении запроса на вход войдите в систему под учетной записью Google, имеющей роль «Создатель токенов сервисных учетных записей».

  5. Подтвердите правильность настройки учетных данных с помощью следующей команды. В случае успеха команда выведет токен доступа в консоль. 

    gcloud auth application-default print-access-token --scopes="https://www.googleapis.com/auth/datamanager"

Чтобы узнать больше об аутентификации и учетных данных для вашего приложения, см. разделы «Методы аутентификации в Google» и «Как работают учетные данные приложения по умолчанию» .

Настройка доступа к учетной записи

Учетная запись пользователя

Предоставьте доступ к целевому ресурсу по Destination электронной почты, связанному с пользователем.

  • Если вы используете аккаунт Google Ads, следуйте инструкциям , чтобы добавить адрес электронной почты пользователя в аккаунт Google Ads или в родительский аккаунт Google Ads Manager.
  • Если вы используете учетную запись Display & Video 360, следуйте инструкциям , чтобы добавить адрес электронной почты пользователя в эту учетную запись.
  • Если вы используете сервис Google Analytics, следуйте инструкциям , чтобы добавить адрес электронной почты пользователя в учетную запись.
  • Если доступ к Destination осуществляется через учетную запись партнера по данным с партнерской ссылкой из учетной записи рекламодателя, следуйте инструкциям , чтобы добавить адрес электронной почты пользователя в учетную запись партнера по данным.

Служебный аккаунт

Предоставьте доступ к Destination электронной почты, связанному с вашей учетной записью службы.

  • Если вы используете аккаунт Google Ads, выполните настройку доступа к аккаунту , чтобы добавить сервисный аккаунт к аккаунту Google Ads или к родительскому аккаунту Google Ads Manager.
  • Если вы используете учетную запись Display & Video 360, следуйте инструкциям по созданию пользователя Display & Video 360, связанного с учетной записью службы.
  • Если вы используете сервис Google Analytics, следуйте инструкциям , чтобы добавить адрес электронной почты пользователя в учетную запись.
  • Если доступ к Destination осуществляется с использованием учетной записи партнера по данным, связанной с партнерской ссылкой из учетной записи рекламодателя, выполните настройку доступа к учетной записи в учетной записи партнера по данным, чтобы добавить учетную запись службы и установить для нее уровень доступа.

Следующие шаги

Установите клиентскую библиотеку и запустите примеры кода, чтобы выполнить свой первый запрос к API Data Manager.

Далее
Установить клиентскую библиотеку