Как начать работу с Ads Data Hub API

В этом руководстве объясняется, как приступить к написанию приложений, использующих REST API Ads Data Hub для взаимодействия с Ads Data Hub. REST API Ads Data Hub позволяет вам просматривать клиентов Ads Data Hub, связанных с вашей учетной записью Google, создавать и выполнять запросы.

Настраивать

Прежде чем использовать API Ads Data Hub, необходимо выполнить несколько шагов:

  1. Убедитесь, что пользователю, включающему API, предоставлено разрешение serviceusage.services.enable в проекте Google Cloud. Пользователь с разрешением serviceusage.services.enable также должен быть внесен в белый список для доступа к API.
  2. Включите API Ads Data Hub в проекте Google Cloud, в котором были созданы учетные данные клиента или сервисный аккаунт . Чтобы включить API Ads Data Hub для проекта с помощью консоли:
    1. Перейдите в библиотеку API Cloud Console .
    2. Выберите проект, который вы хотите использовать, из списка проектов.
    3. Найдите «API Ads Data Hub».
    4. На странице API нажмите ВКЛЮЧИТЬ .
  3. Управление разрешениями:
    1. Адрес электронной почты или учетная запись службы, использованная для создания учетных данных, должна быть добавлена ​​в Ads Data Hub с соответствующими разрешениями . Для учетной записи службы это адрес электронной почты учетной записи службы. Для OAuth это адрес электронной почты пользователя. Это гарантирует, что у сервисного аккаунта или аккаунта конечного пользователя есть разрешение на выполнение запросов в Ads Data Hub.
  4. (Рекомендуется) Установите клиентскую библиотеку Google API :
    1. Клиентские библиотеки Google API доступны на нескольких популярных языках и позволяют работать со многими API Google. Хотя это и не обязательно, клиентские библиотеки уменьшают объем кода, который вам придется написать, и упрощают настройку аутентификации.
Клиентская библиотека Примеры Ads Data Hub
Клиентская библиотека Google API для Java Ява
Клиентская библиотека Google API для Python

Аутентификация и авторизация

API Ads Data Hub может получать доступ к данным в вашей учетной записи клиента Ads Data Hub и изменять их, поэтому ему необходимо подтвердить, что вы являетесь авторизованным пользователем. По этой причине, прежде чем вы начнете взаимодействовать с API Ads Data Hub, вам необходимо пройти процедуру авторизации. Поток авторизации предоставляет вам необходимые разрешения для взаимодействия с API. Вы можете пройти аутентификацию с помощью OAuth 2.0 или учетной записи службы.

Настройка учетной записи службы

  1. Перейдите в консоль Google API и перейдите к своему проекту администратора.
  2. Убедитесь, что API Ads Data Hub включен для вашего проекта в разделе API и услуги .
    1. Если это не так, нажмите + Включить API и службы и включите API Ads Data Hub.
  3. В левом навигационном меню нажмите IAM и администрирование > Учетные записи служб .
    1. Если вы еще не создали учетную запись службы, создайте ее .
  4. Нажмите трехточечное меню ( ) в разделе «Действия», затем нажмите « Управление ключами» .
    1. Нажмите «Добавить ключ» > «Создать новый ключ».
    2. Убедившись, что выбран «JSON», нажмите « Создать» .
  5. Добавьте адрес электронной почты сервисного аккаунта в качестве пользователя в свой аккаунт Ads Data Hub.

Отправить образец запроса 

#!/usr/bin/env python3

"""This sample shows how to retrieve all accounts associated with the user.
"""
import json
from google.oauth2.service_account import Credentials
from googleapiclient.discovery import build

SCOPES = ['https://www.googleapis.com/auth/adsdatahub']
DISCOVERY_URL = 'https://adsdatahub.googleapis.com/$discovery/rest?version=v1'
creds = Credentials.from_service_account_file(
    'service-account.json').with_scopes(SCOPES)
developer_key = 'YOUR_DEVELOPER_KEY'  # Replace with your developer key.
service = build('AdsDataHub', 'v1', credentials=creds,
                developerKey=developer_key, discoveryServiceUrl=DISCOVERY_URL)

# Replace with your ADH account ID.
adh_account_id = input('ADH account ID (e.g. "customers/123456789"): ').strip()
queries = service.customers().analysisQueries().list(
    parent=adh_account_id).execute()
print(json.dumps(queries, sort_keys=True, indent=4))

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

  • См. примеры запросов в Ads Data Hub, где приведены примеры запросов, которые можно создавать и выполнять с помощью REST API Ads Data Hub.
  • Разверните примеры, чтобы ознакомиться с API и настроить его для своего варианта использования. Затем попробуйте:
  • Если у вас есть вопросы или отзывы об API, обратитесь в службу поддержки ADH.
Назад
Настройка аккаунта
Далее
Как использовать веб-интерфейс