このページでは、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
ディメンションを追加しました。これにより、指標をページの URL 別に分類できます(ただし、いくつかの注意点があります。ページの URL 別の分類をご覧ください)。
2022-09-21
AdUnits
- 作成メソッドとパッチ メソッドを追加しました。これらのメソッドは、プラットフォーム向け AdSense プロダクトが有効になっているプロジェクトでのみ使用できます。
CustomChannels
- create、patch、update メソッドを追加しました。これらのメソッドは、プラットフォーム向け AdSense プロダクトが有効になっているプロジェクトでのみ使用できます。
- リソースにアクティブ フィールドを追加しました。
アカウント
- 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 の収益のリソース名の形式は次のようになります。
- 未払い(現在)の YouTube 収益の場合は、accounts/{account}/payments/youtube-unpaid。
- 有料 YouTube の収益の場合は accounts/{account}/payments/youtube-yyyy-MM-dd。
注: AdSense の収益のリソース名は変更されません。- 未払い(現在)の AdSense 収益の場合は、accounts/{account}/payments/unpaid。
- 有料の AdSense 収益の場合は accounts/{account}/payments/yyyy-MM-dd。
2021-06-30
報告してください
- ディメンション
AD_FORMAT_NAME
とAD_FORMAT_CODE
を追加しました。これらは、サイトを閲覧しているユーザーに広告を表示する方法(ページ内、全画面など)を示します。v1.4 には、同じ名前でメンバーが異なる(非推奨の)ディメンションがありました。v2 で追加された 2 つのディメンションは、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
カスタム メソッドで実現できます。v2 では、listChildAccounts
を再帰的に呼び出すことで、子アカウントの完全なツリーを生成できます。
AdClient
arc_opt_in
フィールドは AdSense UI からすでに削除されているため、削除しました。supports_reporting
フィールドは、AD_CLIENT_ID
レポート ディメンションで使用される広告クライアントの一意の ID を表すreporting_dimension_id
フィールドに置き換えられます。reporting_dimension_id
が空の場合、AdClient はレポートをサポートしていません。
AdUnit
status
フィールドの名前がstate
に変更されました。また、ACTIVE
状態は、過去 7 日間にこの広告ユニットでアクティビティがあったかどうかを示すものではなくなります。v2 では、広告ユニットがユーザーによって有効化され、広告を配信できることを意味します。code
フィールドが削除されました。この値は、name
フィールドの末尾(最後のスラッシュの後)で確認できます。contentAdsSettings.backupOption
フィールドが削除されました。type
フィールドは、TYPE_UNSPECIFIED
、DISPLAY
、FEED
、ARTICLE
、MATCHED_CONTENT
、LINK
の値に制限されています。- AdSense の UI で既に削除されている他のフィールド(
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")。
報告してください
- v2 では、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
に置き換えられました。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 の最初のリリースです。これには、広告クライアント、広告ユニット、カスタム チャネル、URL チャネルの取得とレポートの実行のサポートが含まれます。
既知の問題
このリリースでは、レポートの currency
フィールドはサポートされていません。