Class RecurringAudienceList.Builder (0.63.0) 

public static final class RecurringAudienceList.Builder extends GeneratedMessageV3.Builder<RecurringAudienceList.Builder> implements RecurringAudienceListOrBuilder

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.

Protobuf type google.analytics.data.v1alpha.RecurringAudienceList

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addAllAudienceLists(Iterable<String> values)

public RecurringAudienceList.Builder addAllAudienceLists(Iterable<String> values)

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.

repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<String>

The audienceLists to add.
Returns
Type Description
RecurringAudienceList.Builder

This builder for chaining.

addAllDimensions(Iterable<? extends AudienceDimension> values)

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

Required. The dimensions requested and displayed in the audience list 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
RecurringAudienceList.Builder

addAudienceLists(String value)

public RecurringAudienceList.Builder addAudienceLists(String value)

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.

repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The audienceLists to add.
Returns
Type Description
RecurringAudienceList.Builder

This builder for chaining.

addAudienceListsBytes(ByteString value)

public RecurringAudienceList.Builder addAudienceListsBytes(ByteString value)

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.

repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes of the audienceLists to add.
Returns
Type Description
RecurringAudienceList.Builder

This builder for chaining.

addDimensions(AudienceDimension value)

public RecurringAudienceList.Builder addDimensions(AudienceDimension value)

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

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

Parameter
Name Description
value AudienceDimension
Returns
Type Description
RecurringAudienceList.Builder

addDimensions(AudienceDimension.Builder builderForValue)

public RecurringAudienceList.Builder addDimensions(AudienceDimension.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue AudienceDimension.Builder
Returns
Type Description
RecurringAudienceList.Builder

addDimensions(int index, AudienceDimension value)

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

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

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

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

addDimensions(int index, AudienceDimension.Builder builderForValue)

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

Required. The dimensions requested and displayed in the audience list 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
RecurringAudienceList.Builder

addDimensionsBuilder()

public AudienceDimension.Builder addDimensionsBuilder()

Required. The dimensions requested and displayed in the audience list 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 audience list 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 RecurringAudienceList.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RecurringAudienceList.Builder
Overrides

build()

public RecurringAudienceList build()
Returns
Type Description
RecurringAudienceList

buildPartial()

public RecurringAudienceList buildPartial()
Returns
Type Description
RecurringAudienceList

clear()

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

clearActiveDaysRemaining()

public RecurringAudienceList.Builder clearActiveDaysRemaining()

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.

optional int32 active_days_remaining = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RecurringAudienceList.Builder

This builder for chaining.

clearAudience()

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

This builder for chaining.

clearAudienceDisplayName()

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

This builder for chaining.

clearAudienceLists()

public RecurringAudienceList.Builder clearAudienceLists()

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.

repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
RecurringAudienceList.Builder

This builder for chaining.

clearDimensions()

public RecurringAudienceList.Builder clearDimensions()

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

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

Returns
Type Description
RecurringAudienceList.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearName()

public RecurringAudienceList.Builder clearName()

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}

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

Returns
Type Description
RecurringAudienceList.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearWebhookNotification()

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

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

Returns
Type Description
RecurringAudienceList.Builder

clone()

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

getActiveDaysRemaining()

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

optional int32 active_days_remaining = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The activeDaysRemaining.

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.

getAudienceLists(int index)

public String getAudienceLists(int index)

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.

repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The audienceLists at the given index.

getAudienceListsBytes(int index)

public ByteString getAudienceListsBytes(int index)

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.

repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the audienceLists at the given index.

getAudienceListsCount()

public int getAudienceListsCount()

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.

repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of audienceLists.

getAudienceListsList()

public ProtocolStringList getAudienceListsList()

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.

repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProtocolStringList

A list containing the audienceLists.

getDefaultInstanceForType()

public RecurringAudienceList getDefaultInstanceForType()
Returns
Type Description
RecurringAudienceList

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 audience list 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 audience list 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 audience list 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 audience list 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 audience list 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 audience list 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 audience list 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>

getName()

public String 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}

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 recurring audience list resource name assigned during creation. This resource name identifies this RecurringAudienceList.

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

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

Returns
Type Description
ByteString

The bytes for name.

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

optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 8 [(.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 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).

optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 8 [(.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 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).

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

Returns
Type Description
WebhookNotificationOrBuilder

hasActiveDaysRemaining()

public boolean hasActiveDaysRemaining()

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.

optional int32 active_days_remaining = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the activeDaysRemaining 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 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).

optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 8 [(.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

mergeFrom(RecurringAudienceList other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeWebhookNotification(WebhookNotification value)

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

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

Parameter
Name Description
value WebhookNotification
Returns
Type Description
RecurringAudienceList.Builder

removeDimensions(int index)

public RecurringAudienceList.Builder removeDimensions(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
RecurringAudienceList.Builder

setActiveDaysRemaining(int value)

public RecurringAudienceList.Builder setActiveDaysRemaining(int value)

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.

optional int32 active_days_remaining = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The activeDaysRemaining to set.
Returns
Type Description
RecurringAudienceList.Builder

This builder for chaining.

setAudience(String value)

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

This builder for chaining.

setAudienceBytes(ByteString value)

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

This builder for chaining.

setAudienceDisplayName(String value)

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

This builder for chaining.

setAudienceDisplayNameBytes(ByteString value)

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

This builder for chaining.

setAudienceLists(int index, String value)

public RecurringAudienceList.Builder setAudienceLists(int index, String value)

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.

repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int

The index to set the value at.
value String

The audienceLists to set.
Returns
Type Description
RecurringAudienceList.Builder

This builder for chaining.

setDimensions(int index, AudienceDimension value)

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

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

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

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

setDimensions(int index, AudienceDimension.Builder builderForValue)

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

Required. The dimensions requested and displayed in the audience list 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
RecurringAudienceList.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public RecurringAudienceList.Builder setName(String value)

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}

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

This builder for chaining.

setNameBytes(ByteString value)

public RecurringAudienceList.Builder setNameBytes(ByteString value)

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}

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

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setWebhookNotification(WebhookNotification value)

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

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

Parameter
Name Description
value WebhookNotification
Returns
Type Description
RecurringAudienceList.Builder

setWebhookNotification(WebhookNotification.Builder builderForValue)

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

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

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