REST Resource: properties.recurringAudienceLists

リソース: RecurringAudienceList

オーディエンス リストが繰り返し作成されると、毎日新しいオーディエンス リストが生成されます。オーディエンス リストは、リストの作成時にオーディエンスに登録されていたユーザーです。繰り返しオーディエンス リストを使用すると、毎日使用できる最新データに基づいたオーディエンス リストを作成できます。

JSON 表現 
{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "audienceLists": [
    string
  ],
  "activeDaysRemaining": integer,
  "webhookNotification": {
    object (WebhookNotification)
  }
}
フィールド
name

string

出力専用。ID。作成時に割り当てられた定期的なオーディエンス リストのリソース名。このリソース名は RecurringAudienceList を識別します。

形式: properties/{property}/recurringAudienceLists/{recurringAudienceList}
audience

string

必須。オーディエンスのリソース名。このリソース名はリストされているオーディエンスを識別し、アナリティクス データとAdmin API

形式: properties/{property}/audiences/{audience}
audienceDisplayName

string

出力専用。このオーディエンスのわかりやすい表示名。例: 「購入者」。
dimensions[]

object (AudienceDimension)

必須。リクエストされ、オーディエンス リストのレスポンスに表示されるディメンション。
audienceLists[]

string

出力専用。この繰り返しオーディエンス リスト用に作成されたオーディエンス リスト インスタンスのオーディエンス リストのリソース名。オーディエンス リストは日ごとに 1 つずつ作成され、ここに表示されます。

このリストは、最近作成されたオーディエンス リストから順に表示されます。
activeDaysRemaining

integer

省略可。定期的なオーディエンスのエクスポートによってオーディエンス リストのインスタンスが作成される残りの日数。このカウンタは 1 日 1 ずつ減少し、ゼロになると新しいオーディエンス リストは作成されません。

アナリティクス 360 プロパティのオーディエンス リストの定期的なリクエストは、デフォルトで 180 日間、最長 365 日間に設定されます。標準のアナリティクス プロパティのリクエストは、デフォルトで 14 日間、最長 30 日間です。

作成時に指定できる最小値は 1 です。それぞれの最大値を超えるリクエストは、最大値に強制変換されます。
webhookNotification

object (WebhookNotification)

省略可。Google Analytics Data API から Webhook サーバーに送信される Webhook 通知を構成します。Webhook の使用は任意です。未使用の場合は、この API をポーリングして、繰り返しオーディエンス リストで新しいオーディエンス リストが作成されるタイミングを確認する必要があります。Webhook を使用すると、サーバーに通知を送信したり、ポーリングが不要になります。

定期的なオーディエンス リストでオーディエンス リストが作成されるたびに、2 つの POST リクエストが送信されます。これは、繰り返しオーディエンス リストのアクティブ日数が残り 0 日になるまで 1 日に 1 回行われます。最初のリクエストが送信され、新たに作成されたオーディエンス リストが作成中の状態で表示されます。2 番目のリクエストは、オーディエンス リストの作成が完了した後（ACTIVE または FAILED の状態）に送信されます。

メソッド

create

 定期的なオーディエンス リストを作成します。

get

 特定の定期的なオーディエンス リストに関する構成メタデータを取得します。

list

 プロパティのすべての定期的なオーディエンス リストを一覧表示します。