Interface AudienceListOrBuilder (0.64.0) 

public interface AudienceListOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAudience()

public abstract String 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 audience = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The audience.

getAudienceBytes()

public abstract ByteString getAudienceBytes()

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 audience = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for audience.

getAudienceDisplayName()

public abstract String getAudienceDisplayName()

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

string audience_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The audienceDisplayName.

getAudienceDisplayNameBytes()

public abstract ByteString getAudienceDisplayNameBytes()

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

string audience_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for audienceDisplayName.

getBeginCreatingTime()

public abstract Timestamp getBeginCreatingTime()

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

optional .google.protobuf.Timestamp begin_creating_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The beginCreatingTime.

getBeginCreatingTimeOrBuilder()

public abstract TimestampOrBuilder getBeginCreatingTimeOrBuilder()

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

optional .google.protobuf.Timestamp begin_creating_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCreationQuotaTokensCharged()

public abstract int 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.

int32 creation_quota_tokens_charged = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The creationQuotaTokensCharged.

getDimensions(int index)

public abstract AudienceDimension getDimensions(int index)

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

repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
AudienceDimension

getDimensionsCount()

public abstract int getDimensionsCount()

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

repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getDimensionsList()

public abstract List<AudienceDimension> getDimensionsList()

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

repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<AudienceDimension>

getDimensionsOrBuilder(int index)

public abstract AudienceDimensionOrBuilder getDimensionsOrBuilder(int index)

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

repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
AudienceDimensionOrBuilder

getDimensionsOrBuilderList()

public abstract List<? extends AudienceDimensionOrBuilder> getDimensionsOrBuilderList()

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

repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.analytics.data.v1alpha.AudienceDimensionOrBuilder>

getErrorMessage()

public abstract String getErrorMessage()

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

optional string error_message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The errorMessage.

getErrorMessageBytes()

public abstract ByteString getErrorMessageBytes()

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

optional string error_message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for errorMessage.

getName()

public abstract String 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 name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getPercentageCompleted()

public abstract double getPercentageCompleted()

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

optional double percentage_completed = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
double

The percentageCompleted.

getRecurringAudienceList()

public abstract String 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.

optional string recurring_audience_list = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The recurringAudienceList.

getRecurringAudienceListBytes()

public abstract ByteString getRecurringAudienceListBytes()

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.

optional string recurring_audience_list = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for recurringAudienceList.

getRowCount()

public abstract int getRowCount()

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

optional int32 row_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The rowCount.

getState()

public abstract AudienceList.State getState()

Output only. The current state for this AudienceList.

optional .google.analytics.data.v1alpha.AudienceList.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AudienceList.State

The state.

getStateValue()

public abstract int getStateValue()

Output only. The current state for this AudienceList.

optional .google.analytics.data.v1alpha.AudienceList.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getWebhookNotification()

public abstract WebhookNotification 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.

optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WebhookNotification

The webhookNotification.

getWebhookNotificationOrBuilder()

public abstract WebhookNotificationOrBuilder getWebhookNotificationOrBuilder()

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.

optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WebhookNotificationOrBuilder

hasBeginCreatingTime()

public abstract boolean hasBeginCreatingTime()

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

optional .google.protobuf.Timestamp begin_creating_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the beginCreatingTime field is set.

hasErrorMessage()

public abstract boolean hasErrorMessage()

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

optional string error_message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the errorMessage field is set.

hasPercentageCompleted()

public abstract boolean hasPercentageCompleted()

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

optional double percentage_completed = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the percentageCompleted field is set.

hasRecurringAudienceList()

public abstract boolean hasRecurringAudienceList()

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.

optional string recurring_audience_list = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the recurringAudienceList field is set.

hasRowCount()

public abstract boolean hasRowCount()

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

optional int32 row_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the rowCount field is set.

hasState()

public abstract boolean hasState()

Output only. The current state for this AudienceList.

optional .google.analytics.data.v1alpha.AudienceList.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the state field is set.

hasWebhookNotification()

public abstract boolean hasWebhookNotification()

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.

optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the webhookNotification field is set.