Google Analytics Data V1alpha Client - Class AudienceList (0.14.0)

Version 0.14.0

• 0.20.1 (latest)
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.1
• 0.16.4
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.2
• 0.10.1
• 0.9.5

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Analytics Data V1alpha Client class AudienceList.

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

Generated from protobuf message google.analytics.data.v1alpha.AudienceList

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Output only. Identifier. The audience list resource name assigned during creation. This resource name identifies this AudienceList. Format: properties/{property}/audienceLists/{audience_list}
↳ 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\V1alpha\AudienceDimension> Required. The dimensions requested and displayed in the query response.
↳ state	int Output only. The current state for this AudienceList.
↳ begin_creating_time	Google\Protobuf\Timestamp Output only. The time when CreateAudienceList was called and the AudienceList began the CREATING state.
↳ creation_quota_tokens_charged	int Output only. The total quota tokens charged during creation of the AudienceList. Because this token count is based on activity from the CREATING state, this tokens charged will be fixed once an AudienceList enters the ACTIVE or FAILED states.
↳ row_count	int Output only. The total number of rows in the AudienceList result.
↳ error_message	string Output only. Error message is populated when an audience list 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.
↳ recurring_audience_list	string Output only. The recurring audience list that created this audience list. Recurring audience lists create audience lists daily. If audience lists are created directly, they will have no associated recurring audience list, and this field will be blank.

getName

Output only. Identifier. The audience list resource name assigned during creation. This resource name identifies this AudienceList.

Format: properties/{property}/audienceLists/{audience_list}

Returns
Type	Description
string

setName

Output only. Identifier. The audience list resource name assigned during creation. This resource name identifies this AudienceList.

Format: properties/{property}/audienceLists/{audience_list}

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\V1alpha\AudienceDimension>

Returns
Type	Description
$this

getState

Output only. The current state for this AudienceList.

Returns
Type	Description
int

hasState

clearState

setState

Output only. The current state for this AudienceList.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getBeginCreatingTime

Output only. The time when CreateAudienceList was called and the AudienceList began the CREATING state.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasBeginCreatingTime

clearBeginCreatingTime

setBeginCreatingTime

Output only. The time when CreateAudienceList was called and the AudienceList 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 AudienceList. Because this token count is based on activity from the CREATING state, this tokens charged will be fixed once an AudienceList enters the ACTIVE or FAILED states.

Returns
Type	Description
int

setCreationQuotaTokensCharged

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

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getRowCount

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

Returns
Type	Description
int

hasRowCount

clearRowCount

setRowCount

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

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getErrorMessage

Output only. Error message is populated when an audience list 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 list 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

getRecurringAudienceList

Output only. The recurring audience list that created this audience list.

Recurring audience lists create audience lists daily. If audience lists are created directly, they will have no associated recurring audience list, and this field will be blank.

Returns
Type	Description
string

hasRecurringAudienceList

clearRecurringAudienceList

setRecurringAudienceList

Output only. The recurring audience list that created this audience list.

Recurring audience lists create audience lists daily. If audience lists are created directly, they will have no associated recurring audience list, and this field will be blank.

Parameter
Name	Description
var	string

Returns
Type	Description
$this