Management API
これは、Management API バージョン 3.0 のリファレンス ガイドです。このガイドでは、Google アナリティクスの設定データ向けのクエリとレスポンスに関する詳細な情報を紹介します。コンセプトと構成データの構造については、バージョン 3.0 の 概要.
このガイドの各セクションでは、認証済みユーザーの設定データに含まれる 1 種類のエンティティに対するリクエスト メソッドとレスポンスを定義します。リクエストはすべて REST 形式で表示されます。各メソッドのページの最後にある「試してみる」リンクを使用して、API Explorer でインタラクティブにリクエストを試すことができます。
リソースタイプ
- アカウントの概要
- アカウント ユーザーリンク
- Accounts
- AdWords のリンク
- カスタム データソース
- カスタム ディメンション
- カスタム指標
- テスト
- フィルタ
- 目標
- クライアント ID
- プロファイル フィルタ リンク
- プロファイル ユーザーリンク
- リマーケティング オーディエンス
- セグメント
- 非サンプリング レポート
- アップロード
- ビュー(旧プロファイル)
- ウェブ プロパティ
- ウェブ プロパティ ユーザーリンク
アカウントの概要
アカウントの概要リソースの詳細については、リソース表現のページをご覧ください。
メソッド | HTTP リクエスト | 説明 |
---|---|---|
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。 | ||
list |
GET /management/accountSummaries
|
ユーザーがアクセスできるアカウントの概要(アカウント/プロパティ/プロファイルで構成される簡易ツリー)を一覧表示します。 |
アカウント ユーザーリンク
アカウント ユーザー リンク リソースの詳細については、リソース表現のページをご覧ください。
メソッド | 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
|
指定されたアカウントの既存のユーザーの権限を更新します。 |
Accounts
Accounts リソースについて詳しくは、リソース表現のページをご覧ください。
メソッド | HTTP リクエスト | 説明 |
---|---|---|
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。 | ||
list |
GET /management/accounts
|
ユーザーがアクセスできるすべてのアカウントを一覧表示します。 |
AdWords リンク
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/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 を基準とします。 | ||
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 を基準とします。 | ||
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/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
|
既存の目標を更新します。 |
クライアント ID
Management.clientId リソースについて詳しくは、リソース表現のページをご覧ください。
メソッド | HTTP リクエスト | 説明 |
---|---|---|
URI は、特に明記されていない限り、https://www.googleapis.com/analytics/v3 を基準とします。 | ||
hashClientId |
POST /management/clientId:hashClientId
|
指定されたクライアント ID をハッシュします。 |
プロファイル フィルタ リンク
プロファイル フィルタ リンク リソースの詳細については、リソース表現のページをご覧ください。
メソッド | 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
|
既存のプロファイル フィルタ リンクを更新します。 |
プロファイル ユーザーリンク
プロファイル ユーザー リンク リソースの詳細については、リソース表現のページをご覧ください。
メソッド | 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/remarketingAudiences/remarketingAudienceId
|
リマーケティング オーディエンスを削除します。 |
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
|
既存のリマーケティング オーディエンスを更新します。 |
セグメント
セグメント リソースの詳細については、リソース表現のページをご覧ください。
メソッド | 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/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/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
|
カスタム データソースのデータをアップロードします。 |
ビュー(旧プロファイル)
ビューリソースの詳細については、リソース表現のページをご覧ください。
メソッド | 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 を基準とします。 | ||
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/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
|
指定されたウェブ プロパティに対する既存のユーザーの権限を更新します。 |