Class: Google::Apis::TagmanagerV2::Variable

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

Represents a Google Tag Manager Variable.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Variable

Returns a new instance of Variable



2278
2279
2280
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2278

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


2191
2192
2193
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2191

def 
  @account_id
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


2196
2197
2198
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2196

def container_id
  @container_id
end

#disabling_trigger_id ⇒ Array<String>

For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set. Corresponds to the JSON property disablingTriggerId

Returns:

  • (Array<String>) 


2203
2204
2205
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2203

def disabling_trigger_id
  @disabling_trigger_id
end

#enabling_trigger_id ⇒ Array<String>

For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set. Corresponds to the JSON property enablingTriggerId

Returns:

  • (Array<String>) 


2210
2211
2212
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2210

def enabling_trigger_id
  @enabling_trigger_id
end

#fingerprint ⇒ String

The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified. Corresponds to the JSON property fingerprint

Returns:

  • (String) 


2216
2217
2218
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2216

def fingerprint
  @fingerprint
end

#format_value ⇒ Google::Apis::TagmanagerV2::VariableFormatValue

Option to convert a variable value to other value. Corresponds to the JSON property formatValue

Returns:



2221
2222
2223
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2221

def format_value
  @format_value
end

#name ⇒ String

Variable display name. Corresponds to the JSON property name

Returns:

  • (String) 


2226
2227
2228
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2226

def name
  @name
end

#notes ⇒ String

User notes on how to apply this variable in the container. Corresponds to the JSON property notes

Returns:

  • (String) 


2231
2232
2233
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2231

def notes
  @notes
end

#parameter ⇒ Array<Google::Apis::TagmanagerV2::Parameter>

The variable's parameters. Corresponds to the JSON property parameter

Returns:



2236
2237
2238
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2236

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


2241
2242
2243
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2241

def parent_folder_id
  @parent_folder_id
end

#path ⇒ String

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

Returns:

  • (String) 


2246
2247
2248
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2246

def path
  @path
end

#schedule_end_ms ⇒ Fixnum

The end timestamp in milliseconds to schedule a variable. Corresponds to the JSON property scheduleEndMs

Returns:

  • (Fixnum) 


2251
2252
2253
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2251

def schedule_end_ms
  @schedule_end_ms
end

#schedule_start_ms ⇒ Fixnum

The start timestamp in milliseconds to schedule a variable. Corresponds to the JSON property scheduleStartMs

Returns:

  • (Fixnum) 


2256
2257
2258
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2256

def schedule_start_ms
  @schedule_start_ms
end

#tag_manager_url ⇒ String

Auto generated link to the tag manager UI Corresponds to the JSON property tagManagerUrl

Returns:

  • (String) 


2261
2262
2263
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2261

def tag_manager_url
  @tag_manager_url
end

#type ⇒ String

GTM Variable Type. Corresponds to the JSON property type

Returns:

  • (String) 


2266
2267
2268
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2266

def type
  @type
end

#variable_id ⇒ String

The Variable ID uniquely identifies the GTM Variable. Corresponds to the JSON property variableId

Returns:

  • (String) 


2271
2272
2273
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2271

def variable_id
  @variable_id
end

#workspace_id ⇒ String

GTM Workspace ID. Corresponds to the JSON property workspaceId

Returns:

  • (String) 


2276
2277
2278
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2276

def workspace_id
  @workspace_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2283

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @container_id = args[:container_id] if args.key?(:container_id)
  @disabling_trigger_id = args[:disabling_trigger_id] if args.key?(:disabling_trigger_id)
  @enabling_trigger_id = args[:enabling_trigger_id] if args.key?(:enabling_trigger_id)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @format_value = args[:format_value] if args.key?(:format_value)
  @name = args[:name] if args.key?(:name)
  @notes = args[:notes] if args.key?(:notes)
  @parameter = args[:parameter] if args.key?(:parameter)
  @parent_folder_id = args[:parent_folder_id] if args.key?(:parent_folder_id)
  @path = args[:path] if args.key?(:path)
  @schedule_end_ms = args[:schedule_end_ms] if args.key?(:schedule_end_ms)
  @schedule_start_ms = args[:schedule_start_ms] if args.key?(:schedule_start_ms)
  @tag_manager_url = args[:tag_manager_url] if args.key?(:tag_manager_url)
  @type = args[:type] if args.key?(:type)
  @variable_id = args[:variable_id] if args.key?(:variable_id)
  @workspace_id = args[:workspace_id] if args.key?(:workspace_id)
end