このページには AdSense Management API のリリースノートを掲載しています。
バージョン 2
このバージョンでは、サポートが終了した機能を削除し、AdSense Management API を現在の Google API 標準に合わせるために、次の変更を行います。このバージョンは、Google API のバージョニング スキームに従って順次更新され、新機能が個別のマイナー バージョンでリリースされるのではなく、追加機能(下位互換性)が含まれるようになります。
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 サービスが有効になっているプロジェクトでのみ使用できます。
- リソースにアクティブ フィールドを追加しました。
アカウント
- getAdBlockingRecoveryTag メソッドを追加しました。
2022-08-25
Google アナリティクス 4 プロパティのレポートについて
- 「
HOSTED_AD_CLIENT_ID
」ディメンションを追加しました。これにより、ホスト パブリッシャーとプラットフォーム パブリッシャーは、パブリッシャーのアカウント(ホスト パブリッシャー)とサブアカウント(プラットフォーム パブリッシャー)ごとに指標を分類できます。
2022-05-03
AdClient
- get メソッドを追加しました。
Google アナリティクス 4 プロパティのレポートについて
- getSaved メソッドを追加しました。
UrlChannels
- get メソッドを追加しました。
2022-03-31
アカウント
- 無効なアカウントは API によって返されるようになりました。
state
フィールドはアカウントの状態を示します。
AdClient
- 上記のアカウントの変更と同様に、無効な広告クライアントは API から返されるようになり、
state
フィールドが広告クライアントの状態を示します。
2022-02-24
お支払い
-
リソース名の形式が拡張され、YouTube での収益用に個別のリソースがサポートされるようになりました。この変更は、YouTube クリエイター向けの改良された AdSense サービスの段階的なロールアウトに先立ち、YouTube の収益をそれぞれのお支払いアカウントに分けるというものでした。YouTube での収益専用のお支払いアカウントをお持ちの場合は、お支払い方法から支払い情報が返されるようになります。YouTube の収益は、次のリソース名の形式になります。
- accounts/{account}/payments/youtube-unpaid 収益の未払い(現時点) 。
- 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
フィールドで識別されるようになりました。たとえば、Keymaster の名前は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
が空の場合、Keymaster はレポートをサポートしません。
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
フィールドが文字列型から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 から削除されているため、削除されました。
サイト
-
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
フィールドはこのリリースではサポートされていません。