Class: Google::Apis::TagmanagerV2::Trigger

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 Trigger

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

Returns a new instance of Trigger



1942
1943
1944
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1942

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


1784
1785
1786
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1784

def 
  @account_id
end

#auto_event_filter ⇒ Array<Google::Apis::TagmanagerV2::Condition>

Used in the case of auto event tracking. Corresponds to the JSON property autoEventFilter

Returns:



1789
1790
1791
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1789

def auto_event_filter
  @auto_event_filter
end

#check_validation ⇒ Google::Apis::TagmanagerV2::Parameter

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

Returns:



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

def check_validation
  @check_validation
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


1799
1800
1801
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1799

def container_id
  @container_id
end

#continuous_time_min_milliseconds ⇒ Google::Apis::TagmanagerV2::Parameter

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

Returns:



1804
1805
1806
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1804

def continuous_time_min_milliseconds
  @continuous_time_min_milliseconds
end

#custom_event_filter ⇒ Array<Google::Apis::TagmanagerV2::Condition>

Used in the case of custom event, which is fired iff all Conditions are true. Corresponds to the JSON property customEventFilter

Returns:



1809
1810
1811
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1809

def custom_event_filter
  @custom_event_filter
end

#event_name ⇒ Google::Apis::TagmanagerV2::Parameter

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

Returns:



1814
1815
1816
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1814

def event_name
  @event_name
end

#filter ⇒ Array<Google::Apis::TagmanagerV2::Condition>

The trigger will only fire iff all Conditions are true. Corresponds to the JSON property filter

Returns:



1819
1820
1821
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1819

def filter
  @filter
end

#fingerprint ⇒ String

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

Returns:

  • (String) 


1825
1826
1827
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1825

def fingerprint
  @fingerprint
end

#horizontal_scroll_percentage_list ⇒ Google::Apis::TagmanagerV2::Parameter

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

Returns:



1830
1831
1832
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1830

def horizontal_scroll_percentage_list
  @horizontal_scroll_percentage_list
end

#interval ⇒ Google::Apis::TagmanagerV2::Parameter

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

Returns:



1835
1836
1837
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1835

def interval
  @interval
end

#interval_seconds ⇒ Google::Apis::TagmanagerV2::Parameter

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

Returns:



1840
1841
1842
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1840

def interval_seconds
  @interval_seconds
end

#limit ⇒ Google::Apis::TagmanagerV2::Parameter

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

Returns:



1845
1846
1847
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1845

def limit
  @limit
end

#max_timer_length_seconds ⇒ Google::Apis::TagmanagerV2::Parameter

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

Returns:



1850
1851
1852
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1850

def max_timer_length_seconds
  @max_timer_length_seconds
end

#name ⇒ String

Trigger display name. Corresponds to the JSON property name

Returns:

  • (String) 


1855
1856
1857
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1855

def name
  @name
end

#notes ⇒ String

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

Returns:

  • (String) 


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

def notes
  @notes
end

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

Additional parameters. Corresponds to the JSON property parameter

Returns:



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

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


1870
1871
1872
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1870

def parent_folder_id
  @parent_folder_id
end

#path ⇒ String

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

Returns:

  • (String) 


1875
1876
1877
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1875

def path
  @path
end

#selector ⇒ Google::Apis::TagmanagerV2::Parameter

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

Returns:



1880
1881
1882
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1880

def selector
  @selector
end

#tag_manager_url ⇒ String

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

Returns:

  • (String) 


1885
1886
1887
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1885

def tag_manager_url
  @tag_manager_url
end

#total_time_min_milliseconds ⇒ Google::Apis::TagmanagerV2::Parameter

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

Returns:



1890
1891
1892
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1890

def total_time_min_milliseconds
  @total_time_min_milliseconds
end

#trigger_id ⇒ String

The Trigger ID uniquely identifies the GTM Trigger. Corresponds to the JSON property triggerId

Returns:

  • (String) 


1895
1896
1897
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1895

def trigger_id
  @trigger_id
end

#type ⇒ String

