Google アナリティクス - すべての Configuration API の変更履歴

このページには、Google アナリティクス Configuration API に加えられた変更が記載されています。Provisioning API と Management API の変更履歴が含まれています。API デベロッパーは、このリストを定期的にチェックして、新しいお知らせがないかどうか確認することをおすすめします。以下の購読セクションのフィードから、変更通知を受け取るように登録することも可能です。

変更履歴の購読

Google Analytics API に関するすべての変更履歴
–
チャンネル登録 rss

Collection API、Configuration API、Reporting API に関する情報がすべて含まれています。

すべての Configuration API の変更履歴
–
チャンネル登録 rss

Management API と Provisioning API に関する情報が含まれます。

Management API のユーザーデータ保持設定

WebProperty リソースに追加された新しい「dataRetentionTtl」フィールドと「dataRetentionResetOnNewActivity」フィールドを使用し、ユーザーデータ保持設定をプログラムで構築できるようにしました。

これは User Deletion API の初回リリースです。

  • Google アナリティクスの User Deletion API を使用すると、特定のエンドユーザーのデータをプロジェクトまたはウェブ プロパティから削除できます。ユーザー削除リクエストは、Firebase プロジェクトか Google アナリティクスのプロパティを使用して行います。詳しくは、User Deletion API - 概要をご覧ください。

Management API での書き込み操作

ウェブ プロパティ、ビュー（旧プロファイル）、目標のリソースを対象とする Management API の書き込み操作（作成、更新、削除、パッチの適用など）は、ホワイトリスト登録が不要になりました。Management API の書き込み操作全体のデフォルトの 1 日あたりの制限は 50 件です。詳しくは、制限と割り当てのページをご覧ください。

カスタム指標

これはバグ修正のリリースです。min_value が設定されていない場合、タイプ TIME のカスタム指標の作成に失敗するという問題を修正しました。リクエストで min_value を指定しない場合、デフォルトとして、min_value が 0 のカスタム指標が作成されます。

通貨

これはバグの修正リリースです。通貨のサブセットがアナリティクス ウェブ管理画面ではサポートされていたものの、API ではサポートされていなかった問題を修正しました。今回のリリースでは、次の通貨のサポートを追加しました。

  • AED、BOB、CLP、COP、EGP、HRK、ILS、MAD、MYR、PEN、PKR、RON、RSD、SAR、SGD、VEF、LVL

詳しくは、ビュー（旧プロファイル）のリファレンスと通貨リファレンスのヘルプセンター記事をご覧ください。

今回のリリースでは、リマーケティング用ユーザーリストを Management API に追加しました。

リマーケティング用ユーザーリスト

Management API を使って、Google アナリティクスのプロパティのリマーケティング ユーザーリストに対して、create、get、list、update、patch を実行できます。リマーケティング ユーザーリストの仕組みについて詳しくは、ヘルプセンターでアナリティクスのリマーケティング用ユーザーリストについてをご覧ください。

非サンプリング レポート

非サンプリング レポート API で、1 日あたり 100 レポートの制限を撤廃しました。API では、管理画面での非サンプリング レポートの作成時と同じ、プロパティごとの 1 日あたりのトークン システムが使用されます。

非サンプリング レポート

現在のユーザーがアクセスできない非サンプリング レポートから、Management API レスポンス メッセージ内のダウンロード リンクが削除されます。これで、管理画面ダッシュボードの機能（生成されたドキュメントのダウンロード リンクがレポート オーナーにのみ表示される）と整合性が取れました。

ビュー（旧プロファイル）

今回のリリースでは、botFilteringEnabled プロパティをビュー（旧プロファイル）リソースに追加しました。このプロパティは、ビュー（旧プロファイル）に対して bot フィルタリングが有効かどうかを示します。詳しくは、ビュー（旧プロファイル）リファレンス ドキュメントをご覧ください。

非サンプリング レポート

今回のリリースでは、delete メソッドを非サンプリング レポートに追加しました。詳しくは、非サンプリング レポート: delete をご覧ください。

セグメント

これはバグ修正のリリースです。今回のリリースでは、セグメント リスト メソッドを呼び出したとき、通貨値に誤りのあるセグメントが定義に表示される問題を修正しました。

セグメント

これはバグ修正のリリースです。今回のリリースでは、非公開セグメントを複数のビュー（旧プロファイル）に固定したユーザーに対し、セグメント リスト メソッドを呼び出した際に 500 エラー レスポンスを返す問題を修正しました。

今回のリリースでは、Provisioning API TOS URL に追加のパラメータを追加しました。

  • URL パラメータ provisioningSignup=false の追加により、Google アナリティクス アカウントのないユーザーのために Google アナリティクス アカウントのプロビジョニングを行う際に発生した問題を修正しました。このパラメータを TOS URL に追加するには、コードを更新する必要があります。

