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

必須。オーディエンス リソース名。このリソース名は、リストに表示されるオーディエンスを識別するもので、Analytics Data API と 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 アナリティクス 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

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

exportSheet

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

get

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

list

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

query

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