AudienceExport

import type { AudienceExport } from "https://googleapis.deno.dev/v1/analyticsdata:v1beta.ts";

An audience export is a list of users in an audience at the time of the list's creation. One audience may have multiple audience exports created for different days.

interface AudienceExport {

audience?: string;

readonly audienceDisplayName?: string;

readonly beginCreatingTime?: Date;

readonly creationQuotaTokensCharged?: number;

dimensions?: V1betaAudienceDimension[];

readonly errorMessage?: string;

readonly name?: string;

readonly percentageCompleted?: number;

readonly rowCount?: number;

readonly state?:

| "STATE_UNSPECIFIED"

| "CREATING"

| "ACTIVE"

| "FAILED";

}

§Properties

audience?: string

[src]

Required. The audience resource name. This resource name identifies the audience being listed and is shared between the Analytics Data & Admin APIs. Format: properties/{property}/audiences/{audience}

readonly audienceDisplayName?: string

[src]

Output only. The descriptive display name for this audience. For example, "Purchasers".

readonly beginCreatingTime?: Date

[src]

Output only. The time when CreateAudienceExport was called and the AudienceExport began the CREATING state.

readonly creationQuotaTokensCharged?: number

[src]

Output only. The total quota tokens charged during creation of the AudienceExport. Because this token count is based on activity from the CREATING state, this tokens charged will be fixed once an AudienceExport enters the ACTIVE or FAILED states.

dimensions?: V1betaAudienceDimension[]

[src]

Required. The dimensions requested and displayed in the query response.

readonly errorMessage?: string

[src]

Output only. Error message is populated when an audience export fails during creation. A common reason for such a failure is quota exhaustion.

readonly name?: string

[src]

Output only. Identifier. The audience export resource name assigned during creation. This resource name identifies this AudienceExport. Format: properties/{property}/audienceExports/{audience_export}

readonly percentageCompleted?: number

[src]

Output only. The percentage completed for this audience export ranging between 0 to 100.

readonly rowCount?: number

[src]

Output only. The total number of rows in the AudienceExport result.

readonly state?: "STATE_UNSPECIFIED" | "CREATING" | "ACTIVE" | "FAILED"

[src]

Output only. The current state for this AudienceExport.