版本資訊

本頁提供 AdSense Management API 的版本資訊。

版本 2

為移除已淘汰的功能，並將 AdSense Management API 與目前的 Google API 標準保持一致，這個版本實施了下列變更。根據 Google API 版本管理架構，這個版本會隨時間更新，納入其他 (回溯相容) 功能，而非在個別子版本中發布的新功能。

2024-04-03

PolicyIssues

• 新增集合，用於回報帳戶目前的違反政策和警示。

2023-06-19

付款

• payments.list 現在會傳回優質發布商的付款詳情。

2023-06-13

報表

• 新增 FUNNEL_REQUESTS、FUNNEL_IMPRESSIONS、FUNNEL_CLICKS 和 FUNNEL_RPM 指標，提供非廣告單元 (例如相關搜尋單元) 成效的相關資訊。

2023-03-30

報表

• 新增「PAGE_URL」維度，讓系統按網頁網址細分指標 (請注意，請參閱「網頁網址細目」一節)。

2022-09-21

AdUnits

• 新增了建立和修補方法。請注意，這些方法僅供已啟用 AdSense for Platforms 產品的專案使用。

CustomChannels

• 新增了 create、patch 和 update 方法。請注意，這些方法僅供已啟用 AdSense for Platforms 產品的專案使用。
• 在資源中加入使用中的欄位。

帳戶

• 新增了 getAdBlockingRecoveryTag 方法。

2022-08-25

報表

• 新增「HOSTED_AD_CLIENT_ID」維度，方便代管和平台發布商按照發布商帳戶 (代管發布商) 和子帳戶 (平台發布商) 細分指標。

2022-05-03

AdClient

• 新增了 get 方法。

報表

• 新增了 getSaved 方法。

UrlChannels

• 新增了 get 方法。

2022-03-31

帳戶

• API 現在會傳回無效的帳戶，其中 state 欄位表示帳戶狀態。

AdClient

• 與上述帳戶變更類似，API 現在會傳回無效的廣告用戶端，並以 state 欄位表示廣告用戶端的狀態。

2022-02-24

付款

• 我們已擴充資源名稱格式，以支援獨立的 YouTube 收益資源。在為 YouTube 創作者提供更完善的 AdSense 體驗前，我們會分階段推出這項異動，並將 YouTube 收益拆分至專屬的付款帳戶中。您擁有 YouTube 收益的專屬付款帳戶之後，系統也會透過付款清單方式傳回 YouTube 付款資訊。YouTube 收益採用下列資源名稱格式：
  • accounts/{account}/payments/youtube-unpaid 對於尚未支付 (目前) 的 YouTube 收益。
  • 適用於 YouTube 付費收益的 accounts/{account}/payments/youtube-yyyy-MM-dd。
  
  注意：AdSense 收益的資源名稱維持不變：
  • accounts/{account}/payments/unpaid/未付帳款，以收取未付 (目前) 的 AdSense 收益。
  • 關於 AdSense 付費收益的帳戶，accounts/{account}/payments/yyyy-MM-dd。

2021-06-30

報告

• 新增 AD_FORMAT_NAME 和 AD_FORMAT_CODE 維度，指出廣告在網站上向使用者顯示的方式 (網頁內、穿插等)。請注意，v1.4 有 (已淘汰) 的維度，名稱相同但成員不同；第 2 版加入的兩個維度與 1.4 版中的維度不同。

2021 年 4 月 19 日 (初始版本)

一般

• 已在 v1.4 中移除所有淘汰的方法。包含不需要 accountId 的資源方法。在第 2 版中，accountId 是在 parent 欄位中指定。
• 根據 Google API 標準，資源現在以 name 欄位識別。例如，AdClient 的名稱類似於 accounts/{accountId}/adclients/{adClientId}。此外，在 1.4 版中，資源 ID 是當做報表維度使用，但在第 2 版中，現在您可透過數個資源的 reporting_dimension_id 欄位查看這個值。
• 已從所有資源中移除「kind」欄位。

帳戶

• name 欄位已變更為 display_name。
• timezone 欄位已從字串變更為 google.type.TimeZone。
• creation_time 欄位 (類型 int64) 已變更為 create_time (類型 google.protobuf.Timestamp)。
• 新增 pending_tasks 欄位，其中會列出在新帳戶註冊程序中需要完成的未完成工作。舉例來說，工作可能與帳單資料或電話驗證有關。
• 移除 sub_accounts 欄位，第 2 版是使用 listChildAccounts 自訂方法實現類似功能。透過遞迴呼叫 listChildAccounts 可在第 2 版中產生完整的子帳戶樹狀結構。

AdClient

• 移除 arc_opt_in 欄位，因為這個欄位已從 AdSense UI 中移除。
• 系統會將 supports_reporting 欄位替換為 reporting_dimension_id 欄位，這個欄位代表 AD_CLIENT_ID 報表維度中使用的廣告用戶端專屬 ID。如果 reporting_dimension_id 空白，表示 AdClient 不支援報表。

AdUnit

