Class AudienceList.Builder (0.55.0)

public static final class AudienceList.Builder extends GeneratedMessageV3.Builder<AudienceList.Builder> implements AudienceListOrBuilder

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.

Protobuf type google.analytics.data.v1alpha.AudienceList

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AudienceList.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllDimensions(Iterable<? extends AudienceDimension> values)

public AudienceList.Builder addAllDimensions(Iterable<? extends AudienceDimension> values)

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
values Iterable<? extends com.google.analytics.data.v1alpha.AudienceDimension>
Returns
Type Description
AudienceList.Builder

addDimensions(AudienceDimension value)

public AudienceList.Builder addDimensions(AudienceDimension value)

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
value AudienceDimension
Returns
Type Description
AudienceList.Builder

addDimensions(AudienceDimension.Builder builderForValue)

public AudienceList.Builder addDimensions(AudienceDimension.Builder builderForValue)

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
builderForValue AudienceDimension.Builder
Returns
Type Description
AudienceList.Builder

addDimensions(int index, AudienceDimension value)

public AudienceList.Builder addDimensions(int index, AudienceDimension value)

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

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

Parameters
Name Description
index int
value AudienceDimension
Returns
Type Description
AudienceList.Builder

addDimensions(int index, AudienceDimension.Builder builderForValue)

public AudienceList.Builder addDimensions(int index, AudienceDimension.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue AudienceDimension.Builder
Returns
Type Description
AudienceList.Builder

addDimensionsBuilder()

public AudienceDimension.Builder addDimensionsBuilder()

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
AudienceDimension.Builder

addDimensionsBuilder(int index)

public AudienceDimension.Builder addDimensionsBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AudienceList.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AudienceList.Builder
Overrides

build()

public AudienceList build()
Returns
Type Description
AudienceList

buildPartial()

public AudienceList buildPartial()
Returns
Type Description
AudienceList

clear()

public AudienceList.Builder clear()
Returns
Type Description
AudienceList.Builder
Overrides

clearAudience()

public AudienceList.Builder clearAudience()

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
AudienceList.Builder

This builder for chaining.

clearAudienceDisplayName()

public AudienceList.Builder clearAudienceDisplayName()

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
AudienceList.Builder

This builder for chaining.

clearBeginCreatingTime()

public AudienceList.Builder clearBeginCreatingTime()

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
AudienceList.Builder

clearCreationQuotaTokensCharged()

public AudienceList.Builder clearCreationQuotaTokensCharged()

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
AudienceList.Builder

This builder for chaining.

clearDimensions()

public AudienceList.Builder clearDimensions()

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
AudienceList.Builder

clearErrorMessage()

public AudienceList.Builder clearErrorMessage()

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
AudienceList.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AudienceList.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AudienceList.Builder
Overrides

clearName()

public AudienceList.Builder clearName()

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
AudienceList.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AudienceList.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AudienceList.Builder
Overrides

clearPercentageCompleted()

public AudienceList.Builder clearPercentageCompleted()

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
AudienceList.Builder

This builder for chaining.

clearRecurringAudienceList()

public AudienceList.Builder clearRecurringAudienceList()

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
AudienceList.Builder

This builder for chaining.

clearRowCount()

public AudienceList.Builder clearRowCount()

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
AudienceList.Builder

This builder for chaining.

clearState()

public AudienceList.Builder clearState()

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.Builder

This builder for chaining.

clearWebhookNotification()

public AudienceList.Builder clearWebhookNotification()

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
AudienceList.Builder

clone()

public AudienceList.Builder clone()
Returns
Type Description
AudienceList.Builder
Overrides

getAudience()

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

getBeginCreatingTimeBuilder()

public Timestamp.Builder getBeginCreatingTimeBuilder()

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
Builder

getBeginCreatingTimeOrBuilder()

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

getDefaultInstanceForType()

public AudienceList getDefaultInstanceForType()
Returns
Type Description
AudienceList

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDimensions(int index)

public 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

getDimensionsBuilder(int index)

public AudienceDimension.Builder getDimensionsBuilder(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.Builder

getDimensionsBuilderList()

public List<AudienceDimension.Builder> getDimensionsBuilderList()

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<Builder>

getDimensionsCount()

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

getWebhookNotificationBuilder()

public WebhookNotification.Builder getWebhookNotificationBuilder()

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.Builder

getWebhookNotificationOrBuilder()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBeginCreatingTime(Timestamp value)

public AudienceList.Builder mergeBeginCreatingTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
AudienceList.Builder

mergeFrom(AudienceList other)

public AudienceList.Builder mergeFrom(AudienceList other)
Parameter
Name Description
other AudienceList
Returns
Type Description
AudienceList.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AudienceList.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudienceList.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AudienceList.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AudienceList.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AudienceList.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AudienceList.Builder
Overrides

mergeWebhookNotification(WebhookNotification value)

public AudienceList.Builder mergeWebhookNotification(WebhookNotification value)

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];

Parameter
Name Description
value WebhookNotification
Returns
Type Description
AudienceList.Builder

removeDimensions(int index)

public AudienceList.Builder removeDimensions(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
AudienceList.Builder

setAudience(String value)

public AudienceList.Builder setAudience(String value)

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];

Parameter
Name Description
value String

The audience to set.
Returns
Type Description
AudienceList.Builder

This builder for chaining.

setAudienceBytes(ByteString value)

public AudienceList.Builder setAudienceBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for audience to set.
Returns
Type Description
AudienceList.Builder

This builder for chaining.

setAudienceDisplayName(String value)

public AudienceList.Builder setAudienceDisplayName(String value)

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

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

Parameter
Name Description
value String

The audienceDisplayName to set.
Returns
Type Description
AudienceList.Builder

This builder for chaining.

setAudienceDisplayNameBytes(ByteString value)

public AudienceList.Builder setAudienceDisplayNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for audienceDisplayName to set.
Returns
Type Description
AudienceList.Builder

This builder for chaining.

setBeginCreatingTime(Timestamp value)

public AudienceList.Builder setBeginCreatingTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
AudienceList.Builder

setBeginCreatingTime(Timestamp.Builder builderForValue)

public AudienceList.Builder setBeginCreatingTime(Timestamp.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
AudienceList.Builder

setCreationQuotaTokensCharged(int value)

public AudienceList.Builder setCreationQuotaTokensCharged(int value)

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];

Parameter
Name Description
value int

The creationQuotaTokensCharged to set.
Returns
Type Description
AudienceList.Builder

This builder for chaining.

setDimensions(int index, AudienceDimension value)

public AudienceList.Builder setDimensions(int index, AudienceDimension value)

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

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

Parameters
Name Description
index int
value AudienceDimension
Returns
Type Description
AudienceList.Builder

setDimensions(int index, AudienceDimension.Builder builderForValue)

public AudienceList.Builder setDimensions(int index, AudienceDimension.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue AudienceDimension.Builder
Returns
Type Description
AudienceList.Builder

setErrorMessage(String value)

public AudienceList.Builder setErrorMessage(String value)

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];

Parameter
Name Description
value String

The errorMessage to set.
Returns
Type Description
AudienceList.Builder

This builder for chaining.

setErrorMessageBytes(ByteString value)

public AudienceList.Builder setErrorMessageBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for errorMessage to set.
Returns
Type Description
AudienceList.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AudienceList.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AudienceList.Builder
Overrides

setName(String value)

public AudienceList.Builder setName(String value)

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];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
AudienceList.Builder

