Send feedback Class Audience (0.21.0) Stay organized with collections Save and categorize content based on your preferences.
Version 0.21.0 keyboard_arrow_down
public final class Audience extends GeneratedMessageV3 implements AudienceOrBuilder A resource message representing a GA4 Audience.
Protobuf type google.analytics.admin.v1alpha.Audience
Static Fields ADS_PERSONALIZATION_ENABLED_FIELD_NUMBER
public static final int ADS_PERSONALIZATION_ENABLED_FIELD_NUMBER Field Value DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER Field Value DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER Field Value EVENT_TRIGGER_FIELD_NUMBER
public static final int EVENT_TRIGGER_FIELD_NUMBER Field Value EXCLUSION_DURATION_MODE_FIELD_NUMBER
public static final int EXCLUSION_DURATION_MODE_FIELD_NUMBER Field Value FILTER_CLAUSES_FIELD_NUMBER
public static final int FILTER_CLAUSES_FIELD_NUMBER Field Value MEMBERSHIP_DURATION_DAYS_FIELD_NUMBER
public static final int MEMBERSHIP_DURATION_DAYS_FIELD_NUMBER Field Value NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER Field Value Static Methods getDefaultInstance()
public static Audience getDefaultInstance () Returns getDescriptor()
public static final Descriptors . Descriptor getDescriptor () Returns newBuilder()
public static Audience . Builder newBuilder () Returns newBuilder(Audience )
public static Audience . Builder newBuilder ( Audience ) Parameter Returns
public static Audience parseDelimitedFrom ( InputStream input ) Parameter Returns Exceptions
public static Audience parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry ) Parameters Returns Exceptions parseFrom(byte[] data)
public static Audience parseFrom ( byte [] data ) Parameter Name Description databyte []
Returns Exceptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Audience parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry ) Parameters Returns Exceptions parseFrom(ByteString data)
public static Audience parseFrom ( ByteString data ) Parameter Returns Exceptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Audience parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry ) Parameters Returns Exceptions
public static Audience parseFrom ( CodedInputStream input ) Parameter Returns Exceptions
public static Audience parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry ) Parameters Returns Exceptions
public static Audience parseFrom ( InputStream input ) Parameter Returns Exceptions
public static Audience parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry ) Parameters Returns Exceptions parseFrom(ByteBuffer data)
public static Audience parseFrom ( ByteBuffer data ) Parameter Returns Exceptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Audience parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry ) Parameters Returns Exceptions parser()
public static Parser<Audience> parser () Returns Methods equals(Object obj)
public boolean equals ( Object obj ) Parameter Returns 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 Type Description boolean The adsPersonalizationEnabled.
getDefaultInstanceForType()
public Audience getDefaultInstanceForType () Returns 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.
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 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 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 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. 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 Returns 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 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 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 Returns 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 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() 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 getParserForType()
public Parser<Audience> getParserForType () Returns Overrides getSerializedSize()
public int getSerializedSize () Returns Overrides getUnknownFields()
public final UnknownFieldSet getUnknownFields () Returns 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 Type Description boolean Whether the eventTrigger field is set.
hashCode() Returns Overrides internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable () Returns Overrides isInitialized()
public final boolean isInitialized () Returns Overrides newBuilderForType()
public Audience . Builder newBuilderForType () Returns newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Audience . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent ) Parameter Returns Overrides newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused ) Parameter Returns Overrides toBuilder()
public Audience . Builder toBuilder () Returns writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output ) Parameter Overrides Exceptions Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-17 UTC.
Need to tell us more? [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-04-17 UTC."],[[["The webpage provides documentation for the `Audience` class in the `google.analytics.admin.v1alpha` package, specifically for version 0.21.0 of the Java API for Google Analytics Admin."],["The `Audience` class represents a GA4 Audience and is a subclass of `GeneratedMessageV3`, implementing the `AudienceOrBuilder` interface."],["The documentation includes details about the inheritance hierarchy, implemented members, static fields, static methods, and instance methods of the `Audience` class."],["There are 47 prior versions of the same class available for reference, from version 0.14.0 up to 0.70.0 (latest)."],["Key features of the `Audience` class involve managing audience properties such as display name, description, membership duration, event triggers, and filter clauses."]]],[]]