開始使用 Ads Data Hub API

本指南介紹如何著手編寫使用 Ads Data Hub REST API 與廣告資料中心互動的應用程式。透過 Ads Data Hub REST API，您可以查看與 Google 帳戶相關聯的廣告資料中心客戶，以及建立和執行查詢。

設定

開始使用 Ads Data Hub API 前，您需要先完成幾個步驟：

1. 確認要啟用 API 的使用者已獲得 Google Cloud 專案的 serviceusage.services.enable 權限。必須將具有 serviceusage.services.enable 權限的使用者加入許可清單，他們才能存取 API。
2. 在已建立用戶端憑證或服務帳戶的 Google Cloud 專案中，啟用 Ads Data Hub API。如要透過控制台為專案啟用 Ads Data Hub API，請按照下列步驟操作：
   1. 前往 Cloud Console API 程式庫。
   2. 從專案清單中選取要使用的專案。
   3. 搜尋「Ads Data Hub API」。
   4. 在 API 頁面中，按一下「啟用」。
3. 管理權限：
   1. 必須將用於建立憑證的電子郵件地址或服務帳戶加到廣告資料中心，並授予適當的權限。如果是服務帳戶，這是指服務帳戶的電子郵件地址；如果是 OAuth，這是指使用者的電子郵件地址。這可以確保服務帳戶或使用者的帳戶有權在廣告資料中心執行查詢。
4. (建議) 安裝 Google API 用戶端程式庫：
   1. Google API 用戶端程式庫支援多種常用的語言，讓您可以使用多個 Google API。用戶端程式庫可減少您需要編寫的程式碼，並簡化驗證設定程序，您可視情況採用。

用戶端程式庫	廣告資料中心範例
適用於 Java 的 Google API 用戶端程式庫	Java
適用於 Python 的 Google API 用戶端程式庫

驗證與授權

Ads Data Hub API 可以存取並變更廣告資料中心客戶帳戶中的資料，因此您必須驗證自己是授權使用者。在開始使用 Ads Data Hub API 之前，請務必先完成授權流程，才能取得與 API 互動的必要權限。您可以使用 OAuth 2.0 或服務帳戶進行驗證。

OAuth 2.0 服務帳戶

服務帳戶設定

1. 前往 Google API 控制台，然後前往您的管理員專案。
2. 確認「API 和服務」下方的專案已啟用 Ads Data Hub API。
   1. 如果尚未啟用，請按一下「+ 啟用 API 和服務」，然後啟用 Ads Data Hub API。
3. 在左側導覽選單中，依序按一下「IAM 與管理」>「服務帳戶」。
   1. 如果您尚未建立服務帳戶，請立即建立。
4. 按一下「動作」下方的三點選單 ()，然後點選「管理金鑰」。
   1. 依序按一下「新增金鑰」>「建立新的金鑰」。
   2. 確認已選取「JSON」後，按一下「建立」。
5. 在廣告資料中心帳戶中，新增服務帳戶的電子郵件地址並設為使用者。

傳送範例要求

#!/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 可建立及執行哪些查詢，請參閱廣告資料中心的查詢範例。
• 請展開範例內容，熟悉 API 的用法並根據自己的用途自訂，然後嘗試：
  • 輪詢查詢作業狀態。
  • 使用 BigQuery 用戶端程式庫擷取已完成的查詢結果。
• 如果對 API 有任何疑問或意見，請與廣告資料中心支援團隊聯絡。