Method: properties.audiences.list

プロパティのオーディエンスを一覧表示します。2020 年より前に作成されたオーディエンスはサポートされていない場合があります。デフォルトのオーディエンスにフィルタの定義は表示されません。

HTTP リクエスト

GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/audiences

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

パスパラメータ

パラメータ
parent

string

必須。形式例: properties/1234

クエリ パラメータ

パラメータ
pageSize

integer

返されるリソースの最大数。指定されていない場合は、最大で 50 個のリソースが返されます。最大値は 200 です(それより大きい値は最大値に強制変換されます)。

pageToken

string

前回の audiences.list 呼び出しから受け取ったページトークン。これを指定して、後続のページを取得します。

ページ分割を行う場合、audiences.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

リクエストの本文

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

レスポンスの本文

Audience.list RPC に対するレスポンス メッセージ。

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

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

object (Audience)

オーディエンスのリスト。

nextPageToken

string

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

認可スコープ

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

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