リリースノート

このページでは、AdSense Management API のリリースノートについて説明します。

バージョン 2

このバージョンでは、サポートが終了した機能を削除し、AdSense Management API を 現在の Google API 標準に準拠させるために、次の変更が導入されています。Google API のバージョニング スキームに従い、このバージョンは、新しい機能を個別のマイナー バージョンでリリースするのではなく、追加の(下位互換性のある)機能を含めるように、今後更新されます。

2025-02-24

PolicyIssues

2024-04-03

PolicyIssues

  • アカウントに現在存在するポリシー違反と警告を報告する新しいコレクションを追加しました。

2023-06-19

支払い

  • payments.list が、プレミアム パブリッシャーのお支払いに関する詳細を返すようになりました。

2023-06-13

レポート

  • FUNNEL_REQUESTSFUNNEL_IMPRESSIONSFUNNEL_CLICKSFUNNEL_RPM の指標を追加しました。これらの指標は、広告以外のユニット(関連検索ユニットなど)のパフォーマンスに関する情報を提供します。

2023-03-30

レポート

  • PAGE_URL ディメンションを追加しました。これにより、指標をページ URL 別に分類できるようになりました(ただし、ページ URL 別の分類を参照)。

2022-09-21

AdUnits

  • create メソッドと patch メソッドを追加しました。なお、これらのメソッドは、プラットフォーム向け AdSense プロダクトが有効になっているプロジェクトでのみ使用できます。

CustomChannels

  • create、patch、update メソッドを追加しました。なお、これらのメソッドは、プラットフォーム向け AdSense プロダクトが有効になっているプロジェクトでのみ使用できます。
  • リソースに 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 収益。
    • accounts/{account}/payments/yyyy-MM-dd: 支払われた AdSense 収益。

2021-06-30

報告

  • サイトを閲覧しているユーザーに広告を表示する方法(インページ、全画面など)を示すディメンション AD_FORMAT_NAMEAD_FORMAT_CODE を追加しました。v1.4 には、同じ名前でメンバーが異なるディメンション(非推奨)がありました。v2 に追加された 2 つのディメンションは、v1.4 に存在していたディメンションとは異なります。

2021-04-19(初回リリース)

全般

  • v1.4 で非推奨になったメソッドはすべて削除されました。これには、accountId を必要としないリソース メソッドが含まれます。v2 では、accountIdparent フィールドで指定されます。
  • 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 カスタム メソッドを使用して同様の機能を実現できます。子アカウントの完全なツリーは、listChildAccounts を再帰的に呼び出すことで v2 で生成できます。

AdClient

  • AdSense UI からすでに削除されているため、arc_opt_in フィールドを削除しました。
  • supports_reporting フィールドは reporting_dimension_id フィールドに置き換えられます。これは、AD_CLIENT_ID レポート ディメンションで使用される広告クライアントの一意の ID を表します。reporting_dimension_id が空の場合、AdClient はレポートをサポートしていません。

AdUnit

  • status フィールドの名前が state に変更されました。また、ACTIVE のステータスには、過去 7 日間にこの広告ユニットでアクティビティがあったかどうかは表示されなくなります。v2 では、広告ユニットがユーザーによって有効になっており、広告を配信できることを意味します。
  • code フィールドは削除されました。この値は、name フィールドの最後(最後のスラッシュの後)に引き続き存在します。
  • contentAdsSettings.backupOption フィールドは削除されました。
  • type フィールドの値は、TYPE_UNSPECIFIEDDISPLAYFEEDARTICLEMATCHED_CONTENTLINK に制限されています。
  • AdSense UI ですでに削除されている他のフィールド(custom_stylesaved_style_id mobile_content_ads_settingsfeed_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 を使用して、複数の一般的な範囲を指定できるようになりました(例: TODAYYESTERDAYMONTH_TO_DATEYEAR_TO_DATELAST_7_DAYSLAST_30_DAYS)を指定できます。または、date_rangeCUSTOM に設定して、start_dateend_date を指定することもできます。
    • start_date フィールドと end_date フィールドの型が文字列から google.type.Date に変更されました。注: そのため、相対日付キーワード(例: 「today-6d」)はサポートされなくなりました。
    • ブール値フィールド use_timezone_reportingreporting_time_zone に置き換えられました。reporting_time_zone には、ACCOUNT_TIME_ZONE または GOOGLE_TIME_ZONE(PST/PDT を意味)の 2 つの値を指定できます。v2 のデフォルトは ACCOUNT_TIME_ZONE です。これは v1.4 のデフォルトとは異なります。
    • start_index フィールドは削除されました。
    • max_results フィールドの名前が limit に変更されました。
  • 保存したレポートの生成時に一部のフィールドが変更されました。
    • 日付フィールド(date_rangestart_dateend_datereporting_time_zone)を追加しました。
    • currency_code フィールドを追加しました。
    • locale フィールドの名前が language_code に変更されました。
    • start_index フィールドは削除されました。
    • max_results フィールドは削除されました。

SavedAdStyle

  • SavedAdStyle は、AdSense UI からすでに削除されているため、削除されました。

サイト

  • AdSense アカウントに追加したウェブサイトに関するデータを取得するために、Sites が追加されました。
  • state フィールドは、サイトが REQUIRES_REVIEWGETTING_READYREADYNEEDS_ATTENTION のいずれかの状態であるかどうかを表します。
  • auto_ads_enabled フィールドは、特定のサイトで自動広告が有効になっているかどうかを示すブール値です。

バージョン 1.4

このバージョンでは、次の機能が導入されています。

  • AdSense アカウントのお支払いを対応する通貨で表示できるようになりました。
  • delete メソッドを呼び出すことでアラートを閉じることができるようになりました。これにより、API と AdSense のウェブ インターフェースでアラートが非表示になります。
  • レポートのレスポンスに開始日と終了日が含まれるようになりました。これは、レポートの生成時に相対日付(todayyesterdayfirstDayOfMonth-1m など)を使用している場合に重要です。レスポンスには、リクエストした期間が含まれるようになりました。

既知の問題

このリリースでは、レポートの currency フィールドはサポートされていません。

バージョン 1.3

このバージョンでは、次の機能が導入されています。

  • アラートを取得する機能。
  • 指標とディメンションのメタデータを取得する機能。
  • アカウントのローカル タイムゾーンでレポートを実行する機能。

既知の問題

このリリースでは、レポートの currency フィールドはサポートされていません。

バージョン 1.2

このバージョンでは、次の機能が導入されています。

  • 広告スタイルを取得する機能。
  • フロントエンドで定義された保存済みレポートを取得して実行する機能。

既知の問題

このリリースでは、レポートの currency フィールドはサポートされていません。

バージョン 1.1

このバージョンでは、次の機能が導入されています。

また、データにアクセスする際に、デフォルト アカウントまたは特定のアカウントを選択できるようになりました。

既知の問題

このリリースでは、レポートの currency フィールドはサポートされていません。

バージョン 1

これは API の最初のリリースです。これには、広告クライアント、広告ユニット、カスタム チャネル、URL チャネルの取得とレポートの実行がサポートされています。

既知の問題

このリリースでは、レポートの currency フィールドはサポートされていません。