Interface ChannelGroupOrBuilder (0.65.0) 

public interface ChannelGroupOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDescription()

public abstract String getDescription()

The description of the Channel Group. Max length of 256 characters.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

The description of the Channel Group. Max length of 256 characters.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Required. The display name of the Channel Group. Max length of 80 characters.

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 Channel Group. Max length of 80 characters.

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

Returns
Type Description
ByteString

The bytes for displayName.

getGroupingRule(int index)

public abstract GroupingRule getGroupingRule(int index)

Required. The grouping rules of channels. Maximum number of rules is 50.

repeated .google.analytics.admin.v1alpha.GroupingRule grouping_rule = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
GroupingRule

getGroupingRuleCount()

public abstract int getGroupingRuleCount()

Required. The grouping rules of channels. Maximum number of rules is 50.

repeated .google.analytics.admin.v1alpha.GroupingRule grouping_rule = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getGroupingRuleList()

public abstract List<GroupingRule> getGroupingRuleList()

Required. The grouping rules of channels. Maximum number of rules is 50.

repeated .google.analytics.admin.v1alpha.GroupingRule grouping_rule = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<GroupingRule>

getGroupingRuleOrBuilder(int index)

public abstract GroupingRuleOrBuilder getGroupingRuleOrBuilder(int index)

Required. The grouping rules of channels. Maximum number of rules is 50.

repeated .google.analytics.admin.v1alpha.GroupingRule grouping_rule = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
GroupingRuleOrBuilder

getGroupingRuleOrBuilderList()

public abstract List<? extends GroupingRuleOrBuilder> getGroupingRuleOrBuilderList()

Required. The grouping rules of channels. Maximum number of rules is 50.

repeated .google.analytics.admin.v1alpha.GroupingRule grouping_rule = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.analytics.admin.v1alpha.GroupingRuleOrBuilder>

getName()

public abstract String getName()

Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group}

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 Channel Group resource. Format: properties/{property}/channelGroups/{channel_group}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getPrimary()

public abstract boolean getPrimary()

Optional. If true, this channel group will be used as the default channel group for reports. Only one channel group can be set as primary at any time. If the primary field gets set on a channel group, it will get unset on the previous primary channel group.

The Google Analytics predefined channel group is the primary by default.

bool primary = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The primary.

getSystemDefined()

public abstract boolean getSystemDefined()

Output only. If true, then this channel group is the Default Channel Group predefined by Google Analytics. Display name and grouping rules cannot be updated for this channel group.

bool system_defined = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The systemDefined.