REST Resource: properties.recurringAudienceLists

{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "audienceLists": [
    string
  ],
  "activeDaysRemaining": integer,
  "webhookNotification": {
    object (WebhookNotification)
  }
}

string

出力専用。ID。作成時に割り当てられる、繰り返しオーディエンス リストのリソース名。このリソース名によってこの RecurringAudienceList が識別されます。

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

string

必須。オーディエンスのリソース名。このリソース名は一覧表示されるオーディエンスを識別し、Analytics Data & Admin API 間で共有されます。

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

string

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

object (AudienceDimension)

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

string

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

このリストは、作成したオーディエンス リストが新しい順に表示されます。

integer

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

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

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

object (WebhookNotification)

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

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