リソース: AudienceList
オーディエンス リストとは、リストの作成時にオーディエンスに含まれるユーザーのリストです。1 つのオーディエンスで、曜日ごとに複数のオーディエンス リストが作成されている場合もあります。
JSON 表現 |
---|
{ "name": string, "audience": string, "audienceDisplayName": string, "dimensions": [ { object ( |
フィールド | |
---|---|
name |
出力専用。ID。作成時に割り当てられたオーディエンス リストのリソース名。このリソース名によってこの 形式: |
audience |
必須。オーディエンスのリソース名。このリソース名は一覧表示されるオーディエンスを識別し、Analytics Data & Admin API 間で共有されます。 形式: |
audienceDisplayName |
出力専用。このオーディエンスのわかりやすい表示名。例: 「購入者」。 |
dimensions[] |
必須。リクエストされ、クエリ レスポンスに表示されるディメンション。 |
creationQuotaTokensCharged |
出力専用。AudienceList の作成時に課金された合計トークン割り当て量。このトークン数は |
state |
出力専用。この AudienceList の現在のステータス。 |
beginCreatingTime |
出力専用。AudienceLists.create が呼び出され、AudienceList が RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
rowCount |
出力専用。AudienceList の結果の総行数。 |
errorMessage |
出力専用。オーディエンス リストの作成中にエラーが発生すると、エラー メッセージが入力されます。このような失敗の一般的な理由は、割り当ての枯渇です。 |
percentageCompleted |
出力専用。このオーディエンスのエクスポートの完了率(0 ~ 100)。 |
recurringAudienceList |
出力専用。このオーディエンス リストを作成した繰り返しオーディエンス リスト。繰り返しオーディエンス リストとは、オーディエンス リストを毎日作成するものです。 オーディエンス リストを直接作成した場合、繰り返しのオーディエンス リストは関連付けられず、このフィールドは空白になります。 |
webhookNotification |
省略可。Google Analytics Data API から Webhook サーバーに送信される Webhook 通知を構成します。Webhook の使用は任意です。使用しない場合は、この API をポーリングして、オーディエンス リストが使用できる状態かどうかを判断する必要があります。Webhook を使用すると、サーバーに通知を送信できるため、ポーリングが不要になります。 1 つまたは 2 つの POST リクエストが Webhook に送信されます。最初の POST リクエストはすぐに送信され、新しく作成されたオーディエンス リストが「作成中」ステータスで表示されます。2 番目の POST リクエストは、オーディエンス リストの作成の完了後(ACTIVE または FAILED 状態)に送信されます。 同じオーディエンス リストが続けてリクエストされた場合は、2 つ目以降のオーディエンス リストはキャッシュから配信されます。この場合、オーディエンス リストの作成メソッドは、オーディエンス リストがすでに ACTIVE であることを返します。このシナリオでは、1 つの POST リクエストのみが Webhook に送信されます。 |
状態
AudienceList は現在、この状態で存在します。
列挙型 | |
---|---|
STATE_UNSPECIFIED |
未指定の状態は使用されません。 |
CREATING |
AudienceList は現在作成中で、今後利用可能になる予定です。AudienceLists.create 呼び出しの直後に作成が行われます。 |
ACTIVE |
AudienceList が完全に作成され、クエリを行う準備が整いました。AudienceList は、リクエストとは非同期にアクティブに更新されます。これは、最初の create 呼び出しからしばらく後(たとえば 15 分後)に行われます。 |
FAILED |
AudienceList を作成できませんでした。このオーディエンス リストの再リクエストは成功する可能性があります。 |
Methods |
|
---|---|
|
後で取得できるようにオーディエンス リストを作成します。 |
|
ユーザーのオーディエンス リストを Google スプレッドシートにエクスポートします。 |
|
特定のオーディエンス リストに関する設定メタデータを取得します。 |
|
プロパティのすべてのオーディエンス リストを一覧表示します。 |
|
ユーザーのオーディエンス リストを取得します。 |