REST Resource: properties.audienceLists

リソース: AudienceList

オーディエンス リストとは、リスト作成時のオーディエンスに含まれるユーザーのリストです。1 つのオーディエンスに対して、異なる日付用に複数のオーディエンス リストを作成することもできます。

JSON 表現 
{
  "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)
  }
}
フィールド
name

string

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

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

string

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

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

string

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

object (AudienceDimension)

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

integer

出力専用。AudienceList の作成時に課金されるクォータ トークンの合計。このトークン数は CREATING 状態のアクティビティに基づくため、AudienceList が ACTIVE 状態または FAILED 状態になると、このトークンの課金は確定します。
state

enum (State)

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

string (Timestamp format)

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

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

integer

出力専用。AudienceList の結果の行の合計数。
errorMessage

string

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

number

出力専用。このオーディエンスのエクスポートが完了した割合（0 ～ 100）。
recurringAudienceList

string

出力専用。このオーディエンス リストを作成した定期的なオーディエンス リスト。繰り返しオーディエンス リストは、オーディエンス リストを毎日作成します。

オーディエンス リストを直接作成する場合、関連付けられた定期的なオーディエンス リストはなく、このフィールドは空白になります。
webhookNotification

object (WebhookNotification)

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

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

同一のオーディエンス リストが連続してリクエストされた場合、2 番目のリストと後続のオーディエンス リストはキャッシュから配信できます。その場合は、オーディエンス リストの作成メソッドで、すでに有効なオーディエンス リストを返すことができます。このシナリオでは、1 つの POST リクエストのみが Webhook に送信されます。

州

AudienceList は現在、この状態で存在します。

列挙型
STATE_UNSPECIFIED 未指定の状態は使用されません。
CREATING AudienceList は現在作成中で、今後利用できるようになります。作成は、audienceLists.create 呼び出しの直後に行われます。
ACTIVE AudienceList が作成され、クエリの準備が整いました。AudienceList が、リクエストから非同期にアクティブに更新される。最初の create 呼び出しからしばらく（たとえば 15 分）後に発生します。
FAILED AudienceList を作成できませんでした。このオーディエンス リストを再度リクエストしても成功する可能性があります。

メソッド

create

 後で取得できるようにオーディエンス リストを作成します。

exportSheet

 ユーザーのオーディエンス リストを Google スプレッドシートにエクスポートします。

get

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

list

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

query

 ユーザーのオーディエンス リストを取得します。