Class Audience (0.33.0)

public final class Audience extends GeneratedMessageV3 implements AudienceOrBuilder

A resource message representing a GA4 Audience.

Protobuf type google.analytics.admin.v1alpha.Audience

Implements

AudienceOrBuilder

Static Fields

ADS_PERSONALIZATION_ENABLED_FIELD_NUMBER

public static final int ADS_PERSONALIZATION_ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

EVENT_TRIGGER_FIELD_NUMBER

public static final int EVENT_TRIGGER_FIELD_NUMBER
Field Value
TypeDescription
int

EXCLUSION_DURATION_MODE_FIELD_NUMBER

public static final int EXCLUSION_DURATION_MODE_FIELD_NUMBER
Field Value
TypeDescription
int

FILTER_CLAUSES_FIELD_NUMBER

public static final int FILTER_CLAUSES_FIELD_NUMBER
Field Value
TypeDescription
int

MEMBERSHIP_DURATION_DAYS_FIELD_NUMBER

public static final int MEMBERSHIP_DURATION_DAYS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Audience getDefaultInstance()
Returns
TypeDescription
Audience

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Audience.Builder newBuilder()
Returns
TypeDescription
Audience.Builder

newBuilder(Audience prototype)

public static Audience.Builder newBuilder(Audience prototype)
Parameter
NameDescription
prototypeAudience
Returns
TypeDescription
Audience.Builder

parseDelimitedFrom(InputStream input)

public static Audience parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Audience
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Audience parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Audience
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Audience parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Audience
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Audience parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Audience
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Audience parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Audience
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Audience parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Audience
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Audience parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Audience
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Audience parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Audience
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Audience parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Audience
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Audience parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Audience
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Audience parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Audience
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Audience parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Audience
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Audience> parser()
Returns
TypeDescription
Parser<Audience>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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
TypeDescription
boolean

The adsPersonalizationEnabled.

getDefaultInstanceForType()

public Audience getDefaultInstanceForType()
Returns
TypeDescription
Audience

getDescription()

public String getDescription()

Required. The description of the Audience.

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

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Required. The description of the Audience.

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

Returns
TypeDescription
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Required. The display name of the Audience.

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

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The display name of the Audience.

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

Returns
TypeDescription
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
TypeDescription
AudienceEventTrigger

The eventTrigger.

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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for exclusionDurationMode.

getFilterClauses(int index)

public AudienceFilterClause getFilterClauses(int index)

Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed 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
NameDescription
indexint
Returns
TypeDescription
AudienceFilterClause

getFilterClausesCount()

public int getFilterClausesCount()

Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed 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
TypeDescription
int

getFilterClausesList()

public List<AudienceFilterClause> getFilterClausesList()

Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed 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
TypeDescription
List<AudienceFilterClause>

getFilterClausesOrBuilder(int index)

public AudienceFilterClauseOrBuilder getFilterClausesOrBuilder(int index)

Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed 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
NameDescription
indexint
Returns
TypeDescription
AudienceFilterClauseOrBuilder

getFilterClausesOrBuilderList()

public List<? extends AudienceFilterClauseOrBuilder> getFilterClausesOrBuilderList()

Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed 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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Audience> getParserForType()
Returns
TypeDescription
Parser<Audience>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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
TypeDescription
boolean

Whether the eventTrigger field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Audience.Builder newBuilderForType()
Returns
TypeDescription
Audience.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Audience.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Audience.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Audience.Builder toBuilder()
Returns
TypeDescription
Audience.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException