Class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaChannelGroup

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/analyticsadmin_v1alpha/classes.rb,
lib/google/apis/analyticsadmin_v1alpha/representations.rb,
lib/google/apis/analyticsadmin_v1alpha/representations.rb

Overview

A resource message representing a Channel Group.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAnalyticsAdminV1alphaChannelGroup

Returns a new instance of GoogleAnalyticsAdminV1alphaChannelGroup.



2033
2034
2035
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2033

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#description ⇒ String

The description of the Channel Group. Max length of 256 characters. Corresponds to the JSON property description

Returns:

  • (String) 


1997
1998
1999
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1997

def description
  @description
end

#display_name ⇒ String

Required. The display name of the Channel Group. Max length of 80 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


2002
2003
2004
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2002

def display_name
  @display_name
end

#grouping_rule ⇒ Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGroupingRule>

Required. The grouping rules of channels. Maximum number of rules is 50. Corresponds to the JSON property groupingRule

Returns:



2007
2008
2009
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2007

def grouping_rule
  @grouping_rule
end

#name ⇒ String

Output only. The resource name for this Channel Group resource. Format: properties/property/channelGroups/channel_group Corresponds to the JSON property name

Returns:

  • (String) 


2013
2014
2015
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2013

def name
  @name
end

#primary ⇒ Boolean Also known as: primary?

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. Corresponds to the JSON property primary

Returns:

  • (Boolean) 


2022
2023
2024
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2022

def primary
  @primary
end

#system_defined ⇒ Boolean Also known as: system_defined?

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. Corresponds to the JSON property systemDefined

Returns:

  • (Boolean) 


2030
2031
2032
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2030

def system_defined
  @system_defined
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2038
2039
2040
2041
2042
2043
2044
2045
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2038

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @grouping_rule = args[:grouping_rule] if args.key?(:grouping_rule)
  @name = args[:name] if args.key?(:name)
  @primary = args[:primary] if args.key?(:primary)
  @system_defined = args[:system_defined] if args.key?(:system_defined)
end