本頁提供 AdSense Management API 的版本資訊。
版本 2
為移除已淘汰的功能,並讓 AdSense Management API 符合目前的 Google API 標準,這個版本導入了下列變更。根據 Google API 版本控管機制,這個版本會隨著時間更新,納入更多 (回溯相容) 功能,而不是在不同的次要版本中發布新功能。
2025-10-02
報表
- 新增
TRAFFIC_SOURCE
維度,可依流量來源 (例如「Google」、「Bing」、「Facebook」、「其他」) 細分指標。詳情請參閱「流量來源細目」。
2025-05-06
PolicyIssues
- 已淘汰的
policyTopics[].must_fix
欄位 (請參閱先前的更新) 現在一律會設為false
。
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 收益。
- 帳戶/{帳戶}/payments/yyyy-MM-dd,適用於已支付的 AdSense 收益。
2021-06-30
檢舉
- 新增
AD_FORMAT_NAME
和AD_FORMAT_CODE
維度,指出廣告在您網站上向使用者顯示的方式 (網頁內、穿插等)。請注意,v1.4 版有 (已淘汰) 相同名稱但成員不同的維度;v2 版新增的兩個維度與 v1.4 版的維度不同。
2021-04-19 (初始版本)
一般
- 已移除 1.4 版中所有已淘汰的方法。這包括不需要
accountId
的資源方法。在第 2 版中,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
自訂方法,達到類似功能。您可以在第 2 版中呼叫listChildAccounts
,以遞迴方式產生完整的子帳戶樹狀結構。
AdClient
- 已移除
arc_opt_in
欄位,因為該欄位已從 AdSense 使用者介面中移除。 supports_reporting
欄位已由reporting_dimension_id
欄位取代,後者代表廣告用戶端的專屬 ID,與AD_CLIENT_ID
報表維度中使用的 ID 相同。如果reporting_dimension_id
為空,則 AdClient 不支援報表功能。
AdUnit
- 「
status
」欄位已重新命名為「state
」。 此外,ACTIVE
狀態不再表示過去七天內,這個廣告單元是否有活動。在第 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
欄位結尾找到 (最後一個正斜線之後)。 - 由於 AdSense 使用者介面已移除
targeting_info
欄位,因此我們也將其移除。
付款
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 版本的全新方法,取代 1.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
(代表太平洋標準時間/太平洋夏令時間)。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 使用者介面中移除。
地點
-
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
」欄位。