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

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

boolean

削除（復元可能）したプロパティを検索結果に含めるかどうか。プロパティは、削除の有無を検査できます。

リクエスト本文

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

レスポンスの本文

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

ListProperties 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