授權與 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 Reporting 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

接著,您可以在每次對 Search Ads 360 Reporting API 進行 API 呼叫的 Authorization HTTP 標頭中,使用 curl 要求傳回的存取權杖

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 UI 中選擇帳戶。指定客戶 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 是聯絡 Google 開發人員支援團隊時可派上用場的重要 ID。

request-id: 2a5Cj89VV7CNhya1DZjjrC