Google Analytics Data V1alpha Client - Class RecurringAudienceList (0.16.4)

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

A recurring audience list produces new audience lists each day. Audience lists are users in an audience at the time of the list's creation. A recurring audience list ensures that you have audience list based on the most recent data available for use each day.

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

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 recurring audience list resource name assigned during creation. This resource name identifies this RecurringAudienceList. Format: properties/{property}/recurringAudienceLists/{recurring_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 audience list response.

↳ active_days_remaining int

Optional. The number of remaining days that a recurring audience export will produce an audience list instance. This counter decreases by one each day, and when it reaches zero, no new audience lists will be created. Recurring audience list request for Analytics 360 properties default to 180 days and have a maximum of 365 days. Requests for standard Analytics properties default to 14 days and have a maximum of 30 days. The minimum value allowed during creation is 1. Requests above their respective maximum will be coerced to their maximum.

↳ audience_lists array

Output only. Audience list resource names for audience list instances created for this recurring audience list. One audience list is created for each day, and the audience list will be listed here. This list is ordered with the most recently created audience list first.

↳ 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 a recurring audience list creates new audience lists. Webhooks allow a notification to be sent to your servers & avoid the need for polling. Two POST requests will be sent each time a recurring audience list creates an audience list. This happens once per day until a recurring audience list reaches 0 active days remaining. The first request will be sent showing a newly created audience list in its CREATING state. The second request will be sent after the audience list completes creation (either the ACTIVE or FAILED state).

getName

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

Format: properties/{property}/recurringAudienceLists/{recurring_audience_list}

Returns
Type Description
string

setName

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

Format: properties/{property}/recurringAudienceLists/{recurring_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 audience list response.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDimensions

Required. The dimensions requested and displayed in the audience list response.

Parameter
Name Description
var array<Google\Analytics\Data\V1alpha\AudienceDimension>
Returns
Type Description
$this

getActiveDaysRemaining

Optional. The number of remaining days that a recurring audience export will produce an audience list instance. This counter decreases by one each day, and when it reaches zero, no new audience lists will be created.

Recurring audience list request for Analytics 360 properties default to 180 days and have a maximum of 365 days. Requests for standard Analytics properties default to 14 days and have a maximum of 30 days. The minimum value allowed during creation is 1. Requests above their respective maximum will be coerced to their maximum.

Returns
Type Description
int

hasActiveDaysRemaining

clearActiveDaysRemaining

setActiveDaysRemaining

Optional. The number of remaining days that a recurring audience export will produce an audience list instance. This counter decreases by one each day, and when it reaches zero, no new audience lists will be created.

Recurring audience list request for Analytics 360 properties default to 180 days and have a maximum of 365 days. Requests for standard Analytics properties default to 14 days and have a maximum of 30 days. The minimum value allowed during creation is 1. Requests above their respective maximum will be coerced to their maximum.

Parameter
Name Description
var int
Returns
Type Description
$this

getAudienceLists

Output only. Audience list resource names for audience list instances created for this recurring audience list. One audience list is created for each day, and the audience list will be listed here.

This list is ordered with the most recently created audience list first.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAudienceLists

Output only. Audience list resource names for audience list instances created for this recurring audience list. One audience list is created for each day, and the audience list will be listed here.

This list is ordered with the most recently created audience list first.

Parameter
Name Description
var string[]
Returns
Type Description
$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 a recurring audience list creates new audience lists. Webhooks allow a notification to be sent to your servers & avoid the need for polling.

Two POST requests will be sent each time a recurring audience list creates an audience list. This happens once per day until a recurring audience list reaches 0 active days remaining. The first request will be sent showing a newly created audience list in its CREATING state. The second request will be sent after the audience list completes creation (either the ACTIVE or FAILED state).

Returns
Type Description
Google\Analytics\Data\V1alpha\WebhookNotification|null

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 a recurring audience list creates new audience lists. Webhooks allow a notification to be sent to your servers & avoid the need for polling.

Two POST requests will be sent each time a recurring audience list creates an audience list. This happens once per day until a recurring audience list reaches 0 active days remaining. The first request will be sent showing a newly created audience list in its CREATING state. The second request will be sent after the audience list completes creation (either the ACTIVE or FAILED state).

Parameter
Name Description
var Google\Analytics\Data\V1alpha\WebhookNotification
Returns
Type Description
$this