This builder for chaining.

setNameBytes(ByteString value)

public AudienceList.Builder setNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
AudienceList.Builder

This builder for chaining.

setPercentageCompleted(double value)

public AudienceList.Builder setPercentageCompleted(double value)

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];

Parameter
Name Description
value double

The percentageCompleted to set.
Returns
Type Description
AudienceList.Builder

This builder for chaining.

setRecurringAudienceList(String value)

public AudienceList.Builder setRecurringAudienceList(String value)

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];

Parameter
Name Description
value String

The recurringAudienceList to set.
Returns
Type Description
AudienceList.Builder

This builder for chaining.

setRecurringAudienceListBytes(ByteString value)

public AudienceList.Builder setRecurringAudienceListBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for recurringAudienceList to set.
Returns
Type Description
AudienceList.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AudienceList.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AudienceList.Builder
Overrides

setRowCount(int value)

public AudienceList.Builder setRowCount(int value)

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

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

Parameter
Name Description
value int

The rowCount to set.
Returns
Type Description
AudienceList.Builder

This builder for chaining.

setState(AudienceList.State value)

public AudienceList.Builder setState(AudienceList.State value)

Output only. The current state for this AudienceList.

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

Parameter
Name Description
value AudienceList.State

The state to set.
Returns
Type Description
AudienceList.Builder

This builder for chaining.

setStateValue(int value)

public AudienceList.Builder setStateValue(int value)

Output only. The current state for this AudienceList.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
AudienceList.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AudienceList.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AudienceList.Builder
Overrides

setWebhookNotification(WebhookNotification value)

public AudienceList.Builder setWebhookNotification(WebhookNotification value)

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];

Parameter
Name Description
value WebhookNotification
Returns
Type Description
AudienceList.Builder

setWebhookNotification(WebhookNotification.Builder builderForValue)

public AudienceList.Builder setWebhookNotification(WebhookNotification.Builder builderForValue)

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];

Parameter
Name Description
builderForValue WebhookNotification.Builder
Returns
Type Description
AudienceList.Builder