Method: properties.audienceLists.list

プロパティのすべてのオーディエンス リストを一覧表示します。この方法を使用すると、不要な新しいオーディエンス リストを作成するのではなく、既存のオーディエンス リストを見つけて再利用できます。同じオーディエンスに、異なる日にオーディエンスに含まれていたユーザーのリストを表す複数のオーディエンス リストを設定できます。

オーディエンス リストの概要と例については、オーディエンス リストを作成するをご覧ください。

このメソッドは、audienceExports.list でベータ版（安定版）で利用できます。この API に関するフィードバックをお寄せいただくには、Google Analytics Audience Export API のフィードバック フォームにご記入ください。

HTTP リクエスト

GET https://analyticsdata.googleapis.com/v1alpha/{parent=properties/*}/audienceLists

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

パスパラメータ

パラメータ
parent

string

必須。このプロパティのすべてのオーディエンス リストがレスポンスに一覧表示されます。形式: properties/{property}

クエリ パラメータ

パラメータ
pageSize

integer

省略可。返されるオーディエンス リストの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合は、最大で 200 個のオーディエンス リストが返されます。最大値は 1,000 です（それより大きい値は最大値に強制変換されます）。
pageToken

string

省略可。前回の audienceLists.list 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

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

リクエストの本文

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

レスポンスの本文

プロパティのすべてのオーディエンス リストのリスト。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

object (AudienceList)

プロパティの各オーディエンス リスト。
nextPageToken

string

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

認可スコープ

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

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