Class: Google::Apis::TagmanagerV2::BuiltInVariable

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

Overview

Built-in variables are a special category of variables that are pre-created and non-customizable. They provide common functionality like accessing properties of the gtm data layer, monitoring clicks, or accessing elements of a page URL.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BuiltInVariable

Returns a new instance of BuiltInVariable.



175
176
177
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 175

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


146
147
148
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 146

def 
  @account_id
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


151
152
153
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 151

def container_id
  @container_id
end

#name ⇒ String

Name of the built-in variable to be used to refer to the built-in variable. Corresponds to the JSON property name

Returns:

  • (String) 


156
157
158
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 156

def name
  @name
end

#path ⇒ String

GTM BuiltInVariable's API relative path. Corresponds to the JSON property path

Returns:

  • (String) 


161
162
163
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 161

def path
  @path
end

#type ⇒ String

Type of built-in variable. @required.tagmanager.accounts.containers.workspaces. built_in_variable.update @mutable tagmanager.accounts.containers.workspaces. built_in_variable.update Corresponds to the JSON property type

Returns:

  • (String) 


168
169
170
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 168

def type
  @type
end

#workspace_id ⇒ String

GTM Workspace ID. Corresponds to the JSON property workspaceId

Returns:

  • (String) 


173
174
175
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 173

def workspace_id
  @workspace_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



180
181
182
183
184
185
186
187
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 180

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @container_id = args[:container_id] if args.key?(:container_id)
  @name = args[:name] if args.key?(:name)
  @path = args[:path] if args.key?(:path)
  @type = args[:type] if args.key?(:type)
  @workspace_id = args[:workspace_id] if args.key?(:workspace_id)
end