REST Resource: properties.audienceExports

リソース: AudienceExport

オーディエンスのエクスポートは、リストの作成時にオーディエンスに含まれていたユーザーのリストです。1 つのオーディエンスで、異なる日付に複数のオーディエンスのエクスポートが作成されることがあります。

JSON 表現
{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "rowCount": integer,
  "errorMessage": string,
  "percentageCompleted": number
}
フィールド
name

string

出力のみ。ID。作成時に割り当てられたオーディエンス エクスポートのリソース名。このリソース名によってこの AudienceExport が識別されます。

形式: properties/{property}/audienceExports/{audienceExport}

audience

string

必須。オーディエンスのリソース名。このリソース名は一覧表示するオーディエンスを識別し、アナリティクスのデータと Admin API で共有されます。

形式: properties/{property}/audiences/{audience}

audienceDisplayName

string

出力のみ。このオーディエンスのわかりやすい表示名。例: 「購入者」。

dimensions[]

object (AudienceDimension)

必須。リクエストされ、クエリ レスポンスに表示されるディメンション。

creationQuotaTokensCharged

integer

出力のみ。AudienceExport の作成時に課金された合計トークン割り当て量。このトークン数は CREATING 状態からのアクティビティに基づいているため、AudienceExport が ACTIVE 状態または FAILED 状態になると、このトークンの課金は固定されます。

state

enum (State)

出力のみ。この AudienceExport の現在のステータス。

beginCreatingTime

string (Timestamp format)

出力のみ。AudienceExports.create が呼び出され、AudienceExport が CREATING 状態を開始した時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

rowCount

integer

出力のみ。AudienceExport の結果の合計行数。

errorMessage

string

出力のみ。作成中にオーディエンスのエクスポートに失敗すると、エラー メッセージが入力されます。このようなエラーの一般的な理由は、割り当ての枯渇です。

percentageCompleted

number

出力のみ。このオーディエンスのエクスポートの完了率(0 ~ 100)。

AudienceDimension

オーディエンス ディメンションはユーザー属性です。特定のユーザー属性がリクエストされ、その後 QueryAudienceExportResponse で返されます。

JSON 表現
{
  "dimensionName": string
}
フィールド
dimensionName

string

(省略可)ディメンションの API 名。ディメンション名のリストについては、API ディメンションをご覧ください。

状態

AudienceExport は現在この状態で存在します。

列挙型
STATE_UNSPECIFIED 未指定の状態は使用されません。
CREATING AudienceExport は現在作成中で、今後利用可能になる予定です。作成は、audienceExports.create 呼び出しの直後に行われます。
ACTIVE AudienceExport が完全に作成され、クエリを実行する準備ができました。AudienceExport は、リクエストとは非同期でアクティブに更新されます。これは、最初の作成呼び出しからしばらく後(たとえば 15 分)後に行われます。
FAILED AudienceExport を作成できませんでした。このオーディエンスのエクスポートの再リクエストは成功する可能性があります。

Methods

create

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

get

特定のオーディエンスのエクスポートに関する設定メタデータを取得します。

list

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

query

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