Defines the data layer event that causes this trigger. Corresponds to the JSON property type

Returns:

  • (String) 


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

def type
  @type
end

#unique_trigger_id ⇒ Google::Apis::TagmanagerV2::Parameter

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

Returns:



1905
1906
1907
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1905

def unique_trigger_id
  @unique_trigger_id
end

#vertical_scroll_percentage_list ⇒ Google::Apis::TagmanagerV2::Parameter

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

Returns:



1910
1911
1912
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1910

def vertical_scroll_percentage_list
  @vertical_scroll_percentage_list
end

#visibility_selector ⇒ Google::Apis::TagmanagerV2::Parameter

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

Returns:



1915
1916
1917
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1915

def visibility_selector
  @visibility_selector
end

#visible_percentage_max ⇒ Google::Apis::TagmanagerV2::Parameter

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

Returns:



1920
1921
1922
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1920

def visible_percentage_max
  @visible_percentage_max
end

#visible_percentage_min ⇒ Google::Apis::TagmanagerV2::Parameter

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

Returns:



1925
1926
1927
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1925

def visible_percentage_min
  @visible_percentage_min
end

#wait_for_tags ⇒ Google::Apis::TagmanagerV2::Parameter

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

Returns:



1930
1931
1932
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1930

def wait_for_tags
  @wait_for_tags
end

#wait_for_tags_timeout ⇒ Google::Apis::TagmanagerV2::Parameter

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

Returns:



1935
1936
1937
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1935

def wait_for_tags_timeout
  @wait_for_tags_timeout
end

#workspace_id ⇒ String

GTM Workspace ID. Corresponds to the JSON property workspaceId

Returns:

  • (String) 


1940
1941
1942
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1940

def workspace_id
  @workspace_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1947

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @auto_event_filter = args[:auto_event_filter] if args.key?(:auto_event_filter)
  @check_validation = args[:check_validation] if args.key?(:check_validation)
  @container_id = args[:container_id] if args.key?(:container_id)
  @continuous_time_min_milliseconds = args[:continuous_time_min_milliseconds] if args.key?(:continuous_time_min_milliseconds)
  @custom_event_filter = args[:custom_event_filter] if args.key?(:custom_event_filter)
  @event_name = args[:event_name] if args.key?(:event_name)
  @filter = args[:filter] if args.key?(:filter)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @horizontal_scroll_percentage_list = args[:horizontal_scroll_percentage_list] if args.key?(:horizontal_scroll_percentage_list)
  @interval = args[:interval] if args.key?(:interval)
  @interval_seconds = args[:interval_seconds] if args.key?(:interval_seconds)
  @limit = args[:limit] if args.key?(:limit)
  @max_timer_length_seconds = args[:max_timer_length_seconds] if args.key?(:max_timer_length_seconds)
  @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)
  @selector = args[:selector] if args.key?(:selector)
  @tag_manager_url = args[:tag_manager_url] if args.key?(:tag_manager_url)
  @total_time_min_milliseconds = args[:total_time_min_milliseconds] if args.key?(:total_time_min_milliseconds)
  @trigger_id = args[:trigger_id] if args.key?(:trigger_id)
  @type = args[:type] if args.key?(:type)
  @unique_trigger_id = args[:unique_trigger_id] if args.key?(:unique_trigger_id)
  @vertical_scroll_percentage_list = args[:vertical_scroll_percentage_list] if args.key?(:vertical_scroll_percentage_list)
  @visibility_selector = args[:visibility_selector] if args.key?(:visibility_selector)
  @visible_percentage_max = args[:visible_percentage_max] if args.key?(:visible_percentage_max)
  @visible_percentage_min = args[:visible_percentage_min] if args.key?(:visible_percentage_min)
  @wait_for_tags = args[:wait_for_tags] if args.key?(:wait_for_tags)
  @wait_for_tags_timeout = args[:wait_for_tags_timeout] if args.key?(:wait_for_tags_timeout)
  @workspace_id = args[:workspace_id] if args.key?(:workspace_id)
end