Method: properties.recurringAudienceLists.list

プロパティのすべての定期的なオーディエンス リストを一覧表示します。この方法を使用すると、不必要な繰り返しオーディエンス リストを新たに作成せずに、既存の定期的なオーディエンス リストを見つけて再利用できます。同じオーディエンスに、異なるディメンションの組み合わせを表す複数の定期的なオーディエンス リストを作成できます。たとえば、ディメンション deviceId のみ、またはディメンション deviceId と userId の両方を指定できます。

この方法は、ベータ版に入る前に構文や機能に関するフィードバックを収集する目的で、アルファ版（安定版）で導入されています。この 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