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



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

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


1618
1619
1620
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1618

def 
  @account_id
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


1623
1624
1625
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1623

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


1632
1633
1634
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1632

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


1641
1642
1643
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1641

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) 


1647
1648
1649
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1647

def fingerprint
  @fingerprint
end

#name ⇒ String

Variable display name. Corresponds to the JSON property name

Returns:

  • (String) 


1654
1655
1656
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1654

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) 


1661
1662
1663
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1661

def notes
  @notes
end

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

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

Returns:



1668
1669
1670
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1668

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


1673
1674
1675
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1673

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) 


1680
1681
1682
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1680

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) 


1687
1688
1689
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1687

def schedule_start_ms
  @schedule_start_ms
end

#type ⇒ String

GTM Variable Type. Corresponds to the JSON property type

Returns:

  • (String) 


1694
1695
1696
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1694

def type
  @type
end

#variable_id ⇒ String

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

Returns:

  • (String) 


1699
1700
1701
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1699

def variable_id
  @variable_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

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