Class: Google::Apis::TagmanagerV1::Variable

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



1534
1535
1536
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1534

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


1467
1468
1469
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1467

def 
  @account_id
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


1472
1473
1474
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1472

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


1479
1480
1481
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1479

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


1486
1487
1488
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1486

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) 


1492
1493
1494
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1492

def fingerprint
  @fingerprint
end

#name ⇒ String

Variable display name. Corresponds to the JSON property name

Returns:

  • (String) 


1497
1498
1499
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1497

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) 


1502
1503
1504
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1502

def notes
  @notes
end

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

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

Returns:



1507
1508
1509
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1507

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


1512
1513
1514
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1512

def parent_folder_id
  @parent_folder_id
end

#schedule_end_ms ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1517
1518
1519
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1517

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) 


1522
1523
1524
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1522

def schedule_start_ms
  @schedule_start_ms
end

#type ⇒ String

GTM Variable Type. Corresponds to the JSON property type

Returns:

  • (String) 


1527
1528
1529
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1527

def type
  @type
end

#variable_id ⇒ String

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

Returns:

  • (String) 


1532
1533
1534
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1532

def variable_id
  @variable_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1539

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)
  @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)
  @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)
  @type = args[:type] if args.key?(:type)
  @variable_id = args[:variable_id] if args.key?(:variable_id)
end