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.



2054
2055
2056
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2054

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


1892
1893
1894
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1892

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


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

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


1906
1907
1908
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1906

def blocking_trigger_id
  @blocking_trigger_id
end

#consent_settings ⇒ Google::Apis::TagmanagerV2::TagConsentSetting

Consent settings of a tag. @mutable tagmanager.accounts.containers.workspaces. tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update Corresponds to the JSON property consentSettings

Returns:



1912
1913
1914
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1912

def consent_settings
  @consent_settings
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


1917
1918
1919
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1917

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) 


1923
1924
1925
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1923

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


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

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


1939
1940
1941
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1939

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) 


1946
1947
1948
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1946

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:



1952
1953
1954
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1952

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) 


1960
1961
1962
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1960

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) 


1966
1967
1968
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1966

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) 


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

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:



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

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


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

def parent_folder_id
  @parent_folder_id
end

#path ⇒ String

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

Returns:

  • (String) 


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

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) 


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

def paused
  @paused
end

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

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

Returns:



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

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) 


2009
2010
2011
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2009

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) 


2016
2017
2018
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2016

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:



2021
2022
2023
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2021

def setup_tag
  @setup_tag
end

#tag_firing_option ⇒ String

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

Returns:

  • (String) 


2026
2027
2028
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2026

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) 


2031
2032
2033
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2031

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) 


2036
2037
2038
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2036

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:



2041
2042
2043
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2041

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) 


2047
2048
2049
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2047

def type
  @type
end

#workspace_id ⇒ String

GTM Workspace ID. Corresponds to the JSON property workspaceId

Returns:

  • (String) 


2052
2053
2054
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2052

def workspace_id
  @workspace_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2059

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