Google Analytics Admin V1alpha Client - Class ChannelGroup (0.17.0)

Reference documentation and code samples for the Google Analytics Admin V1alpha Client class ChannelGroup.

A resource message representing a Channel Group.

Generated from protobuf message google.analytics.admin.v1alpha.ChannelGroup

Namespace

Google \ Analytics \ Admin \ V1alpha

Methods

__construct

Constructor.

Parameters
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ namestring

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

↳ display_namestring

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

↳ descriptionstring

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

↳ grouping_rulearray<Google\Analytics\Admin\V1alpha\GroupingRule>

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

↳ system_definedbool

Output only. Default Channel Group defined by Google, which cannot be updated.

getName

Output only. The resource name for this Channel Group resource.

Format: properties/{property}/channelGroups/{channel_group}

Returns
TypeDescription
string

setName

Output only. The resource name for this Channel Group resource.

Format: properties/{property}/channelGroups/{channel_group}

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getDisplayName

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

Returns
TypeDescription
string

setDisplayName

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

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getDescription

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

Returns
TypeDescription
string

setDescription

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

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getGroupingRule

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setGroupingRule

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

Parameter
NameDescription
vararray<Google\Analytics\Admin\V1alpha\GroupingRule>
Returns
TypeDescription
$this

getSystemDefined

Output only. Default Channel Group defined by Google, which cannot be updated.

Returns
TypeDescription
bool

setSystemDefined

Output only. Default Channel Group defined by Google, which cannot be updated.

Parameter
NameDescription
varbool
Returns
TypeDescription
$this