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

Constructor Details

#initialize(**args) ⇒ Variable

Returns a new instance of Variable.



2431
2432
2433
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2431

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


2328
2329
2330
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2328

def 
  @account_id
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


2333
2334
2335
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2333

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>) 


2342
2343
2344
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2342

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>) 


2351
2352
2353
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2351

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) 


2357
2358
2359
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2357

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:



2362
2363
2364
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2362

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) 


2369
2370
2371
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2369

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) 


2376
2377
2378
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2376

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:



2383
2384
2385
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2383

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


2388
2389
2390
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2388

def parent_folder_id
  @parent_folder_id
end

#path ⇒ String

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

Returns:

  • (String) 


2393
2394
2395
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2393

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) 


2400
2401
2402
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2400

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) 


2407
2408
2409
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2407

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) 


2412
2413
2414
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2412

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) 


2419
2420
2421
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2419

def type
  @type
end

#variable_id ⇒ String

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

Returns:

  • (String) 


2424
2425
2426
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2424

def variable_id
  @variable_id
end

#workspace_id ⇒ String

GTM Workspace ID. Corresponds to the JSON property workspaceId

Returns:

  • (String) 


2429
2430
2431
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2429

def workspace_id
  @workspace_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2436

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