Google Analytics Data V1beta Client - Class AudienceExport (0.14.0)

Reference documentation and code samples for the Google Analytics Data V1beta Client class AudienceExport.

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.

Generated from protobuf message google.analytics.data.v1beta.AudienceExport

Namespace

Google \ Analytics \ Data \ V1beta

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

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

↳ audience string

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}

↳ audience_display_name string

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

↳ dimensions array<Google\Analytics\Data\V1beta\AudienceDimension>

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

↳ state int

Output only. The current state for this AudienceExport.

↳ begin_creating_time Google\Protobuf\Timestamp

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

↳ creation_quota_tokens_charged int

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.

↳ row_count int

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

↳ error_message string

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

↳ percentage_completed float

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

getName

Output only. Identifier. The audience export resource name assigned during creation. This resource name identifies this AudienceExport.

Format: properties/{property}/audienceExports/{audience_export}

Returns
TypeDescription
string

setName

Output only. Identifier. The audience export resource name assigned during creation. This resource name identifies this AudienceExport.

Format: properties/{property}/audienceExports/{audience_export}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAudience

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}

Returns
TypeDescription
string

setAudience

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}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAudienceDisplayName

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

Returns
TypeDescription
string

setAudienceDisplayName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDimensions

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setDimensions

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

Parameter
NameDescription
var array<Google\Analytics\Data\V1beta\AudienceDimension>
Returns
TypeDescription
$this

getState

Output only. The current state for this AudienceExport.

Returns
TypeDescription
int

hasState

clearState

setState

Output only. The current state for this AudienceExport.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getBeginCreatingTime

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasBeginCreatingTime

clearBeginCreatingTime

setBeginCreatingTime

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

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getCreationQuotaTokensCharged

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.

Returns
TypeDescription
int

setCreationQuotaTokensCharged

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.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getRowCount

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

Returns
TypeDescription
int

hasRowCount

clearRowCount

setRowCount

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getErrorMessage

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

Returns
TypeDescription
string

hasErrorMessage

clearErrorMessage

setErrorMessage

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPercentageCompleted

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

Returns
TypeDescription
float

hasPercentageCompleted

clearPercentageCompleted

setPercentageCompleted

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

Parameter
NameDescription
var float
Returns
TypeDescription
$this