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

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

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

string

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

account

string

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

displayName

string

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

propertySummaries[]

object (PropertySummary)

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

PropertySummary

Google アナリティクスのプロパティのメタデータを表す仮想リソース。

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」