呼叫 Google Ads API 時,您需要 OAuth 2.0 憑證。如果您使用 Google Ads 管理員帳戶發出 API 呼叫,也需要在每個要求中指定 login-customer-id 標頭。本頁面說明如何設定這些值,並介紹使用 REST 介面時,傳送及接收的其他幾個 API 專屬 HTTP 標頭。
OAuth 2.0 憑證
Google Ads API 使用 OAuth 2.0 授權 API 要求。OAuth 2.0 使用者驗證流程和服務帳戶流程都支援。詳情請參閱「Google Ads API 中的 OAuth 2.0」。
如果您是 Google API 的新手,可以使用 gcloud CLI 或 OAuth 2.0 Playground 試用 OAuth 2.0 憑證和 Google Ads API,再為應用程式編寫程式碼。
建議您使用 https://oauth.net/code/ 提供的其中一個 OAuth 2.0 程式庫,實作 OAuth 2.0 授權工作流程。不過,我們還是列出了 curl 指令,以備您需要自行實作。
服務帳戶
請按照步驟,為 Google Ads API 設定 Google Cloud 專案。記錄服務帳戶電子郵件地址和服務帳戶金鑰。接著,請按照服務帳戶指南中的一般操作說明,設定服務帳戶來存取 Google Ads 帳戶。
使用者驗證
按照步驟為 Google Ads API 設定 Google Cloud 控制台專案。記下用戶端 ID 和用戶端密鑰。接著,請按照電腦版應用程式流程或網頁應用程式流程的指示,產生更新權杖和存取權杖。用於存取 Google Ads API 的 scope 為 https://www.googleapis.com/auth/adwords。
產生新的存取權杖
服務帳戶
取得服務帳戶電子郵件和服務帳戶金鑰後,請按照「在伺服器對伺服器應用程式實作 OAuth 2.0」指南產生 JWT 憑證附加資訊集,然後用來交換 OAuth 2.0 存取權杖。請務必按照指南操作,並選取「HTTP/REST」分頁標籤。用於存取 Google Ads API 的 OAuth 2.0 scope 為 https://www.googleapis.com/auth/adwords。此外,建構 JWT 宣告集時,您可以略過 sub 參數,因為設定步驟會授予服務帳戶直接存取 Google Ads 帳戶的權限,因此不需要模擬 Google Ads 使用者。
接著,您在每次呼叫 Google Ads API 時,於 Authorization HTTP 標頭中使用存取權杖:
GET /v26/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
使用者驗證
取得 OAuth 2.0 用戶端 ID、用戶端密鑰和更新權杖後,您可以使用 curl 指令列工具產生新的存取權杖,用於 API 呼叫:
curl \
--data "grant_type=refresh_token" \
--data "client_id=CLIENT_ID" \
--data "client_secret=CLIENT_SECRET" \
--data "refresh_token=REFRESH_TOKEN" \
https://www.googleapis.com/oauth2/v3/token接著,您會在每個 Google Ads API 呼叫的 Authorization HTTP 標頭中,使用 curl 要求傳回的存取權杖:
GET /v26/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
要求標頭
以下各節說明向 Google Ads API 提出要求時,需要或使用的 HTTP 標頭。
登入客戶 ID
如果管理員對客戶帳戶發出 Google Ads API 呼叫 (也就是以管理員身分登入,對其中一個客戶帳戶發出 API 呼叫),您也需要提供 login-customer-id HTTP 標頭。這個值代表發出 API 呼叫的管理員 Google Ads 客戶 ID。
加入這個標頭,就等同於在登入後或點按頁面右上角的個人資料圖片時,在 Google Ads 使用者介面中選擇帳戶。指定客戶 ID 時,請務必移除所有連字號 (—)。例如:1234567890,而非 123-456-7890。如要進一步瞭解登入客戶 ID,請參閱 Google Ads 存取模型指南。
GET /v26/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
連結的客戶 ID
合作夥伴 (例如第三方應用程式數據分析供應商或資料合作夥伴) 對已連結的 Google Ads 帳戶採取行動時,會使用「已連結的客戶 ID」標頭。詳情請參閱 API 呼叫結構指南。
Authorization: Bearer ACCESS_TOKEN
login-customer-id: PARTNER_CUSTOMER_ID
linked-customer-id: ADVERTISER_CUSTOMER_ID
回應標頭
API 的 HTTP 回應會傳回下列標頭。
要求 ID
request-id 是用於識別 API 要求的專屬字串。在偵錯或排解特定 API 呼叫的問題時,request-id 是與 Google 開發人員支援團隊聯絡時,必須隨時備妥的重要 ID。
request-id: 2a5Cj89VV7CNhya1DZjjrC