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

必須。オーディエンス リソース名。このリソース名は、リストに表示されるオーディエンスを識別し、Google アナリティクス データ 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 状態になった時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
rowCount

integer

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

string

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

number

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

string

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

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

object (WebhookNotification)

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

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

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

状態

AudienceList は現在この状態にあります。

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

メソッド

create

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

get

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

list

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

query

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