標準查詢參數

下表列出了 AdSense Host API 作業的所有查詢參數。

注意事項 (關於 API 金鑰和驗證權杖):

  1. 每個請求都需要 key 參數,除非請求中包含 OAuth 2.0 權杖。
  2. 每次請求時都必須傳送一個標示為 (已驗證) 的授權權杖。OAuth 2.0 是授權通訊協定的首選。
  3. 每次請求時都可使用下列其中一種方式提供 OAuth 2.0 權杖:
    • 以下列方法使用 access_token 查詢參數:?access_token=oauth2-token
    • 以下列方法使用 HTTP Authorization 標頭:Authorization: Bearer oauth2-token

除了另有註解的參數,其他參數都可自由選用。

參數 意義 備註
access_token 目前使用者的 OAuth 2.0 權杖。
callback 回呼函數。
  • 處理這個回應的 JavaScript 回呼函數的名稱。
  • 用於 JavaScript JSON-P 請求中。
fields 可指定哪些部分的欄位要加進回應。
  • 詳情請參閱「成效改善訣竅」文件中的部分回應一節。
  • 用於提升效能。
key API 金鑰。(必填*)
  • *除非您提供 OAuth 2.0 權杖,否則此為必要參數。
  • 您的 API 金鑰可識別專案並為您提供 API 存取權、配額和報表。
  • 您可以在 Google 開發人員主控台上取得專案的 API 金鑰。
prettyPrint

傳回包含縮排和分行符號的回應。

  • 如果為 true,則以方便識別的格式傳回回應。
  • 預設值:false
  • 當這個值是 false 時,可以降低回應的負載量,在部分環境中提升效能。
quotaUser 替代 userIp
  • 讓您就算不知道使用者的 IP 位址時,也能由伺服器端的應用程式,強制執行每個使用者的配額限制。舉例來說,如果是代表使用者在 App Engine 上執行 cron 工作的應用程式,就可能發生這種情形。
  • 您可以選擇專門用來識別使用者的任意字串,但上限為 40 個字元。
  • 替換 userIp (如果兩者都提供)。
  • 進一步瞭解如何使用上限
userIp 進行 API 呼叫時,受到呼叫的使用者的 IP 位址。
  • 讓您由伺服器端的應用程式呼叫 API 時,可強制執行每個使用者的配額限制。
  • 進一步瞭解如何使用上限

傳送您對下列選項的寶貴意見...

這個網頁
AdSense Host API
AdSense Host API