リソース: AudienceExport
オーディエンスのエクスポートとは、リストの作成時にオーディエンスに含まれるユーザーのリストです。1 つのオーディエンスで、異なる日付に複数のオーディエンスのエクスポートが作成される場合があります。
JSON 表現 |
---|
{ "name": string, "audience": string, "audienceDisplayName": string, "dimensions": [ { object ( |
フィールド | |
---|---|
name |
出力専用。ID。作成時に割り当てられたオーディエンス エクスポートのリソース名。このリソース名によってこの 形式: |
audience |
必須。オーディエンスのリソース名。このリソース名は一覧表示されるオーディエンスを識別し、Analytics Data & Admin API 間で共有されます。 形式: |
audienceDisplayName |
出力専用。このオーディエンスのわかりやすい表示名。例: 「購入者」。 |
dimensions[] |
必須。リクエストされ、クエリ レスポンスに表示されるディメンション。 |
creationQuotaTokensCharged |
出力専用。AudienceExport の作成時に課金された合計トークン割り当て量。このトークン数は |
state |
出力専用。この AudienceExport の現在のステータス。 |
beginCreatingTime |
出力専用。AudienceExports.create が呼び出され、AudienceExport が RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
rowCount |
出力専用。AudienceExport の結果の行の合計数。 |
errorMessage |
出力専用。作成中にオーディエンスのエクスポートに失敗した場合、エラー メッセージが入力されます。このような失敗の一般的な理由は、割り当ての枯渇です。 |
percentageCompleted |
出力専用。このオーディエンスのエクスポートの完了率(0 ~ 100)。 |
AudienceDimension
オーディエンス ディメンションはユーザー属性です。特定のユーザー属性がリクエストされ、その後 QueryAudienceExportResponse
で返されます。
JSON 表現 |
---|
{ "dimensionName": string } |
フィールド | |
---|---|
dimensionName |
省略可。ディメンションの API 名。ディメンション名の一覧については、API ディメンションをご覧ください。 |
状態
AudienceExport は現在この状態で存在します。
列挙型 | |
---|---|
STATE_UNSPECIFIED |
未指定の状態は使用されません。 |
CREATING |
AudienceExport は現在作成中で、今後利用可能になる予定です。作成は、audienceExports.create 呼び出しの直後に行われます。 |
ACTIVE |
AudienceExport が完全に作成され、クエリを行う準備が整いました。AudienceExport はリクエストとは非同期にアクティブに更新されます。これは、最初の create 呼び出しからしばらく後(たとえば 15 分後)に行われます。 |
FAILED |
AudienceExport を作成できませんでした。このオーディエンスのエクスポートの再リクエストは成功する可能性があります。 |
Methods |
|
---|---|
|
後で取得できるように、オーディエンスのエクスポートを作成します。 |
|
特定のオーディエンスのエクスポートに関する設定メタデータを取得します。 |
|
プロパティのすべてのオーディエンスのエクスポートを一覧表示します。 |
|
ユーザーのオーディエンス エクスポートを取得します。 |