授權與 HTTP 標頭

呼叫 Search Ads 360 Reporting API 時,您需要 OAuth 2.0 應用程式憑證。如果您是以 Search Ads 360 管理員帳戶的身分發出 API 呼叫,也需要在每個要求中指定 login-customer-id 標頭。本頁說明如何設定這些值,並記錄使用 REST 介面時傳送及接收的幾個額外 API 專屬 HTTP 標頭。

OAuth 2.0 憑證

Search Ads 360 Reporting API 會使用應用程式憑證,識別及授權 API 要求。您可以設定 OAuth 2.0 用戶端。所有 Search Ads 360 Reporting API 呼叫都必須透過 OAuth2 授權。OAuth2 可讓 Search Ads 360 報表 API 用戶端應用程式存取使用者的 Search Ads 360 帳戶,不必處理或儲存使用者的登入資訊。

如果您是 Google API 的新手,可以先使用 oauth2lOAuth 2.0 Playground 試用應用程式憑證和 Search Ads 360 Reporting API,再為應用程式編寫程式碼。您也可以執行提供的使用者憑證產生指令碼,產生 OAuth 重新整理權杖。

產生新的存取權杖

取得用戶端 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

然後,在每個 API 呼叫的 Authorization HTTP 標頭中,使用 curl 要求傳回的存取權杖,向 Search Ads 360 Reporting API 提出要求:

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN

要求標頭

登入客戶 ID

如果是管理員對客戶帳戶發出的 Search Ads 360 Reporting API 呼叫 (也就是以管理員身分登入,對其中一個客戶帳戶發出 API 呼叫),您也需要提供 login-customer-id HTTP 標頭。這個值代表發出 API 呼叫的管理員的 Search Ads 360 客戶 ID。

加入這個標頭等同於在登入後或點按頁面右上角的個人資料圖片時,在 Search Ads 360 使用者介面中選擇帳戶。指定客戶 ID 時,請務必移除所有連字號 (—),例如:1234567890,而非 123-456-7890

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

回應標頭

API 的 HTTP 回應會傳回下列標頭。

要求 ID

request-id 是用於識別 API 要求的專屬字串。偵錯或排解特定 API 呼叫問題時,request-id是重要的 ID,聯絡 Google 開發人員支援團隊時,請務必提供這個 ID。

request-id: 2a5Cj89VV7CNhya1DZjjrC