バッチ処理

今回のリリースでは、一般的なバッチ処理のサポートに加え、User Permissions API に特別なサポートを追加しました。ユーザー権限リクエストをバッチ処理することで、パフォーマンスが大幅に向上し、割り当ての使用量が減少します。

ビュー（旧プロファイル）

今回のリリースでは、insert オペレーションが設定されていない場合、ビュー（旧プロファイル）currency プロパティはデフォルトで USD になるようになりました。また、過去に currency プロパティなしで作成されたビュー（旧プロファイル）では、get と list オペレーションにより USD が返されます。

フィルタ

今回のリリースでは、サポートが終了したフィルタ フィールド IS_MOBILE と IS_TABLET の最終削除が行われ、DEVICE_CATEGORY=mobile と DEVICE_CATEGORY=tablet に置き換えられます。フィルタ フィールドで IS_MOBILE と IS_TABLET を使用するように設定する insert、update、patch のリクエストは、エラーを返します。

フィルタ

今回のリリースでは、fieldIndex プロパティをすべてのフィルタ詳細セクションに追加することで、フィルタ フィールドでカスタム ディメンションを使用できるようにしました。たとえば、フィルタ式を "field": "CUSTOM_DIMENSION" と "fieldIndex": "1" で設定することで、フィルタが 1 つ目のカスタム ディメンションで機能するようにしました。

目標

今回のリリースでは、"comparisonValue": "0" で目標を作成する際にエラーが発生する問題も修正しました。

今回のリリースでは、dailyUpload リソースの最終廃止と削除が行われます。dailyUpload リソースは 2014 年 6 月 20 日に正式にサポートが終了しました。すべての費用データのインポートはアップロード リソースを使って行われるようになりました。

今回のリリースでは、2 つの新しいコレクション（カスタム ディメンションとカスタム指標）を Management API に追加しました。

カスタム ディメンションとカスタム指標

Management API を使用して、カスタム ディメンションとカスタム指標の作成、一覧表示、取得、パッチ適用、更新ができるようにしました。

コレクションにリソースが含まれていない場合、すべてのコレクションの list メソッド レスポンスに、items プロパティの空のリストが含まれるようにしました。以前は、items プロパティはレスポンスから省略されていました。Google アナリティクスの設定データのクエリとレスポンスについて詳しくは、API リファレンスをご覧ください。

今回のリリースでは、Google Analytics Management API の新しいスコープを導入しました。- analytics.manage.users.readonly - Google アナリティクスのユーザー権限の表示。

新しい DEVICE_CATEGORY フィルタ フィールドを追加し、IS_MOBILE と IS_TABLET のサポートを終了しました。DEVICE_CATEGORY=mobile と DEVICE_CATEGORY=tablet を使用してください。

ビュー（旧プロファイル）リソースに、拡張 e コマースが有効（true）か無効（false）かを示す enhancedECommerceTracking プロパティを追加しました。

今回のリリースでは、新しいデータ インポート タイプを追加し、dailyUpload リソースのサポートを終了しました。

データ インポート

Management API を使って Google アナリティクス アカウントへのデータのインポートする方法について詳しくは、データ インポート - デベロッパー ガイドをご覧ください。

アップロード

  • upload リソースが次のアップロード タイプをサポートするようになりました。
    • キャンペーン データ
    • コンテンツ データ
    • 費用データ
    • 商品データ
    • 払い戻しデータ
    • ユーザーデータ
  • upload リソースに新しい migrateDataImport メソッドを加え、既存の費用データ customDataSources を移行できるようにしました。

日次アップロードのサポート終了

  • dailyUpload リソースのサポートを終了しました。データ インポート機能を使用する移行について詳しくは、移行ガイドをご覧ください。
  • dailyUpload リソースは、6 か月間は引き続き利用できます。その間、uploadType プロパティを analytics#dailyUploads に設定している残りの customDataSources は自動的に移行され、upload リソースで機能します。
  • 現在 dailyUpload リソースをお使いの場合は、できるだけ早くコードを更新し、アップロード リソースを使用するように移行してください。

これは Provisioning API の初回リリースです。

  • Provisioning API を使用すると、新しい Google アナリティクス アカウントをプログラムで作成できます。Provisioning API は、正規サービス プロバイダや大規模なパートナーを対象とした、招待制の API です。詳しくは、Provisioning API の概要をご覧ください。

今回のリリースでは、2 つの新しい構成 API を追加しました。

  • Management API の AdWords リンクを使用すると、Google AdWords のアカウントと Google アナリティクスのプロパティ間のリンクを作成、一覧表示、取得、更新、パッチ適用、および削除することができます。また、どのビュー（旧プロファイル）を AdWords のデータにリンクするかを管理することも可能です。

