本頁提供 AdSense Management API 的版本資訊。
版本 2
這個版本推出了下列變更,藉此移除已淘汰的功能,並使 AdSense Management API 與目前的 Google API 標準保持一致。根據 Google API 版本管理架構,這個版本將隨著時間更新,納入其他 (回溯相容) 功能,而不是在個別子版本中發布的新功能。
2023-06-19
付款
- payments.list 現在會傳回 Premium 出版商的付款詳情。
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 產品的專案才能使用這些方法。
- 已將有效欄位新增至資源。
帳戶
- 新增了 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 收益資源。在改善 AdSense 創作者的 AdSense 體驗之前,這項變更會處於分階段推出,屆時 YouTube 收益將歸入專屬的付款帳戶。有了 YouTube 收益專用的付款帳戶後,系統也會透過付款清單的付款方式傳回 YouTube 付款資訊。YouTube 收益的資源名稱格式如下:
- accounts/{account}/payments/youtube-unpaid (目前) YouTube 收益。
- accounts/{account}/payments/youtube-yyyy-MM-dd (收取 YouTube 付費收益)。
注意:AdSense 收益的資源名稱維持不變:- 帳戶/{account}/payments/未付款 (目前) AdSense 收益的未付款項。
- accounts/{account}/payments/yyyy-MM-dd (收取 AdSense 付費收益)。
2021-06-30
報告
- 新增
AD_FORMAT_NAME
和AD_FORMAT_CODE
維度,指出廣告在網站上向使用者顯示的方式 (網頁內、穿插廣告等)。請注意,v1.4 包含名稱相同但成員不同的維度 (已淘汰) ;第 2 版中新增的兩個維度與 v1.4 中的維度不同。
2021 年 4 月 19 日 (初始版本)
一般
- 已移除 v1.4 中所有已淘汰的方法。這包括不需要
accountId
的資源方法。在 v2 中,accountId
是在parent
欄位中指定。 - 根據 Google API 標準,系統現在透過
name
欄位識別資源。舉例來說,AdClient 的名稱看起來會是accounts/{accountId}/adclients/{adClientId}
。此外,在 v1.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
欄位。在 v2 中,您可以透過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
狀態已無法再指出這個廣告單元最近七天是否曾有任何活動。在第 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 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 使用者介面一致,這表示系統不再支援 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)。第 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 使用者介面中移除,因此已遭移除。
地點
-
已新增
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
」欄位。