REST Resource: properties.audienceLists

{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "rowCount": integer,
  "errorMessage": string,
  "percentageCompleted": number,
  "recurringAudienceList": string,
  "webhookNotification": {
    object (WebhookNotification)
  }
}

string

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

形式: properties/{property}/audienceLists/{audienceList}

string

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

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

string

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

object (AudienceDimension)

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

integer

出力専用。AudienceList の作成時に課金された合計トークン割り当て量。このトークン数は CREATING 状態からのアクティビティに基づいているため、AudienceList が ACTIVE 状態または FAILED 状態になると、このトークンが請求されます。

enum (State)

出力専用。この AudienceList の現在のステータス。

string (Timestamp format)

出力専用。AudienceLists.create が呼び出され、AudienceList が CREATING 状態を開始した時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

integer

出力専用。AudienceList の結果の総行数。

string

出力専用。オーディエンス リストの作成中にエラーが発生すると、エラー メッセージが入力されます。このような失敗の一般的な理由は、割り当ての枯渇です。

number

出力専用。このオーディエンスのエクスポートの完了率（0 ～ 100）。

string

出力専用。このオーディエンス リストを作成した繰り返しオーディエンス リスト。繰り返しオーディエンス リストとは、オーディエンス リストを毎日作成するものです。

オーディエンス リストを直接作成した場合、繰り返しのオーディエンス リストは関連付けられず、このフィールドは空白になります。

object (WebhookNotification)

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

1 つまたは 2 つの POST リクエストが Webhook に送信されます。最初の POST リクエストはすぐに送信され、新しく作成されたオーディエンス リストが「作成中」ステータスで表示されます。2 番目の POST リクエストは、オーディエンス リストの作成の完了後（ACTIVE または FAILED 状態）に送信されます。

同じオーディエンス リストが続けてリクエストされた場合は、2 つ目以降のオーディエンス リストはキャッシュから配信されます。この場合、オーディエンス リストの作成メソッドは、オーディエンス リストがすでに ACTIVE であることを返します。このシナリオでは、1 つの POST リクエストのみが Webhook に送信されます。