フィルタ

非サンプリング レポート: Management API

非サンプリング レポートと呼ばれる新しいリソースが Management API に追加されます。非サンプリング レポートは、非サンプリング データを使用して生成された Google アナリティクスのレポートです。現在のところ、非サンプリング レポートは Google アナリティクス プレミアム ユーザーのみがご利用いただけます。

セグメント: Management API v2.4 と v3.0

セグメント コレクションに次の変更が加えられました。

  • ユーザー セグメントとシーケンス セグメントが API でサポートされるようにしました。
  • セグメント コレクションが、セッション レベルとユーザーレベルの組み込みとカスタムのセグメントをすべて返すようにしました。
  • セグメントの definition プロパティは、新しいセグメント構文を使用するようになります。これには、既存のセッション レベル セグメントが含まれ、definition: "" から definition: "sessions::condition::" に変更されます。
  • セグメントが CUSTOM（ウェブ インターフェースでユーザーが作成）か BUILT_IN（Google アナリティクスから提供）のどちらであるかを示す、新しい type プロパティがセグメント リソースに追加されました。

テスト

次の AdSense 指標を最適化の目標として使用できるようにしました。

  • ga:adsenseAdsClicks - サイトの AdSense 広告がクリックされた回数。
  • ga:adsenseAdsViewed - 表示された AdSense 広告の数。広告ユニット内に複数の広告を表示することができます。
  • ga:adsenseRevenue - AdSense 広告で得られた合計収益額。

新しいアカウント サマリ コレクション

  • AccountSummaries コレクションを Management API に追加しました。これにより、1 回の簡単なリクエストで、認証されたユーザーがアクセス権を持つ各アカウント、プロパティ、ビュー（旧プロファイル）の簡単な概要が提供されます。詳しくは、アカウントの概要に関するデベロッパー ガイドをご覧ください。

ga:isMobile と ga:isTablet のディメンションのサポートが終了したため、デフォルト セグメントに次の変更が加えられました。

  • セグメント gaid::-11 の名前を、モバイル トラフィックからモバイルとタブレットのトラフィックに変更しました。このセグメントの定義を ga:isMobile==Yes から ga:deviceCategory==mobile,ga:deviceCategory==tablet に変更しました。ga:isMobile にはタブレットのトラフィックが含まれており、新しい定義に反映されています。タブレットを除外してモバイルト ラフィックのみを使用する場合は、新しいモバイル トラフィック セグメント（gaid::-14）に切り替えます。
  • セグメント gaid::-13 定義が ga:isTablet==Yes から ga:deviceCategory==tablet に変更され、引き続きタブレット トラフィックを表しています。
  • セグメント gaid::-14 を追加しました。セグメント名はモバイル トラフィック、定義は ga:deviceCategory==mobile です。

バグの修正:

  • ビュー（旧プロファイル）のタイムゾーン情報を修正しました。詳細: 今回の修正の前は、Management API でのビュー（旧プロファイル）のリスト表示時に、ビュー（旧プロファイル）のタイムゾーンの不正確な情報が返されることがありました。ビュー（旧プロファイル）のタイムゾーン情報が、Google アナリティクスの管理画面で設定されたタイムゾーンと一致するようにしました。

今回のリリースでは、ウェブ プロパティ、ビュー（旧プロファイル）、目標リソース、ユーザー権限の管理を可能にする 3 つの新しいリソースの書き込み操作を導入しました。

アカウント設定と Configuration API

  • ビュー（旧プロファイル）の作成、更新、パッチ適用、および削除が可能になりました。新しいメソッドについて詳しくは、ビュー（旧プロファイル）のリソースをご覧ください。
  • ウェブ プロパティと目標の作成、更新、およびパッチ適用が可能になりました。新しいメソッドについて詳しくは、ウェブ プロパティのリファレンスと目標のリファレンス をご覧ください。
  • 1 つのウェブ プロパティ、ビュー（旧プロファイル）、または目標が、get メソッドでリクエストされるようにしました。
  • これらの機能は現在、限定ベータ版のデベロッパー プレビューとしてご利用いただけます。これらの機能の登録を希望される場合は、ベータ版へのアクセスをリクエストしてください。

Management API でのユーザー権限

新しいセグメント リリースの一部として、セグメント コレクションに次の変更が適用されます。

  • すべてのセグメント ID は、正の整数から英数字の文字列に変更されます。ユーザーのセグメント ID を保存している場合は、新しい ID を使用するように更新することをおすすめします。
  • セグメント コレクションは、既存の訪問レベル セグメントのみを返します。現時点では、新しいユーザー、コホート、シーケンス セグメントは、API ではサポートされていません。
  • セグメント コレクションでは、既存のデフォルトのセグメントが引き続き同じ負の数値 ID で返されますが、新しいデフォルトのセグメントは現在サポートされていません。

