Google Analytics Data V1beta Client - Class AudienceExport (0.17.1)

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
Name	Description
`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
Type	Description
`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
Name	Description
`var`	`string`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAudienceDisplayName

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

Returns
Type	Description
`string`

setAudienceDisplayName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDimensions

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

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setDimensions

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

Parameter
Name	Description
`var`	`array<Google\Analytics\Data\V1beta\AudienceDimension>`

Returns
Type	Description
`$this`

getState

Output only. The current state for this AudienceExport.

Returns
Type	Description
`int`

hasState

clearState

setState

Output only. The current state for this AudienceExport.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getBeginCreatingTime

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

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasBeginCreatingTime

clearBeginCreatingTime

setBeginCreatingTime

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

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$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
Type	Description
`int`

setCreationQuotaTokensCharged

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getRowCount

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

Returns
Type	Description
`int`

hasRowCount

clearRowCount

setRowCount

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

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPercentageCompleted

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

Returns
Type	Description
`float`

hasPercentageCompleted

clearPercentageCompleted

setPercentageCompleted

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

Parameter
Name	Description
`var`	`float`

Returns
Type	Description
`$this`