このドキュメントでは、Core Reporting API と Metadata API における データのサポート終了ポリシーについて説明します。
概要
ディメンションと指標(列)は、Google アナリティクス Reporting API へのクエリに使用します。これらの列の追加、削除、名前の変更が必要になることがあります。データのサポートの終了に関するポリシーは、このような列の変更についての透明性を高める目的で提供しています。
列の変更はすべて、変更履歴を通じて公表され、Metadata API は、それらの変更を反映して自動的に更新されます。
このポリシーの対象範囲
このポリシーは、公開 API で公開されるディメンションと指標を対象としています。API リクエスト(クエリ パラメータ)、API レスポンス、API によって返される値、ディメンションと指標の有効な組み合わせについては説明しません。
新しいデータ
新しい列が API に追加された場合:
- 該当する API の変更履歴が新しい列の詳細情報を伴って更新されます。
- 新しい列が Metadata API で利用できるようになります。
データの削除
列が API から削除される場合:
- 該当する API の変更履歴が削除される列の詳細情報を伴って更新されます。
- Metadata API では、
status
列の属性はDEPRECATED
に設定されます。 - 削除される列は、最低 6 か月間、Reporting API のクエリで引き続き利用できます。
- 6 か月を過ぎると、該当する列は Metadata API から削除され、Reporting API で該当列を検索すると
400 Bad Request
エラーが発生します。
データ名の変更
列の名前が変更される場合
- 該当する API の変更履歴が変更前と変更後の列の詳細情報を伴って更新されます。
- Metadata API
では、元の列の
status
属性がDEPRECATED
に設定され、replacedBy
属性が置換列の ID に設定されます。 - 変更前の列は、最低 6 か月間、Reporting API のクエリで引き続き利用できます。
- 6 か月を過ぎると、元の列は Metadata API から削除され、Reporting API でその列を検索すると
400 Bad Request
エラーが発生します。
属性の削除
属性が Metadata API から削除される場合:
- Metadata API の変更履歴が、削除される属性の詳細情報を伴って更新されます。
- 削除される属性は、最低 6 か月間、Metadata API で引き続き利用できます。
- 6 か月を過ぎると、属性は Metadata API から削除されます。
グループ
場合により、グループの名前または列の順序の変更が必要になります。こうした変更があった場合:
- Metadata API の変更履歴が更新され、グループ名や順序の変更点も記載されます。