Package com.google.analytics.admin.v1alpha

Class Audience

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.analytics.admin.v1alpha.Audience
All Implemented Interfaces:
AudienceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Audience extends com.google.protobuf.GeneratedMessage implements AudienceOrBuilder
 A resource message representing an Audience.
Protobuf type google.analytics.admin.v1alpha.Audience
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • MEMBERSHIP_DURATION_DAYS_FIELD_NUMBER

      public static final int MEMBERSHIP_DURATION_DAYS_FIELD_NUMBER
      See Also:

    • ADS_PERSONALIZATION_ENABLED_FIELD_NUMBER

      public static final int ADS_PERSONALIZATION_ENABLED_FIELD_NUMBER
      See Also:

    • EVENT_TRIGGER_FIELD_NUMBER

      public static final int EVENT_TRIGGER_FIELD_NUMBER
      See Also:

    • EXCLUSION_DURATION_MODE_FIELD_NUMBER

      public static final int EXCLUSION_DURATION_MODE_FIELD_NUMBER
      See Also:

    • FILTER_CLAUSES_FIELD_NUMBER

      public static final int FILTER_CLAUSES_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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];
      Specified by:
      getName in interface AudienceOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.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];
      Specified by:
      getNameBytes in interface AudienceOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       Required. The display name of the Audience.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayName in interface AudienceOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The display name of the Audience.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayNameBytes in interface AudienceOrBuilder
      Returns:
      The bytes for displayName.

    • getDescription

      public String getDescription()
       Required. The description of the Audience.
      string description = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDescription in interface AudienceOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Required. The description of the Audience.
      string description = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDescriptionBytes in interface AudienceOrBuilder
      Returns:
      The bytes for description.

    • 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];
      Specified by:
      getMembershipDurationDays in interface AudienceOrBuilder
      Returns:
      The membershipDurationDays.

    • 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];
      Specified by:
      getAdsPersonalizationEnabled in interface AudienceOrBuilder
      Returns:
      The adsPersonalizationEnabled.

    • 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];
      Specified by:
      hasEventTrigger in interface AudienceOrBuilder
      Returns:
      Whether the eventTrigger field is set.

    • 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];
      Specified by:
      getEventTrigger in interface AudienceOrBuilder
      Returns:
      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];
      Specified by:
      getEventTriggerOrBuilder in interface AudienceOrBuilder

    • 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];
      Specified by:
      getExclusionDurationModeValue in interface AudienceOrBuilder
      Returns:
      The enum numeric value on the wire for exclusionDurationMode.

    • 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];
      Specified by:
      getExclusionDurationMode in interface AudienceOrBuilder
      Returns:
      The exclusionDurationMode.

    • 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];
      Specified by:
      getFilterClausesList in interface AudienceOrBuilder

    • 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];
      Specified by:
      getFilterClausesOrBuilderList in interface AudienceOrBuilder

    • 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];
      Specified by:
      getFilterClausesCount in interface AudienceOrBuilder

    • getFilterClauses

      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];
      Specified by:
      getFilterClauses in interface AudienceOrBuilder

    • getFilterClausesOrBuilder

      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];
      Specified by:
      getFilterClausesOrBuilder in interface AudienceOrBuilder

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Time when the Audience was created.
      .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface AudienceOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Time when the Audience was created.
      .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface AudienceOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Time when the Audience was created.
      .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface AudienceOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Audience parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Audience parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Audience parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Audience parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Audience parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Audience parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Audience parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Audience parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Audience parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Audience parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Audience parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Audience parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Audience.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Audience.Builder newBuilder()

    • newBuilder

      public static Audience.Builder newBuilder(Audience prototype)

    • toBuilder

      public Audience.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Audience.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Audience getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Audience> parser()

    • getParserForType

      public com.google.protobuf.Parser<Audience> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Audience getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder