Method: properties.list

指定した親アカウントの子プロパティを返します。

「GA4」プロパティのみが返されます。呼び出し元にアクセス権がない場合、プロパティは除外されます。ソフト削除(つまり「ゴミ箱」プロパティ)は、デフォルトで除外されています。関連するプロパティが見つからない場合は空のリストを返します。

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
filter

string

必須。リクエストの結果をフィルタリングする式。フィルタリングの対象となるフィールドは、parent:(親アカウント/プロパティのリソース名)または ancestor:(親アカウントのリソース名)または firebase_project:(リンクされた Firebase プロジェクトの ID または番号)です。フィルタの例を次に示します。

| Filter                      | Description                               |
|-----------------------------|-------------------------------------------|
| parent:accounts/123         | The account with account id: 123.       |
| parent:properties/123       | The property with property id: 123.       |
| ancestor:accounts/123       | The account with account id: 123.         |
| firebase_project:project-id | The firebase project with id: project-id. |
| firebase_project:123        | The firebase project with number: 123.    |
pageSize

integer

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

pageToken

string

前回の properties.list 呼び出しから受け取ったページトークン。次のページを取得するために指定します。ページ分けを行う際は、properties.list に指定するすべてのパラメータとページトークンを渡した呼び出しが一致する必要があります。

showDeleted

boolean

ソフト削除済みのプロパティ(「ゴミ箱」プロパティ)を結果に含めるかどうか。プロパティは、削除済みかどうかを検査できます。

リクエスト本文

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

レスポンスの本文

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

properties.list RPC のレスポンス メッセージ。

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

object (Property)

フィルタ条件に一致する、呼び出し元がアクセスできる結果。

nextPageToken

string

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

認可スコープ

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

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