版本資訊

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

版本 2

這個版本會引進下列變更，以移除已淘汰的功能，並讓 AdSense Management API 符合目前的 Google API 標準。根據 Google API 版本命名方案，這個版本會隨著時間推移而更新，納入額外的 (回溯相容) 功能，而非在個別次要版本中發布新功能。

2025-02-24

PolicyIssues

• 新增 policyTopics[].type 欄位，用於識別政策主題是否代表政策問題、法規問題或廣告主偏好設定。這會取代 policyTopics[].must_fix，後者現已標示為已淘汰的欄位。

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

• 新增建立、修補和更新方法。請注意，這些方法只能由已啟用 AdSense for Platforms 產品的專案使用。
• 在資源中新增「active」欄位。

帳戶

• 新增 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 收益。
  • accounts/{account}/payments/youtube-yyyy-MM-dd 可查看 YouTube 付費收益。
  
  注意：AdSense 收益的資源名稱保持不變：
  • accounts/{account}/payments/unpaid 可查看未支付的 (目前) AdSense 收益。
  • accounts/{account}/payments/yyyy-MM-dd 查看已支付的 AdSense 收益。

2021-06-30

檢舉

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

2021-04-19 (初始版本)

一般

• 我們已移除 v1.4 中所有已淘汰的方法。這包括不需要 accountId 的資源方法。在 v2 中，accountId 會在 parent 欄位中指定。
• 根據 Google API 標準，資源現在會透過 name 欄位進行識別。舉例來說，AdClient 的名稱會類似 accounts/{accountId}/adclients/{adClientId}。此外，在 v1.4 中，資源 ID 會用作報表維度，但在 v2 中，這個值現在可透過多個資源的 reporting_dimension_id 欄位取得。
• 系統已從所有資源中移除 kind 欄位。

帳戶

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

AdClient

• 已從 AdSense UI 中移除 arc_opt_in 欄位，因此已予以移除。
• supports_reporting 欄位已改為 reporting_dimension_id 欄位，代表 AD_CLIENT_ID 報表維度中使用的廣告客戶專屬 ID。如果 reporting_dimension_id 為空值，則 AdClient 不支援報表。

AdUnit

• status 欄位已重新命名為 state。此外，ACTIVE 狀態也不再指出過去七天內是否有廣告單元活動。在 v2 中，這表示廣告單元已由使用者啟用，且可放送廣告。
• 已移除 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 UI 中移除，因此也已從這裡移除。

付款

• 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 UI 保持一致。也就是說，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」) 已不再支援。
  • 布林欄位 use_timezone_reporting 已替換為 reporting_time_zone，後者可使用以下兩個值：ACCOUNT_TIME_ZONE 或 GOOGLE_TIME_ZONE (代表 PST/PDT)。v2 的預設值為 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 欄位。