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