public interface AudienceOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAdsPersonalizationEnabled()
public abstract 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. |
getDescription()
public abstract String getDescription()Required. The description of the Audience.
string description = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public abstract 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 abstract 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 abstract 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 abstract 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. |
getEventTriggerOrBuilder()
public abstract 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 abstract 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 abstract 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 abstract 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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
AudienceFilterClause |
|
getFilterClausesCount()
public abstract 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 | |
|---|---|
| Type | Description |
int |
|
getFilterClausesList()
public abstract 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 | |
|---|---|
| Type | Description |
List<AudienceFilterClause> |
|
getFilterClausesOrBuilder(int index)
public abstract 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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
AudienceFilterClauseOrBuilder |
|
getFilterClausesOrBuilderList()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |