Class Audience.Builder (0.16.0)

Version 0.16.0

• 0.65.0 (latest)
• 0.64.0
• 0.63.0
• 0.62.0
• 0.61.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0

public static final class Audience.Builder extends GeneratedMessageV3.Builder<Audience.Builder> implements AudienceOrBuilder

A resource message representing a GA4 Audience.

Protobuf type google.analytics.admin.v1alpha.Audience

Inheritance

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

Implements

AudienceOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addAllFilterClauses(Iterable<? extends AudienceFilterClause> values)

public Audience.Builder addAllFilterClauses(Iterable<? extends AudienceFilterClause> values)

Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND\u2019ed together.

repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Parameter

Name	Description
values	Iterable<? extends com.google.analytics.admin.v1alpha.AudienceFilterClause>

Returns

Type	Description
Audience.Builder

addFilterClauses(AudienceFilterClause value)

public Audience.Builder addFilterClauses(AudienceFilterClause value)

Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND\u2019ed together.

repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Parameter

Name	Description
value	AudienceFilterClause

Returns

Type	Description
Audience.Builder

addFilterClauses(AudienceFilterClause.Builder builderForValue)

public Audience.Builder addFilterClauses(AudienceFilterClause.Builder builderForValue)

Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND\u2019ed together.

repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Parameter

Name	Description
builderForValue	AudienceFilterClause.Builder

Returns

Type	Description
Audience.Builder

addFilterClauses(int index, AudienceFilterClause value)

public Audience.Builder addFilterClauses(int index, AudienceFilterClause value)

Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND\u2019ed together.

repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Parameters

Name	Description
index	int
value	AudienceFilterClause

Returns

Type	Description
Audience.Builder

addFilterClauses(int index, AudienceFilterClause.Builder builderForValue)

public Audience.Builder addFilterClauses(int index, AudienceFilterClause.Builder builderForValue)

Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND\u2019ed together.

repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Parameters

Name	Description
index	int
builderForValue	AudienceFilterClause.Builder

Returns

Type	Description
Audience.Builder

addFilterClausesBuilder()

public AudienceFilterClause.Builder addFilterClausesBuilder()

Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND\u2019ed together.

repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Returns

Type	Description
AudienceFilterClause.Builder

addFilterClausesBuilder(int index)

public AudienceFilterClause.Builder addFilterClausesBuilder(int index)

Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND\u2019ed together.

repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Parameter

Name	Description
index	int

Returns

Type	Description
AudienceFilterClause.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Audience.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
Audience.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Audience build()

Returns

Type	Description
Audience

buildPartial()

public Audience buildPartial()

Returns

Type	Description
Audience

clear()

public Audience.Builder clear()

Returns

Type	Description
Audience.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAdsPersonalizationEnabled()

public Audience.Builder clearAdsPersonalizationEnabled()

Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization.

bool ads_personalization_enabled = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Audience.Builder	This builder for chaining.

clearDescription()

public Audience.Builder clearDescription()

Required. The description of the Audience.

string description = 3 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
Audience.Builder	This builder for chaining.

clearDisplayName()

public Audience.Builder clearDisplayName()

Required. The display name of the Audience.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
Audience.Builder	This builder for chaining.

clearEventTrigger()

public Audience.Builder clearEventTrigger()

Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.

.google.analytics.admin.v1alpha.AudienceEventTrigger event_trigger = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
Audience.Builder

clearExclusionDurationMode()

public Audience.Builder clearExclusionDurationMode()

Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience.

.google.analytics.admin.v1alpha.Audience.AudienceExclusionDurationMode exclusion_duration_mode = 7 [(.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
Audience.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Audience.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
Audience.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilterClauses()

public Audience.Builder clearFilterClauses()

Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND\u2019ed together.

repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Returns

Type	Description
Audience.Builder

clearMembershipDurationDays()

public Audience.Builder clearMembershipDurationDays()

Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days.

int32 membership_duration_days = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
Audience.Builder	This builder for chaining.

clearName()

public Audience.Builder clearName()

Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}

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

Returns

Type	Description
Audience.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Audience.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
Audience.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public Audience.Builder clone()

Returns

Type	Description
Audience.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAdsPersonalizationEnabled()

public boolean getAdsPersonalizationEnabled()

Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization.

bool ads_personalization_enabled = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	The adsPersonalizationEnabled.

getDefaultInstanceForType()

public Audience getDefaultInstanceForType()

Returns

Type	Description
Audience

getDescription()

public String getDescription()

Required. The description of the Audience.

string description = 3 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Required. The description of the Audience.

string description = 3 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ByteString	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

Required. The display name of the Audience.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The display name of the Audience.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ByteString	The bytes for displayName.

getEventTrigger()

public AudienceEventTrigger getEventTrigger()

Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.

.google.analytics.admin.v1alpha.AudienceEventTrigger event_trigger = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
AudienceEventTrigger	The eventTrigger.

getEventTriggerBuilder()

public AudienceEventTrigger.Builder getEventTriggerBuilder()

Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.

.google.analytics.admin.v1alpha.AudienceEventTrigger event_trigger = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
AudienceEventTrigger.Builder

getEventTriggerOrBuilder()

public AudienceEventTriggerOrBuilder getEventTriggerOrBuilder()

Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.

.google.analytics.admin.v1alpha.AudienceEventTrigger event_trigger = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
AudienceEventTriggerOrBuilder

getExclusionDurationMode()

public Audience.AudienceExclusionDurationMode getExclusionDurationMode()

Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience.

.google.analytics.admin.v1alpha.Audience.AudienceExclusionDurationMode exclusion_duration_mode = 7 [(.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
Audience.AudienceExclusionDurationMode	The exclusionDurationMode.

getExclusionDurationModeValue()

public int getExclusionDurationModeValue()

Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience.

.google.analytics.admin.v1alpha.Audience.AudienceExclusionDurationMode exclusion_duration_mode = 7 [(.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
int	The enum numeric value on the wire for exclusionDurationMode.

getFilterClauses(int index)

public AudienceFilterClause getFilterClauses(int index)

Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND\u2019ed together.

repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Parameter

Name	Description
index	int

Returns

Type	Description
AudienceFilterClause

getFilterClausesBuilder(int index)

public AudienceFilterClause.Builder getFilterClausesBuilder(int index)

Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND\u2019ed together.

repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Parameter

Name	Description
index	int

Returns

Type	Description
AudienceFilterClause.Builder

getFilterClausesBuilderList()

public List<AudienceFilterClause.Builder> getFilterClausesBuilderList()

Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND\u2019ed together.

repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Returns

Type	Description
List<Builder>

getFilterClausesCount()

public int getFilterClausesCount()

Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND\u2019ed together.

repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Returns

Type	Description
int

getFilterClausesList()

public List<AudienceFilterClause> getFilterClausesList()

Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND\u2019ed together.

repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Returns

Type	Description
List<AudienceFilterClause>

getFilterClausesOrBuilder(int index)

public AudienceFilterClauseOrBuilder getFilterClausesOrBuilder(int index)

Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND\u2019ed together.

repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Parameter

Name	Description
index	int

Returns

Type	Description
AudienceFilterClauseOrBuilder

getFilterClausesOrBuilderList()

public List<? extends AudienceFilterClauseOrBuilder> getFilterClausesOrBuilderList()

Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND\u2019ed together.

repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Returns

Type	Description
List<? extends com.google.analytics.admin.v1alpha.AudienceFilterClauseOrBuilder>

getMembershipDurationDays()

public int getMembershipDurationDays()

Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days.

int32 membership_duration_days = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
int	The membershipDurationDays.

getName()

public String getName()

Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}

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

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}

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

Returns

Type	Description
ByteString	The bytes for name.

hasEventTrigger()

public boolean hasEventTrigger()

Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.

.google.analytics.admin.v1alpha.AudienceEventTrigger event_trigger = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
boolean	Whether the eventTrigger field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeEventTrigger(AudienceEventTrigger value)

public Audience.Builder mergeEventTrigger(AudienceEventTrigger value)

Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.

.google.analytics.admin.v1alpha.AudienceEventTrigger event_trigger = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	AudienceEventTrigger

Returns

Type	Description
Audience.Builder

mergeFrom(Audience other)

public Audience.Builder mergeFrom(Audience other)

Parameter

Name	Description
other	Audience

Returns

Type	Description
Audience.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Audience.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Audience.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public Audience.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
Audience.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Audience.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
Audience.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeFilterClauses(int index)

public Audience.Builder removeFilterClauses(int index)

Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND\u2019ed together.

repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Parameter

Name	Description
index	int

Returns

Type	Description
Audience.Builder

setAdsPersonalizationEnabled(boolean value)

public Audience.Builder setAdsPersonalizationEnabled(boolean value)

Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization.

bool ads_personalization_enabled = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	boolean The adsPersonalizationEnabled to set.

Returns

Type	Description
Audience.Builder	This builder for chaining.

setDescription(String value)

public Audience.Builder setDescription(String value)

Required. The description of the Audience.

string description = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	String The description to set.

Returns

Type	Description
Audience.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public Audience.Builder setDescriptionBytes(ByteString value)

Required. The description of the Audience.

string description = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	ByteString The bytes for description to set.

Returns

Type	Description
Audience.Builder	This builder for chaining.

setDisplayName(String value)

public Audience.Builder setDisplayName(String value)

Required. The display name of the Audience.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	String The displayName to set.

Returns

Type	Description
Audience.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public Audience.Builder setDisplayNameBytes(ByteString value)

Required. The display name of the Audience.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	ByteString The bytes for displayName to set.

Returns

Type	Description
Audience.Builder	This builder for chaining.

setEventTrigger(AudienceEventTrigger value)

public Audience.Builder setEventTrigger(AudienceEventTrigger value)

Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.

.google.analytics.admin.v1alpha.AudienceEventTrigger event_trigger = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	AudienceEventTrigger

Returns

Type	Description
Audience.Builder

setEventTrigger(AudienceEventTrigger.Builder builderForValue)

public Audience.Builder setEventTrigger(AudienceEventTrigger.Builder builderForValue)

Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.

.google.analytics.admin.v1alpha.AudienceEventTrigger event_trigger = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
builderForValue	AudienceEventTrigger.Builder

Returns

Type	Description
Audience.Builder

setExclusionDurationMode(Audience.AudienceExclusionDurationMode value)

public Audience.Builder setExclusionDurationMode(Audience.AudienceExclusionDurationMode value)

Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience.

.google.analytics.admin.v1alpha.Audience.AudienceExclusionDurationMode exclusion_duration_mode = 7 [(.google.api.field_behavior) = IMMUTABLE];

Parameter

Name	Description
value	Audience.AudienceExclusionDurationMode The exclusionDurationMode to set.

Returns

Type	Description
Audience.Builder	This builder for chaining.

setExclusionDurationModeValue(int value)

public Audience.Builder setExclusionDurationModeValue(int value)

Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience.

.google.analytics.admin.v1alpha.Audience.AudienceExclusionDurationMode exclusion_duration_mode = 7 [(.google.api.field_behavior) = IMMUTABLE];

Parameter

Name	Description
value	int The enum numeric value on the wire for exclusionDurationMode to set.

Returns

Type	Description
Audience.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Audience.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
Audience.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilterClauses(int index, AudienceFilterClause value)

public Audience.Builder setFilterClauses(int index, AudienceFilterClause value)

Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND\u2019ed together.

repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Parameters

Name	Description
index	int
value	AudienceFilterClause

Returns

Type	Description
Audience.Builder

setFilterClauses(int index, AudienceFilterClause.Builder builderForValue)

public Audience.Builder setFilterClauses(int index, AudienceFilterClause.Builder builderForValue)

Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND\u2019ed together.

repeated .google.analytics.admin.v1alpha.AudienceFilterClause filter_clauses = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Parameters

Name	Description
index	int
builderForValue	AudienceFilterClause.Builder

Returns

Type	Description
Audience.Builder

setMembershipDurationDays(int value)

public Audience.Builder setMembershipDurationDays(int value)

Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days.

int32 membership_duration_days = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter

Name	Description
value	int The membershipDurationDays to set.

Returns

Type	Description
Audience.Builder	This builder for chaining.

setName(String value)

public Audience.Builder setName(String value)

Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}

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

Parameter

Name	Description
value	String The name to set.

Returns

Type	Description
Audience.Builder	This builder for chaining.

setNameBytes(ByteString value)

public Audience.Builder setNameBytes(ByteString value)

Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}

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

Parameter

Name	Description
value	ByteString The bytes for name to set.

Returns

Type	Description
Audience.Builder	This builder for chaining.

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
Audience.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final Audience.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
Audience.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)