Class: Google::Apis::TagmanagerV2::Tag

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 Tag.

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

Returns a new instance of Tag



1794
1795
1796
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1794

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


1669
1670
1671
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1669

def 
  @account_id
end

#blocking_rule_id ⇒ Array<String>

Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire. Corresponds to the JSON property blockingRuleId

Returns:

  • (Array<String>) 


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

def blocking_rule_id
  @blocking_rule_id
end

#blocking_trigger_id ⇒ Array<String>

Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. Corresponds to the JSON property blockingTriggerId

Returns:

  • (Array<String>) 


1681
1682
1683
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1681

def blocking_trigger_id
  @blocking_trigger_id
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


1686
1687
1688
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1686

def container_id
  @container_id
end

#fingerprint ⇒ String

The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified. Corresponds to the JSON property fingerprint

Returns:

  • (String) 


1692
1693
1694
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1692

def fingerprint
  @fingerprint
end

#firing_rule_id ⇒ Array<String>

Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false. Corresponds to the JSON property firingRuleId

Returns:

  • (Array<String>) 


1698
1699
1700
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1698

def firing_rule_id
  @firing_rule_id
end

#firing_trigger_id ⇒ Array<String>

Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false. Corresponds to the JSON property firingTriggerId

Returns:

  • (Array<String>) 


1704
1705
1706
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1704

def firing_trigger_id
  @firing_trigger_id
end

#live_only ⇒ Boolean Also known as: live_only?

If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode). Corresponds to the JSON property liveOnly

Returns:

  • (Boolean) 


1710
1711
1712
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1710

def live_only
  @live_only
end

#name ⇒ String

Tag display name. Corresponds to the JSON property name

Returns:

  • (String) 


1716
1717
1718
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1716

def name
  @name
end

#notes ⇒ String

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

Returns:

  • (String) 


1721
1722
1723
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1721

def notes
  @notes
end

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

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

Returns:



1726
1727
1728
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1726

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


1731
1732
1733
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1731

def parent_folder_id
  @parent_folder_id
end

#path ⇒ String

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

Returns:

  • (String) 


1736
1737
1738
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1736

def path
  @path
end

#paused ⇒ Boolean Also known as: paused?

Indicates whether the tag is paused, which prevents the tag from firing. Corresponds to the JSON property paused

Returns:

  • (Boolean) 


1741
1742
1743
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1741

def paused
  @paused
end

#priority ⇒ Google::Apis::TagmanagerV2::Parameter

Represents a Google Tag Manager Parameter. Corresponds to the JSON property priority

Returns:



1747
1748
1749
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1747

def priority
  @priority
end

#schedule_end_ms ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1752
1753
1754
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1752

def schedule_end_ms
  @schedule_end_ms
end

#schedule_start_ms ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1757
1758
1759
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1757

def schedule_start_ms
  @schedule_start_ms
end

#setup_tag ⇒ Array<Google::Apis::TagmanagerV2::SetupTag>

The list of setup tags. Currently we only allow one. Corresponds to the JSON property setupTag

Returns:



1762
1763
1764
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1762

def setup_tag
  @setup_tag
end

#tag_firing_option ⇒ String

Option to fire this tag. Corresponds to the JSON property tagFiringOption

Returns:

  • (String) 


1767
1768
1769
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1767

def tag_firing_option
  @tag_firing_option
end

#tag_id ⇒ String

The Tag ID uniquely identifies the GTM Tag. Corresponds to the JSON property tagId

Returns:

  • (String) 


1772
1773
1774
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1772

def tag_id
  @tag_id
end

#tag_manager_url ⇒ String

Auto generated link to the tag manager UI Corresponds to the JSON property tagManagerUrl

Returns:

  • (String) 


1777
1778
1779
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1777

def tag_manager_url
  @tag_manager_url
end

#teardown_tag ⇒ Array<Google::Apis::TagmanagerV2::TeardownTag>

The list of teardown tags. Currently we only allow one. Corresponds to the JSON property teardownTag

Returns:



1782
1783
1784
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1782

def teardown_tag
  @teardown_tag
end

#type ⇒ String

GTM Tag Type. Corresponds to the JSON property type

Returns:

  • (String) 


1787
1788
1789
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1787

def type
  @type
end

#workspace_id ⇒ String

GTM Workspace ID. Corresponds to the JSON property workspaceId

Returns:

  • (String) 


1792
1793
1794
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1792

def workspace_id
  @workspace_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1799

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @blocking_rule_id = args[:blocking_rule_id] if args.key?(:blocking_rule_id)
  @blocking_trigger_id = args[:blocking_trigger_id] if args.key?(:blocking_trigger_id)
  @container_id = args[:container_id] if args.key?(:container_id)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @firing_rule_id = args[:firing_rule_id] if args.key?(:firing_rule_id)
  @firing_trigger_id = args[:firing_trigger_id] if args.key?(:firing_trigger_id)
  @live_only = args[:live_only] if args.key?(:live_only)
  @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)
  @paused = args[:paused] if args.key?(:paused)
  @priority = args[:priority] if args.key?(:priority)
  @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)
  @setup_tag = args[:setup_tag] if args.key?(:setup_tag)
  @tag_firing_option = args[:tag_firing_option] if args.key?(:tag_firing_option)
  @tag_id = args[:tag_id] if args.key?(:tag_id)
  @tag_manager_url = args[:tag_manager_url] if args.key?(:tag_manager_url)
  @teardown_tag = args[:teardown_tag] if args.key?(:teardown_tag)
  @type = args[:type] if args.key?(:type)
  @workspace_id = args[:workspace_id] if args.key?(:workspace_id)
end