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.



1703
1704
1705
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1703

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

Instance Attribute Details

#account_idString

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String)


1620
1621
1622
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1620

def 
  @account_id
end

#container_idString

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String)


1625
1626
1627
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1625

def container_id
  @container_id
end

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


1634
1635
1636
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1634

def disabling_trigger_id
  @disabling_trigger_id
end

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


1643
1644
1645
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1643

def enabling_trigger_id
  @enabling_trigger_id
end

#fingerprintString

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)


1649
1650
1651
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1649

def fingerprint
  @fingerprint
end

#nameString

Variable display name. Corresponds to the JSON property name

Returns:

  • (String)


1656
1657
1658
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1656

def name
  @name
end

#notesString

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

Returns:

  • (String)


1663
1664
1665
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1663

def notes
  @notes
end

#parameterArray<Google::Apis::TagmanagerV1::Parameter>

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



1670
1671
1672
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1670

def parameter
  @parameter
end

#parent_folder_idString

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String)


1675
1676
1677
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1675

def parent_folder_id
  @parent_folder_id
end

#schedule_end_msFixnum

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

Returns:

  • (Fixnum)


1682
1683
1684
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1682

def schedule_end_ms
  @schedule_end_ms
end

#schedule_start_msFixnum

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

Returns:

  • (Fixnum)


1689
1690
1691
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1689

def schedule_start_ms
  @schedule_start_ms
end

#typeString

GTM Variable Type. Corresponds to the JSON property type

Returns:

  • (String)


1696
1697
1698
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1696

def type
  @type
end

#variable_idString

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

Returns:

  • (String)


1701
1702
1703
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1701

def variable_id
  @variable_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1708

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