Method: accountSummaries.list

呼び出し元がアクセスできるすべてのアカウントのサマリーを返します。

HTTP リクエスト

GET https://analyticsadmin.googleapis.com/v1beta/accountSummaries

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
pageSize

integer

返される AccountSummary リソースの最大数。追加のページがある場合でも、この値より少ない数が返されます。指定されていない場合は、最大で 50 個のリソースが返されます。最大値は 200 です(大きい値は最大値に強制変換されます)。

pageToken

string

前回の accountSummaries.list 呼び出しから受け取ったページトークン。これを指定して、後続のページを取得します。ページ分けするときは、accountSummaries.list に提供される他のすべてのパラメータが、ページトークンを提供した呼び出しと一致する必要があります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

accountSummaries.list RPC に対するレスポンス メッセージ。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現
{
  "accountSummaries": [
    {
      object (AccountSummary)
    }
  ],
  "nextPageToken": string
}
フィールド
accountSummaries[]

object (AccountSummary)

発信者がアクセスできるすべてのアカウントのアカウントの概要。

nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit

AccountSummary

アカウントとそのすべての子 GA4 プロパティの概要を表す仮想リソース。

JSON 表現
{
  "name": string,
  "account": string,
  "displayName": string,
  "propertySummaries": [
    {
      object (PropertySummary)
    }
  ]
}
フィールド
name

string

このアカウントの概要のリソース名。形式: accountSummaries/{account_id} 例: 「accountSummaries/1000」

account

string

このアカウント概要で参照されるアカウントのリソース名。形式: accounts/{account_id} 例: 「accounts/1000」

displayName

string

このアカウントの概要で参照されるアカウントの表示名。

propertySummaries[]

object (PropertySummary)

このアカウントの子アカウントの概要のリスト。

PropertySummary

GA4 プロパティのメタデータを表す仮想リソース。

JSON 表現
{
  "property": string,
  "displayName": string,
  "propertyType": enum (PropertyType),
  "parent": string
}
フィールド
property

string

このプロパティの概要で参照されるプロパティのリソース名。形式: properties/{property_id}。例: 「properties/1000」

displayName

string

このプロパティの概要で参照されるプロパティの表示名。

propertyType

enum (PropertyType)

プロパティのプロパティ タイプ。

parent

string

このプロパティの論理親のリソース名。

注: プロパティ移動 UI を使用して親を変更できます。形式: accounts/{account},properties/{property} 例: 「accounts/100」、「properties/200」