API リファレンス

これは、Management API バージョン 3.0 のリファレンス ガイドです。このガイドでは、Google アナリティクスの設定データ向けのクエリとレスポンスに関する詳細な情報を紹介します。概念と設定データの構造については、Management API バージョン 3.0 の概要をご覧ください

このガイドの各セクションでは、認証されたユーザーの設定データに関する 1 種類のエンティティのリクエスト メソッドとレスポンスを定義します。リクエストはすべて REST 形式で表示されます。各メソッドのページの最後にある「試してみる」リンクを使って APIs Explorer でインタラクティブにリクエストを試すことができます。

リソースタイプ

  1. アカウントの概要
  2. アカウント
  3. ウェブ プロパティ
  4. ビュー(旧プロファイル)
  5. フィルタ
  6. 目標
  7. セグメント
  8. アカウント ユーザー リンク
  9. ウェブ プロパティ ユーザー リンク
  10. プロファイル ユーザー リンク
  11. プロファイル フィルタ リンク
  12. AdWords リンク
  13. カスタム データソース
  14. カスタム指標
  15. カスタム ディメンション
  16. アップロード
  17. ウェブテスト
  18. 非サンプリング レポート
  19. リマーケティング ユーザーリスト

アカウントの概要

アカウントの概要リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。
list GET  /management/accountSummaries アカウントの概要(ユーザーがアクセスできるアカウント / プロパティ / プロファイルからなる簡易ツリー構造)を一覧表示します。

アカウント

アカウント リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。
list GET  /management/accounts ユーザーがアクセスできるすべてのアカウントを一覧表示します。

ウェブ プロパティ

ウェブ プロパティ リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。
get GET  /management/accounts/accountId/webproperties/webPropertyId ユーザーがアクセスできるプロパティを取得します。
insert POST  /management/accounts/accountId/webproperties 新しいプロパティを作成します。
list GET  /management/accounts/accountId/webproperties ユーザーがアクセスできるプロパティを一覧表示します。
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId 既存のプロパティを更新します。このメソッドはパッチの動作をサポートしています。
update PUT  /management/accounts/accountId/webproperties/webPropertyId 既存のプロパティを更新します。

ビュー(旧プロファイル)

ビューリソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId ビューを削除します。
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId ユーザーがアクセスできるビューを取得します。
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles 新しいビューを作成します。
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles ユーザーがアクセスできるビューを一覧表示します。
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId 既存のビューを更新します。このメソッドはパッチの動作をサポートしています。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId 既存のビューを更新します。

フィルタ

フィルタ リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。
delete DELETE  /management/accounts/accountId/filters/filterId フィルタを削除します。
get GET  /management/accounts/accountId/filters/filterId ユーザーがアクセスできるフィルタを返します。
insert POST  /management/accounts/accountId/filters 新しいフィルタを作成します。
list GET  /management/accounts/accountId/filters アカウントのすべてのフィルタを一覧表示します。
patch PATCH  /management/accounts/accountId/filters/filterId 既存のフィルタを更新します。このメソッドはパッチの動作をサポートしています。
update PUT  /management/accounts/accountId/filters/filterId 既存のフィルタを更新します。

目標

目標リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals/goalId ユーザーがアクセスできる目標を取得します。
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals 新しい目標を作成します。
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals ユーザーがアクセスできる目標を一覧表示します。
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals/goalId 既存のビューを更新します。このメソッドはパッチの動作をサポートしています。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals/goalId 既存のビューを更新します。

セグメント

セグメント リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。
list GET  /management/segments ユーザーがアクセスできるセグメントを一覧表示します。

アカウント ユーザー リンク リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。
delete DELETE  /management/accounts/accountId/entityUserLinks/linkId 指定されたアカウントからユーザーを削除します。
insert POST  /management/accounts/accountId/entityUserLinks ユーザーのアカウントが 100 個よりも少ない場合に、指定されたアカウントに新しいユーザーを追加します。
list GET  /management/accounts/accountId/entityUserLinks 指定されたアカウントのアカウント ユーザー·リンクを一覧表示します。
update PUT  /management/accounts/accountId/entityUserLinks/linkId 指定されたアカウントで既存のユーザーの権限を更新します。

ウェブ プロパティ ユーザー リンク リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks/linkId 指定されたウェブ プロパティからユーザーを削除します。
insert POST  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks 指定されたウェブ プロパティに新しいユーザーを追加します。
list GET  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks 指定されたウェブ プロパティのアカウント ユーザー·リンクを一覧表示します。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks/linkId 指定されたウェブ プロパティで既存のユーザーの権限を更新します。

