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



1949
1950
1951
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1949

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


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

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:



1796
1797
1798
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1796

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:



1801
1802
1803
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1801

def check_validation
  @check_validation
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


1806
1807
1808
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1806

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:



1811
1812
1813
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1811

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:



1816
1817
1818
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1816

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:



1821
1822
1823
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1821

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:



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

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) 


1832
1833
1834
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1832

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:



1837
1838
1839
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1837

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:



1842
1843
1844
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1842

def interval
  @interval
end

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

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

Returns:



1847
1848
1849
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1847

def interval_seconds
  @interval_seconds
end

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

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

Returns:



1852
1853
1854
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1852

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:



1857
1858
1859
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1857

def max_timer_length_seconds
  @max_timer_length_seconds
end

#name ⇒ String

Trigger display name. Corresponds to the JSON property name

Returns:

  • (String) 


1862
1863
1864
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1862

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) 


1867
1868
1869
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1867

def notes
  @notes
end

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

Additional parameters. Corresponds to the JSON property parameter

Returns:



1872
1873
1874
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1872

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


1877
1878
1879
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1877

def parent_folder_id
  @parent_folder_id
end

#path ⇒ String

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

Returns:

  • (String) 


1882
1883
1884
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1882

def path
  @path
end

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

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

Returns:



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

def selector
  @selector
end

#tag_manager_url ⇒ String

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

Returns:

  • (String) 


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

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:



1897
1898
1899
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1897

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) 


1902
1903
1904
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1902

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) 


1907
1908
1909
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1907

def type
  @type
end

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

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

Returns:



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

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:



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

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:



1922
1923
1924
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1922

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:



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

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:



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

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:



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

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:



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

def wait_for_tags_timeout
  @wait_for_tags_timeout
end

#workspace_id ⇒ String

GTM Workspace ID. Corresponds to the JSON property workspaceId

Returns:

  • (String) 


1947
1948
1949
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1947

def workspace_id
  @workspace_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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
1981
1982
1983
1984
1985
1986
1987
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 1954

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