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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/tagmanager_v2/classes.rb,
generated/google/apis/tagmanager_v2/representations.rb,
generated/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 propeties 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.



142
143
144
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 142

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

Instance Attribute Details

#account_idString

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String)


113
114
115
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 113

def 
  @account_id
end

#container_idString

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String)


118
119
120
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 118

def container_id
  @container_id
end

#nameString

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

Returns:

  • (String)


123
124
125
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 123

def name
  @name
end

#pathString

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

Returns:

  • (String)


128
129
130
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 128

def path
  @path
end

#typeString

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)


135
136
137
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 135

def type
  @type
end

#workspace_idString

GTM Workspace ID. Corresponds to the JSON property workspaceId

Returns:

  • (String)


140
141
142
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 140

def workspace_id
  @workspace_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



147
148
149
150
151
152
153
154
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 147

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