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

必須。オーディエンス リソース名。このリソース名は、リストに登録されているユーザーを識別し、アナリティクス データ API と管理 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 アナリティクス Data API から Webhook サーバーに送信される Webhook 通知を構成します。Webhook の使用は任意です。使用されていない場合は、この API をポーリングして、オーディエンス リストを使用できるタイミングを判断する必要があります。Webhook を使用すると、サーバーに通知を送信できるため、ポーリングを行う必要がなくなります。

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

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

州

AudienceList は現在この状態です。

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

メソッド

create

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

get

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

list

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

query

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