プロファイル ユーザー リンク リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks/linkId 指定されたビューからユーザーを削除します。
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks 指定されたビューに新しいユーザーを追加します。
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks 指定されたビューのプロファイル ユーザー·リンクを一覧表示します。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks/linkId 指定されたビューで既存のユーザーの権限を更新します。

プロファイル フィルタ リンク リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId プロファイル フィルタ リンクを削除します。
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId プロファイル フィルタ リンクを 1 つ返します。
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks 新しいプロファイル フィルタ·リンクを作成します。
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks プロファイルのプロファイル フィルタ·リンクを一覧表示します。
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId 既存のプロファイル フィルタ リンクを更新します。このメソッドはパッチの動作をサポートしています。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId 既存のプロファイル フィルタ リンクを更新します。

AdWords リンク リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks/webPropertyAdWordsLinkId ウェブ プロパティと AdWords のリンクを削除します。
get GET  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks/webPropertyAdWordsLinkId ユーザーがアクセスできるウェブ プロパティと AdWords のリンクを返します。
insert POST  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks ウェブ プロパティと AdWords のリンクを作成します。
list GET  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks 指定されたウェブ プロパティの、ウェブ プロパティと AdWords のリンクを一覧表示します。
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks/webPropertyAdWordsLinkId 既存のウェブ プロパティと AdWords のリンクを更新します。このメソッドはパッチの動作をサポートしています。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks/webPropertyAdWordsLinkId 既存のウェブ プロパティと AdWords のリンクを更新します。

カスタム データソース

カスタム データソース リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。
list GET  /management/accounts/accountId/webproperties/webPropertyId/customDataSources ユーザーがアクセスできるカスタム データソースを一覧表示します。

カスタム指標

カスタム指標リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。
get GET  /management/accounts/accountId/webproperties/webPropertyId/customMetrics/customMetricId ユーザーがアクセスできるカスタム指標を取得します。
insert POST  /management/accounts/accountId/webproperties/webPropertyId/customMetrics 新しいカスタム指標を作成します。
list GET  /management/accounts/accountId/webproperties/webPropertyId/customMetrics ユーザーがアクセスできるカスタム指標を一覧にます。
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/customMetrics/customMetricId 既存のカスタム指標を更新します。このメソッドはパッチの動作をサポートしています。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/customMetrics/customMetricId 既存のカスタム指標を更新します。

カスタム ディメンション

カスタム ディメンション リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。
get GET  /management/accounts/accountId/webproperties/webPropertyId/customDimensions/customDimensionId ユーザーがアクセスできるなカスタム ディメンションを取得します。
insert POST  /management/accounts/accountId/webproperties/webPropertyId/customDimensions 新しいカスタム ディメンションを作成します。
list GET  /management/accounts/accountId/webproperties/webPropertyId/customDimensions ユーザーがアクセスできるカスタム ディメンションを一覧にします。
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/customDimensions/customDimensionId 既存のカスタム ディメンションを更新します。このメソッドはパッチの動作をサポートしています。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/customDimensions/customDimensionId 既存のカスタム ディメンションを更新します。

アップロード

アップロード リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。
deleteUploadData POST  /management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/deleteUploadData 前のアップロードに関連付けられているデータを削除します。
get GET  /management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/uploads/uploadId ユーザーがアクセスできるアップロードを取得します。
list GET  /management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/uploads ユーザーがアクセスできるアップロードを取得します。
uploadData POST
https://www.googleapis.com/upload/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/uploads
カスタム データソースのデータをアップロードします。

ウェブテスト

ウェブテスト リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId ウェブテストを削除します。
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId ユーザーがアクセスできるウェブテストを返します。
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments 新しいウェブテストを作成します。
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments ユーザーがアクセスできるウェブテストを一覧表示します。
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId 既存のウェブテストを更新します。 このメソッドはパッチの動作をサポートしています。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId 既存のウェブテストを更新します。

非サンプリング レポート

非サンプリング レポート リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports/unsampledReportId 非サンプリング レポートを削除します。
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports/unsampledReportId 非サンプリング レポートを 1 つ返します。
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports 新しい非サンプリング レポートを作成します。
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports ユーザーがアクセスできる非サンプリング レポートを一覧表示します。

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

リマーケティング ユーザーリスト リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
URI は特に明記されていない限り、https://www.googleapis.com/analytics/v3alpha を基準とします。
get GET  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId ユーザーがアクセスできるリマーケティング ユーザーリストを取得します。
insert POST  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences 新しいリマーケティング ユーザーリストを作成します。
list GET  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences ユーザーがアクセスできるリマーケティング ユーザーリストを一覧表示します。
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId 既存のリマーケティング ユーザーリストを更新します。このメソッドはパッチの動作をサポートしています。
update PUT  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId 既存のリマーケティング ユーザーリストを更新します。