このガイドでは、Ads Data Hub REST API を使用して Ads Data Hub を操作するためのアプリケーションを作成する方法について説明します。Ads Data Hub REST API を使用すると、ご利用の Google アカウントに関連付けられている Ads Data Hub ユーザーを表示したり、クエリを作成して実行したりできます。
設定
Ads Data Hub API を使用する前に、いくつかの手順を済ませておく必要があります。
- API を有効にするユーザーに、Google Cloud プロジェクトの
serviceusage.services.enable権限が付与されていることを確認します。また、serviceusage.services.enable権限を持つユーザーは、API にアクセスできる許可リストに登録されている必要もあります。 - クライアントの認証情報またはサービス アカウントが作成された Google Cloud プロジェクトで、Ads Data Hub API を有効化します。コンソールを使用して Ads Data Hub API をプロジェクトで有効にする手順は次のとおりです。
- Cloud Console API ライブラリに移動します。
- リストの中から使用するプロジェクトを選択します。
- 「Ads Data Hub API」を検索します。
- [API] ページで、[有効にする] をクリックします。
- 権限を管理する手順は次のとおりです。
- 認証情報の作成に使用するメールアドレスまたはサービス アカウントを、適切な権限を付与して Ads Data Hub に追加する必要があります。サービス アカウントの場合は、サービス アカウントのメールアドレスを追加します。OAuth の場合、ユーザーのメールアドレスを追加します。これにより、サービス アカウントやエンドユーザーのアカウントに、Ads Data Hub でクエリを実行する権限が付与されます。
- （推奨）Google API クライアント ライブラリをインストールします。
- Google API クライアント ライブラリは、さまざまな一般的な言語で利用できます。また、多くの Google API に対応しています。これは必須ではありませんが、クライアント ライブラリを使用すれば、記述する必要があるコードの数が減り、認証の設定が簡単になります。
| クライアント ライブラリ | Ads Data Hub のサンプル |
|---|---|
| Java の Google API クライアント ライブラリ | Java |
| Python の Google API クライアント ライブラリ |
認証と認可
Ads Data Hub API は、Ads Data Hub のユーザー アカウントにアクセスしてデータを変更できるため、お客様ご自身が認証済みユーザーであることを確認する必要があります。そのため、Ads Data Hub API を利用する前に、認証フローを済ませておく必要があります。認証フローを済ませることで、API を利用するために必要な権限が付与されます。認証は、OAuth 2.0 またはサービス アカウントを使用して行うことができます。
サービス アカウントのセットアップ
- Google API Console に移動して、管理者プロジェクトに移動します。
- [API とサービス] で、プロジェクトに対して Ads Data Hub API が有効になっていることを確認します。
- 有効になっていない場合は、[+ API とサービスの有効化] をクリックして、Ads Data Hub API を有効にします。
- 左側のナビゲーション メニューで、[IAM と管理] > [サービス アカウント] をクリックします。
- サービス アカウントをまだ作成していない場合は作成します。
- [操作] でその他メニュー（）をクリックし、[鍵を管理] をクリックします。
- [鍵を追加] > [新しい鍵を作成] をクリックします。
- [JSON] が選択されていることを確認したら、[作成] をクリックします。
- 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 customer ID.
customer_name = input('Customer name (e.g. "customers/123"): ').strip()
queries = service.customers().analysisQueries().list(
parent=customer_name).execute()
print(json.dumps(queries, sort_keys=True, indent=4))
次のステップ
- Ads Data Hub REST API で作成して実行できるクエリの例については、Ads Data Hub のサンプルクエリをご覧ください。
- サンプルを展開して、API の仕組みをよく理解し、ユースケースに合わせてカスタマイズしてください。その後、以下を行います。
- クエリの処理ステータスを調べます。
- BigQuery クライアント ライブラリを使用して、完了したクエリの結果を取得します。
- API に関する質問やフィードバックがある場合は、ADH サポートにお問い合わせください。