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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/tagmanager_v2/classes.rb,
lib/google/apis/tagmanager_v2/representations.rb,
lib/google/apis/tagmanager_v2/representations.rb

Overview

Represents a Google Tag Manager Tag.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Tag

Returns a new instance of Tag.



2002
2003
2004
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2002

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


1846
1847
1848
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1846

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. @mutable tagmanager.accounts.containers.workspaces.tags.create @ mutable tagmanager.accounts.containers.workspaces.tags.update Corresponds to the JSON property blockingRuleId

Returns:

  • (Array<String>) 


1853
1854
1855
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1853

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. @mutable tagmanager.accounts.containers.workspaces.tags.create @ mutable tagmanager.accounts.containers.workspaces.tags.update Corresponds to the JSON property blockingTriggerId

Returns:

  • (Array<String>) 


1860
1861
1862
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1860

def blocking_trigger_id
  @blocking_trigger_id
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


1865
1866
1867
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1865

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) 


1871
1872
1873
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1871

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. @mutable tagmanager. accounts.containers.workspaces.tags.create @mutable tagmanager.accounts. containers.workspaces.tags.update Corresponds to the JSON property firingRuleId

Returns:

  • (Array<String>) 


1879
1880
1881
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1879

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. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager. accounts.containers.workspaces.tags.update Corresponds to the JSON property firingTriggerId

Returns:

  • (Array<String>) 


1887
1888
1889
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1887

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). @mutable tagmanager.accounts.containers.workspaces. tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update Corresponds to the JSON property liveOnly

Returns:

  • (Boolean) 


1894
1895
1896
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1894

def live_only
  @live_only
end

#monitoring_metadata ⇒ Google::Apis::TagmanagerV2::Parameter

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

Returns:



1900
1901
1902
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1900

def monitoring_metadata
  @monitoring_metadata
end

#monitoring_metadata_tag_name_key ⇒ String

If non-empty, then the tag display name will be included in the monitoring metadata map using the key specified. @mutable tagmanager.accounts.containers. workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags. update Corresponds to the JSON property monitoringMetadataTagNameKey

Returns:

  • (String) 


1908
1909
1910
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1908

def monitoring_metadata_tag_name_key
  @monitoring_metadata_tag_name_key
end

#name ⇒ String

Tag display name. @mutable tagmanager.accounts.containers.workspaces.tags. create @mutable tagmanager.accounts.containers.workspaces.tags.update Corresponds to the JSON property name

Returns:

  • (String) 


1914
1915
1916
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1914

def name
  @name
end

#notes ⇒ String

User notes on how to apply this tag in the container. @mutable tagmanager. accounts.containers.workspaces.tags.create @mutable tagmanager.accounts. containers.workspaces.tags.update Corresponds to the JSON property notes

Returns:

  • (String) 


1921
1922
1923
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1921

def notes
  @notes
end

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

The tag's parameters. @mutable tagmanager.accounts.containers.workspaces.tags. create @mutable tagmanager.accounts.containers.workspaces.tags.update Corresponds to the JSON property parameter

Returns:



1927
1928
1929
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1927

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


1932
1933
1934
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1932

def parent_folder_id
  @parent_folder_id
end

#path ⇒ String

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

Returns:

  • (String) 


1937
1938
1939
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1937

def path
  @path
end

#paused ⇒ Boolean Also known as: paused?

Indicates whether the tag is paused, which prevents the tag from firing. @ mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update Corresponds to the JSON property paused

Returns:

  • (Boolean) 


1944
1945
1946
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1944

def paused
  @paused
end

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

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

Returns:



1950
1951
1952
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1950

def priority
  @priority
end

#schedule_end_ms ⇒ Fixnum

The end timestamp in milliseconds to schedule a tag. @mutable tagmanager. accounts.containers.workspaces.tags.create @mutable tagmanager.accounts. containers.workspaces.tags.update Corresponds to the JSON property scheduleEndMs

Returns:

  • (Fixnum) 


1957
1958
1959
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1957

def schedule_end_ms
  @schedule_end_ms
end

#schedule_start_ms ⇒ Fixnum

The start timestamp in milliseconds to schedule a tag. @mutable tagmanager. accounts.containers.workspaces.tags.create @mutable tagmanager.accounts. containers.workspaces.tags.update Corresponds to the JSON property scheduleStartMs

Returns:

  • (Fixnum) 


1964
1965
1966
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1964

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:



1969
1970
1971
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1969

def setup_tag
  @setup_tag
end

#tag_firing_option ⇒ String

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

Returns:

  • (String) 


1974
1975
1976
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1974

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) 


1979
1980
1981
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1979

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) 


1984
1985
1986
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1984

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:



1989
1990
1991
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1989

def teardown_tag
  @teardown_tag
end

#type ⇒ String

GTM Tag Type. @mutable tagmanager.accounts.containers.workspaces.tags.create @ mutable tagmanager.accounts.containers.workspaces.tags.update Corresponds to the JSON property type

Returns:

  • (String) 


1995
1996
1997
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1995

def type
  @type
end

#workspace_id ⇒ String

GTM Workspace ID. Corresponds to the JSON property workspaceId

Returns:

  • (String) 


2000
2001
2002
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2000

def workspace_id
  @workspace_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2007

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