Google マーケティング プラットフォーム Admin API を使用すると、Google マーケティング プラットフォームの設定データにプログラムでアクセスできます。Google マーケティング プラットフォーム Admin API を使用すると、Google マーケティング プラットフォームの組織と Google アナリティクス アカウント間のリンクを管理したり、GA4 プロパティのサービスレベルを設定したりできます。
- REST リソース: v1alpha.organizations
- REST リソース: v1alpha.organizations.adminAccessBindings
- REST リソース: v1alpha.organizations.analyticsAccountLinks
- REST リソース: v1alpha.organizations.userGroups
- REST リソース: v1alpha.organizations.userGroups.members
サービス: marketingplatformadmin.googleapis.com
このサービスを呼び出すには、Google が提供するクライアント ライブラリを使用することをおすすめします。アプリケーションで独自のライブラリを使用してこのサービスを呼び出す必要がある場合は、API リクエストの際に次の情報を使用してください。
ディスカバリ ドキュメント
ディスカバリ ドキュメントは、REST API を記述して使用するための機械で読み取り可能仕様です。クライアント ライブラリ、IDE プラグイン、Google API と連携するその他のツールのビルドに使用されます。1 つのサービスで複数のディスカバリ ドキュメントを提供できます。このサービスには、次のディスカバリ ドキュメントが用意されています。
サービス エンドポイント
サービス エンドポイントは、API サービスのネットワーク アドレスを指定するベース URL です。1 つのサービスに複数のサービス エンドポイントが存在することもあります。このサービスには次のサービス エンドポイントがあり、以下のすべての URI がこのサービス エンドポイントに関連しています。
https://marketingplatformadmin.googleapis.com
REST リソース: v1alpha.organizations
| メソッド | |
|---|---|
findSalesPartnerManagedClients |
POST /v1alpha/{organization=organizations/*}:findSalesPartnerManagedClients 販売パートナー組織が管理しているクライアントの一覧を返します。 |
get |
GET /v1alpha/{name=organizations/*} 単一の組織を検索します。 |
list |
GET /v1alpha/organizations ユーザーがアクセスできる組織のリストを返します。 |
reportPropertyUsage |
POST /v1alpha/{organization=organizations/*}:reportPropertyUsage 指定した月の組織内のプロパティの使用量と課金データを取得します。 |
REST リソース: v1alpha.organizations.adminAccessBindings
| メソッド | |
|---|---|
create |
POST /v1alpha/{parent=organizations/*}/adminAccessBindings 指定された GMP 組織に管理者アクセス バインディングを作成します。 |
get |
GET /v1alpha/{name=organizations/*/adminAccessBindings/*} 単一の管理者アクセス バインディングを検索します。 |
list |
GET /v1alpha/{parent=organizations/*}/adminAccessBindings 指定された GMP 組織の管理者アクセス バインディングのリストを返します。 |
patch |
PATCH /v1alpha/{adminAccessBinding.name=organizations/*/adminAccessBindings/*} 指定された GMP 組織の管理者アクセス バインディングを更新します。 |
REST リソース: v1alpha.organizations.analyticsAccountLinks
| メソッド | |
|---|---|
create |
POST /v1alpha/{parent=organizations/*}/analyticsAccountLinks アナリティクス アカウントと Google マーケティング プラットフォームの組織間のリンクを作成します。 |
delete |
DELETE /v1alpha/{name=organizations/*/analyticsAccountLinks/*} AnalyticsAccountLink を削除します。これにより、アナリティクス アカウントが Google マーケティング プラットフォームの組織から切り離されます。 |
list |
GET /v1alpha/{parent=organizations/*}/analyticsAccountLinks 指定された Google マーケティング プラットフォームの組織にリンクされている Google アナリティクス アカウントを一覧表示します。 |
setPropertyServiceLevel |
POST /v1alpha/{analyticsAccountLink=organizations/*/analyticsAccountLinks/*}:setPropertyServiceLevel アナリティクス プロパティのサービスレベルを更新します。 |
REST リソース: v1alpha.organizations.userGroups
| メソッド | |
|---|---|
create |
POST /v1alpha/{parent=organizations/*}/userGroups 指定された GMP 組織にユーザー グループを作成します。 |
delete |
DELETE /v1alpha/{name=organizations/*/userGroups/*} 指定された GMP 組織のユーザー グループを削除します。 |
get |
GET /v1alpha/{name=organizations/*/userGroups/*} 単一のユーザー グループを検索します。 |
list |
GET /v1alpha/{parent=organizations/*}/userGroups 指定された GMP 組織のユーザー グループのリストを返します。 |
patch |
PATCH /v1alpha/{userGroup.name=organizations/*/userGroups/*} 指定された GMP 組織のユーザー グループを更新します。 |
REST リソース: v1alpha.organizations.userGroups.members
| メソッド | |
|---|---|
create |
POST /v1alpha/{parent=organizations/*/userGroups/*}/members 指定された GMP ユーザー グループにメンバーを追加します。 |
delete |
DELETE /v1alpha/{name=organizations/*/userGroups/*/members/*} 指定された GMP ユーザー グループのメンバーを削除します。 |
get |
GET /v1alpha/{name=organizations/*/userGroups/*/members/*} 単一のユーザー グループ メンバーを検索します。 |
list |
GET /v1alpha/{parent=organizations/*/userGroups/*}/members 指定されたユーザー グループのメンバーのリストを返します。 |
patch |
PATCH /v1alpha/{userGroupMember.name=organizations/*/userGroups/*/members/*} 指定された GMP ユーザー グループのメンバーを更新します。 |