Method: properties.list

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

呼び出し元にアクセス権がない場合、プロパティは除外されます。削除済み（復元可能）（「ゴミ箱に移動済み」）の宿泊施設は、デフォルトで除外されます。関連するプロパティが見つからない場合は、空のリストが返されます。

HTTP リクエスト

GET https://analyticsadmin.googleapis.com/v1alpha/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