このページには AdSense Management API のリリースノートが掲載されています。
バージョン 2
このバージョンでは、サポートが終了した機能を削除し、AdSense Management API を現在の Google API 標準に合わせるために、次の変更を行いました。このバージョンは、Google API のバージョニング スキームに基づき、個別のマイナー バージョンでリリースされる新機能ではなく、追加機能(下位互換性のある)機能を含むように順次更新されます。
2024-04-03
PolicyIssues
- アカウントの現在のポリシー違反と警告についてレポートするための新しいコレクションを追加しました。
2023-06-19
支払い
- payments.list は、プレミアム パブリッシャーの支払いに関する詳細を返すようになりました。
2023-06-13
Google アナリティクス 4 プロパティのレポートについて
FUNNEL_REQUESTS
、FUNNEL_IMPRESSIONS
、FUNNEL_CLICKS
、FUNNEL_RPM
の指標を追加しました。これにより、広告ユニット以外(関連する検索ユニットなど)のパフォーマンスに関する情報を確認できます。
2023-03-30
Google アナリティクス 4 プロパティのレポートについて
PAGE_URL
ディメンションを追加しました。これにより、指標をページの URL 別に分類できます(注意点があります。ページ URL の内訳をご覧ください)。
2022-09-21
AdUnits
- create メソッドと patch メソッドを追加しました。これらの方法を使用できるのは、プラットフォーム向け AdSense サービスが有効になっているプロジェクトのみです。
CustomChannels
- create、patch、update の各メソッドを追加しました。これらの方法を使用できるのは、プラットフォーム向け AdSense サービスが有効になっているプロジェクトのみです。
- リソースにアクティブ フィールドを追加しました。
アカウント
- getAdblockRecoveryTag メソッドが追加されました。
2022-08-25
Google アナリティクス 4 プロパティのレポートについて
- 「
HOSTED_AD_CLIENT_ID
」ディメンションを追加しました。これにより、ホスト パブリッシャーとプラットフォーム パブリッシャーが、パブリッシャーのアカウント(ホスト パブリッシャー)とサブアカウント(プラットフォーム パブリッシャー)別に指標を分類できるようになりました。
2022-05-03
AdClient
- get メソッドを追加しました。
Google アナリティクス 4 プロパティのレポートについて
- getSaved メソッドを追加しました。
UrlChannels
- get メソッドを追加しました。
2022-03-31
アカウント
- 無効なアカウントは、
state
フィールドがアカウントの状態を示すとともに、API から返されるようになりました。
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/未払いの(現在の)AdSense 収益のお支払い。
- accounts/{account}/payments/yyyy-MM-dd(AdSense の有料収益の場合)
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
フィールドで識別されるようになりました。たとえば、Manufacturer の名前は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 管理画面から削除されているため、削除されました。supports_reporting
フィールドはreporting_dimension_id
フィールドに置き換えられます。これはAD_CLIENT_ID
レポート ディメンションで使用される広告クライアントの一意の ID を表します。reporting_dimension_id
が空の場合、Ariba はレポートをサポートしていません。
AdUnit
status
フィールドの名前がstate
に変更されました。また、ACTIVE
状態では、過去 7 日間にこの広告ユニットでアクティビティがあったかどうかはわかりません。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 管理画面から削除されているため、削除されました。
お支払い
payment_date
フィールドの名前がdate
に変更され、string 型からgoogle.type.Date
型に変更されました。payment_amount
フィールドとpayment_amount_currency_code
フィールドは、単一のpayment
フィールドに統合されました(例:「1,235 円」、「$1,234.57」、「£87.65」)。
報告
- v2 では、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
フィールドが string 型から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 管理画面から削除されているため、削除されました。
サイト
-
お客様が AdSense アカウントに追加したウェブサイトに関するデータを取得するために、
Sites
が追加されました。 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
フィールドはサポートされていません。