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

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

Represents a Google Tag Manager Variable.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Variable

Returns a new instance of Variable.



2439
2440
2441
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2439

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


2336
2337
2338
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2336

def 
  @account_id
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


2341
2342
2343
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2341

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. @ mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update Corresponds to the JSON property disablingTriggerId

Returns:

  • (Array<String>) 


2350
2351
2352
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2350

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. @ mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update Corresponds to the JSON property enablingTriggerId

Returns:

  • (Array<String>) 


2359
2360
2361
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2359

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) 


2365
2366
2367
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2365

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:



2370
2371
2372
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2370

def format_value
  @format_value
end

#name ⇒ String

Variable display name. @mutable tagmanager.accounts.containers.workspaces. variables.create @mutable tagmanager.accounts.containers.workspaces.variables. update Corresponds to the JSON property name

Returns:

  • (String) 


2377
2378
2379
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2377

def name
  @name
end

#notes ⇒ String

User notes on how to apply this variable in the container. @mutable tagmanager. accounts.containers.workspaces.variables.create @mutable tagmanager.accounts. containers.workspaces.variables.update Corresponds to the JSON property notes

Returns:

  • (String) 


2384
2385
2386
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2384

def notes
  @notes
end

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

The variable's parameters. @mutable tagmanager.accounts.containers.workspaces. variables.create @mutable tagmanager.accounts.containers.workspaces.variables. update Corresponds to the JSON property parameter

Returns:



2391
2392
2393
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2391

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


2396
2397
2398
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2396

def parent_folder_id
  @parent_folder_id
end

#path ⇒ String

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

Returns:

  • (String) 


2401
2402
2403
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2401

def path
  @path
end

#schedule_end_ms ⇒ Fixnum

The end timestamp in milliseconds to schedule a variable. @mutable tagmanager. accounts.containers.workspaces.variables.create @mutable tagmanager.accounts. containers.workspaces.variables.update Corresponds to the JSON property scheduleEndMs

Returns:

  • (Fixnum) 


2408
2409
2410
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2408

def schedule_end_ms
  @schedule_end_ms
end

#schedule_start_ms ⇒ Fixnum

The start timestamp in milliseconds to schedule a variable. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager. accounts.containers.workspaces.variables.update Corresponds to the JSON property scheduleStartMs

Returns:

  • (Fixnum) 


2415
2416
2417
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2415

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) 


2420
2421
2422
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2420

def tag_manager_url
  @tag_manager_url
end

#type ⇒ String

GTM Variable Type. @mutable tagmanager.accounts.containers.workspaces. variables.create @mutable tagmanager.accounts.containers.workspaces.variables. update Corresponds to the JSON property type

Returns:

  • (String) 


2427
2428
2429
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2427

def type
  @type
end

#variable_id ⇒ String

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

Returns:

  • (String) 


2432
2433
2434
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2432

def variable_id
  @variable_id
end

#workspace_id ⇒ String

GTM Workspace ID. Corresponds to the JSON property workspaceId

Returns:

  • (String) 


2437
2438
2439
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2437

def workspace_id
  @workspace_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2444

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