Package com.google.analytics.admin.v1alpha

Interface AudienceOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Audience, Audience.Builder
@Generated public interface AudienceOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • getDisplayName

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

    • getDisplayNameBytes

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

    • getDescription

      String getDescription()
       Required. The description of the Audience.
      string description = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The description.

    • getDescriptionBytes

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

    • getMembershipDurationDays

      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:
      The membershipDurationDays.

    • getAdsPersonalizationEnabled

      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:
      The adsPersonalizationEnabled.

    • hasEventTrigger

      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:
      Whether the eventTrigger field is set.

    • getEventTrigger

      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:
      The eventTrigger.

    • getEventTriggerOrBuilder

      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];

    • getExclusionDurationModeValue

      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:
      The enum numeric value on the wire for exclusionDurationMode.

    • getExclusionDurationMode

      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:
      The exclusionDurationMode.

    • getFilterClausesList

      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];

    • getFilterClauses

      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];

    • getFilterClausesCount

      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];

    • getFilterClausesOrBuilderList

      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];

    • getFilterClausesOrBuilder

      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];

    • hasCreateTime

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

    • getCreateTime

      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];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      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];