Method: properties.recurringAudienceLists.list

プロパティの繰り返しオーディエンス リストがすべて一覧表示されます。この方法を使用すると、繰り返し表示される不要なオーディエンス リストを新しく作成するのではなく、既存の繰り返しオーディエンス リストを見つけて再利用できます。同じオーディエンスに、複数の繰り返しオーディエンス リストを含め、異なるディメンションの組み合わせ(ディメンション deviceId のみ、またはディメンション deviceIduserId の両方)を表すことができます。

この方法は、ベータ版に入る前に構文や機能に関するフィードバックを収集する目的で、アルファ版(安定版)で導入されています。この API に関するフィードバックは、Google アナリティクス Audience Export API フィードバック フォームにご記入ください。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

必須。レスポンスには、このプロパティのすべての繰り返しオーディエンス リストが含まれます。形式: properties/{property}

クエリ パラメータ

パラメータ
pageSize

integer

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

pageToken

string

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

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

リクエスト本文

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

レスポンスの本文

プロパティの繰り返しオーディエンス リストのリスト。

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

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

object (RecurringAudienceList)

プロパティの繰り返しの各オーディエンス リスト。

nextPageToken

string

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

承認スコープ

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

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