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 \ V1alphaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group} |
↳ display_name |
string
Required. The display name of the Channel Group. Max length of 80 characters. |
↳ description |
string
The description of the Channel Group. Max length of 256 characters. |
↳ grouping_rule |
array<Google\Analytics\Admin\V1alpha\GroupingRule>
Required. The grouping rules of channels. Maximum number of rules is 50. |
↳ system_defined |
bool
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. |
getName
Output only. The resource name for this Channel Group resource.
Format: properties/{property}/channelGroups/{channel_group}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Output only. The resource name for this Channel Group resource.
Format: properties/{property}/channelGroups/{channel_group}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Required. The display name of the Channel Group. Max length of 80 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Required. The display name of the Channel Group. Max length of 80 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
The description of the Channel Group. Max length of 256 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
The description of the Channel Group. Max length of 256 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGroupingRule
Required. The grouping rules of channels. Maximum number of rules is 50.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setGroupingRule
Required. The grouping rules of channels. Maximum number of rules is 50.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Analytics\Admin\V1alpha\GroupingRule>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setSystemDefined
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|