• status 欄位已重新命名為 state。此外，ACTIVE 狀態不再指出這個廣告單元最近 7 天內是否有活動。在第 2 版中，代表使用者已啟用廣告單元，可以放送廣告。
• 移除 code 欄位，這個值仍可在 name 欄位的結尾 (在最後一個正斜線之後) 找到。
• 已移除 contentAdsSettings.backupOption 欄位。
• type 欄位受限於 TYPE_UNSPECIFIED、DISPLAY、FEED、ARTICLE、MATCHED_CONTENT 和 LINK 值。
• 另外，在 AdSense 使用者介面中移除的其他欄位也會一併移除：custom_style、saved_style_id、 mobile_content_ads_settings、feed_ads_settings。

快訊

• 移除了 delete 方法。
• 移除 is_dismissible 欄位，
• locale 欄位已重新命名為 language_code。

CustomChannel

• 移除 code 欄位，這個值仍可在 name 欄位的結尾 (在最後一個正斜線之後) 找到。
• targeting_info 欄位已從 AdSense 使用者介面中移除，因此已移除。

付款

• payment_date 欄位已重新命名為 date，並從類型字串變更為 google.type.Date 類型。
• payment_amount 欄位和 payment_amount_currency_code 欄位已合併為單一 payment 欄位 (例如「¥1,235 JPY」、「$1,234.57」、「£87.65」

報告

• 在第 2 版中，AdSense Management API 報表資料與 AdSense 使用者介面一致。這表示不再支援 AdMob 和 YouTube 資源。此外，這個 API 僅支援過去 3 年的報表資料。
• 已移除 Metadata.dimensions 資源和 Metadata.metrics 資源。
• 新增方法來產生報表的 CSV 版本，並取代 v1.4 中的查詢參數。注意：如要壓縮，您仍可使用 HTTP 標頭「Accept-Encoding: gzip」。
• 針對臨時報表產生作業，部分欄位已變更。
  • account_id 欄位已重新命名為 account。
  • dimension 欄位已重新命名為 dimensions。
  • metric 欄位已重新命名為 metrics。
  • filter 欄位已重新命名為 filters。
  • sort 欄位已重新命名為 order_by。
  • locale 欄位已重新命名為 language_code。
  • currency 欄位已重新命名為 currency_code。
  • 您現在可以使用 date_range 指定多個常用範圍 (例如TODAY、YESTERDAY、MONTH_TO_DATE、YEAR_TO_DATE、LAST_7_DAYS 和 LAST_30_DAYS)，或者，將 date_range 設為 CUSTOM 即可指定 start_date 和 end_date。
  • start_date 和 end_date 欄位已從類型字串變更為 google.type.Date 類型。注意：結果，相對日期關鍵字 (例如「today-6d」(今天 6d)) 功能。
  • 布林值欄位 use_timezone_reporting 已替換為 reporting_time_zone，可包含下列其中一個值：ACCOUNT_TIME_ZONE 或 GOOGLE_TIME_ZONE (也就是 PST/PDT)。第 2 版的預設值為 ACCOUNT_TIME_ZONE，這與 v1.4 中的預設值不同。
  • 移除 start_index 欄位，
  • max_results 欄位已重新命名為 limit。
• 已儲存的報表產生過程中，部分欄位已變更。
  • 已新增日期欄位 (date_range、start_date、end_date、reporting_time_zone)。
  • 新增了 currency_code 欄位。
  • locale 欄位已重新命名為 language_code。
  • 移除 start_index 欄位，
  • 移除 max_results 欄位，

SavedAdStyle

• SavedAdStyle 已從 AdSense UI 中移除。

地點

• 已新增 Sites，用於擷取已加進 AdSense 帳戶的網站相關資料。
• state 欄位代表網站是否處於下列任一狀態：REQUIRES_REVIEW、GETTING_READY、READY、NEEDS_ATTENTION。
• auto_ads_enabled 欄位是一個布林值，表示特定網站是否啟用自動廣告。

1.4 版

這個版本包含下列功能：

• 您現在可以使用對應貨幣列出 AdSense 帳戶款項。
• 您現在可以呼叫 delete 方法，隱藏 API 和 AdSense 網頁介面中快訊，藉此關閉快訊。
• 報表回應中會包含開始和結束日期。如果您在產生報表時使用的是相對日期 (例如 today、yesterday、firstDayOfMonth-1m)，這項做法就格外重要，現在回應中會包含您要求的日期範圍。

已知問題

這個版本不支援報表中的 currency 欄位。

1.3 版

這個版本包含下列功能：

• 可擷取快訊。
• 可擷取指標和維度中繼資料。
• 能夠以帳戶的當地時區執行報表。

已知問題

這個版本不支援報表中的 currency 欄位。

1.2 版本

這個版本包含下列功能：

• 可擷取廣告樣式。
• 可擷取並執行在前端定義的已儲存報表。

已知問題

這個版本不支援報表中的 currency 欄位。

1.1 版本

這個版本包含下列功能：

• 可列出使用者有權存取的帳戶
• 可對特定帳戶進行 GET 呼叫
• 可對廣告單元和自訂管道進行 GET 呼叫
• 可判斷廣告單元與自訂管道的關係
• 自訂管道包含更多指定目標資訊相關資料

此外，您現在可以在預設帳戶或特定帳戶下存取資料。

已知問題

這個版本不支援報表中的 currency 欄位。

版本 1

這是第一個 API 版本。包括擷取廣告用戶端、廣告單元、自訂管道和網址管道，以及執行報表。

已知問題

這個版本不支援報表中的 currency 欄位。