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

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

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

string

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

object (AudienceDimension)

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

string

出力専用。この定期的なオーディエンス リスト用に作成されたオーディエンス リスト インスタンスのオーディエンス リストのリソース名。1 日ごとに 1 つのオーディエンス リストが作成され、そのオーディエンス リストがここに表示されます。

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

integer

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

アナリティクス 360 プロパティの定期的なオーディエンス リスト リクエストは、デフォルトで 180 日間、最大 365 日間です。通常版のアナリティクス プロパティのリクエストは、デフォルトで 14 日間、最大 30 日間です。

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

object (WebhookNotification)

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

定期的なオーディエンス リストがオーディエンス リストを作成するたびに、2 件の POST リクエストが送信されます。有効な残り日数が 0 になるまで、1 日に 1 回実行されます。最初のリクエストは、新しく作成されたオーディエンス リストが CREATING ステータスであることを示すリクエストです。2 つ目のリクエストは、オーディエンス リストの作成が完了した後（ACTIVE または FAILED のいずれかの状態）に送信されます。

メソッド

create

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

get

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

list

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