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 \ V1alphaMethods
__construct
Constructor.
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.
↳ webhook_notification
Google\Analytics\Data\V1alpha\WebhookNotification
Optional. Configures webhook notifications to be sent from the Google Analytics Data API to your webhook server. Use of webhooks is optional. If unused, you'll need to poll this API to determine when an audience list is ready to be used. Webhooks allow a notification to be sent to your servers & avoid the need for polling. Either one or two POST requests will be sent to the webhook. The first POST request will be sent immediately showing the newly created audience list in its CREATING state. The second POST request will be sent after the audience list completes creation (either the ACTIVE or FAILED state). If identical audience lists are requested in quick succession, the second & subsequent audience lists can be served from cache. In that case, the audience list create method can return an audience list is already ACTIVE. In this scenario, only one POST request will be sent to the webhook.
getName
Output only. Identifier. The audience list resource name assigned during
creation. This resource name identifies this AudienceList
.
Format: properties/{property}/audienceLists/{audience_list}
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}
var
string
$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}
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}
var
string
$this
getAudienceDisplayName
Output only. The descriptive display name for this audience. For example, "Purchasers".
string
setAudienceDisplayName
Output only. The descriptive display name for this audience. For example, "Purchasers".
var
string
$this
getDimensions
Required. The dimensions requested and displayed in the query response.
setDimensions
Required. The dimensions requested and displayed in the query response.
$this
getState
Output only. The current state for this AudienceList.
int
hasState
clearState
setState
Output only. The current state for this AudienceList.
var
int
$this
getBeginCreatingTime
Output only. The time when CreateAudienceList was called and the
AudienceList began the CREATING
state.
hasBeginCreatingTime
clearBeginCreatingTime
setBeginCreatingTime
Output only. The time when CreateAudienceList was called and the
AudienceList began the CREATING
state.
$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.
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.
var
int
$this
getRowCount
Output only. The total number of rows in the AudienceList result.
int
hasRowCount
clearRowCount
setRowCount
Output only. The total number of rows in the AudienceList result.
var
int
$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.
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.
var
string
$this
getPercentageCompleted
Output only. The percentage completed for this audience export ranging between 0 to 100.
float
hasPercentageCompleted
clearPercentageCompleted
setPercentageCompleted
Output only. The percentage completed for this audience export ranging between 0 to 100.
var
float
$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.
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.
var
string
$this
getWebhookNotification
Optional. Configures webhook notifications to be sent from the Google Analytics Data API to your webhook server. Use of webhooks is optional. If unused, you'll need to poll this API to determine when an audience list is ready to be used. Webhooks allow a notification to be sent to your servers & avoid the need for polling.
Either one or two POST requests will be sent to the webhook. The first POST request will be sent immediately showing the newly created audience list in its CREATING state. The second POST request will be sent after the audience list completes creation (either the ACTIVE or FAILED state). If identical audience lists are requested in quick succession, the second & subsequent audience lists can be served from cache. In that case, the audience list create method can return an audience list is already ACTIVE. In this scenario, only one POST request will be sent to the webhook.
hasWebhookNotification
clearWebhookNotification
setWebhookNotification
Optional. Configures webhook notifications to be sent from the Google Analytics Data API to your webhook server. Use of webhooks is optional. If unused, you'll need to poll this API to determine when an audience list is ready to be used. Webhooks allow a notification to be sent to your servers & avoid the need for polling.
Either one or two POST requests will be sent to the webhook. The first POST request will be sent immediately showing the newly created audience list in its CREATING state. The second POST request will be sent after the audience list completes creation (either the ACTIVE or FAILED state). If identical audience lists are requested in quick succession, the second & subsequent audience lists can be served from cache. In that case, the audience list create method can return an audience list is already ACTIVE. In this scenario, only one POST request will be sent to the webhook.
$this