今回のリリースでは、ウェブ プロパティ リソースに 2 つの新しいプロパティを追加しました。

  • profileCount - プロパティのプロファイル数を返します。これにより、プロファイルがないプロパティ（profileCount = 0）をフィルタできます。
  • industryVertical - プロパティに対して選択された業種または業界カテゴリを返します。

バグの修正:

  • プロファイル リソースの eCommerceTracking プロパティを、ウェブ インターフェースの管理セクションの e コマース設定と一致するようにしました。e コマース トラッキングが有効な場合は true を返し、無効な場合は false を返します。
  • Webproperty リソースに、ウェブ プロパティが PREMIUM か STANDARD かを示す level プロパティが追加されました。
  • ウェブテスト リソースにアクセスして、修正するための新しいエンドポイントを Management API v3 に追加しました。
  • Profile リソースに、プロファイルの設定対象がウェブサイトかアプリかを示す type プロパティを追加しました。指定できる値は WEB または APP の 2 つです。

今回のリリースでは、Management API に役立つエラー レスポンスを追加しました。

  • 新しいエラーコード、理由、および説明を、API エラー レスポンスの本文に追加しました。すべてのコードは、Management API のバージョン 2.4 とバージョン 3.0 の両方でドキュメント化されています。

今回のリリースではデータを追加し、既存の機能を変更してバグを修正しました。

新しいデータ

  • アドバンス セグメント コレクションに、Data Export API のセグメント パラメータで使用できる segmentId フィールドを追加しました。

変更

  • max-results のデータタイプを integer に変更しました。

  • max-results のデフォルトの最大値を 1000 に変更しました。

バグの修正

  • Google ウェブサイト オプティマイザーのテスト用のアカウント、ウェブ プロパティ、プロファイルは、対応するコレクションに含まれなくなりました。

今回のリリースでは、API の 2 つの新しいバージョンを追加し、旧バージョンのサポートを終了しました。この変更は、API のデータのリクエストと処理に影響します。

バージョン 3.0

  • これは API の最新のメジャー バージョンで、下位互換性がありません。今後の API の開発はすべてこのバージョンで行われます。

  • 新しいデータ

    • イベント目標の完全な表現
    • Google アナリティクスの管理画面へのディープリンクの作成に使用できる内部ウェブ プロパティ ID
    • デフォルトのページとサイト内検索クエリ パラメータのプロファイル設定

  • 変更

    • 新しい割り当てポリシー。
    • Google API Console の統合。API アクセスを管理して割り当て量の増加をリクエストできるようにしました。
    • OAuth 2.0 のサポート。これは、ユーザー承認の新しい方法として推奨されます。
    • リクエストを行うための新しい URL: https://www.googleapis.com/analytics/v3/management/…。
    • JSON を使用した、よりコンパクトな API レスポンス。
    • さらに多くの言語に対応する、新しい Google API クライアント ライブラリ。
    • Google Discovery API のサポート。

バージョン 2.4

  • これは、マイナー バージョンのアップグレードで、既存のバージョン 2.3 との大部分で下位互換性があります。

  • 変更

    • 新しい割り当てポリシー。
    • Google API Console の統合。API アクセスを管理して割り当て量の増加をリクエストできるようにしました。
    • 既存の承認メカニズムと OAuth 2.0 の継続的なサポート。
    • リクエストを行うための新しい URL: https://www.googleapis.com/analytics/v2.4/management/…。
    • XML 内のレスポンスのみ。
    • Google Data JavaScript クライアント ライブラリのサポートなし。
    • XML 出力はバージョン 2.3 と整合性があるため、他の既存の Google データ クライアント ライブラリは引き続き動作します。

サポートの終了

  • Management API の以前のバージョン 2.3 のサポートを終了します。引き続き 2 か月間は使用できますが、それ以降は、すべての v2.3 リクエストは v2.4 レスポンスを返すようになります。

Google Analytics Management API のベータ版リリースです。

新しいフィード

更新されたクライアント ライブラリ

  • Management API は Google Analytics Data Export API と同じライブラリでリリースされています。Google Data Java と JavaScript の両方のライブラリを更新しました。各フィードにアクセスするには、getManagementFeed() メソッドのライブラリに対する適切なフィード URI を指定してください。

新しいドキュメント

  • Google アナリティクス デベロッパー ドキュメントに新しいセクションを作成し、新しい Management API の仕組みを説明しています。