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

Constructor Details

#initialize(**args) ⇒ Trigger

Returns a new instance of Trigger.



2236
2237
2238
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2236

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


2064
2065
2066
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2064

def 
  @account_id
end

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

Used in the case of auto event tracking. @mutable tagmanager.accounts. containers.workspaces.triggers.create @mutable tagmanager.accounts.containers. workspaces.triggers.update Corresponds to the JSON property autoEventFilter

Returns:



2071
2072
2073
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2071

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:



2076
2077
2078
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2076

def check_validation
  @check_validation
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


2081
2082
2083
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2081

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:



2086
2087
2088
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2086

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

Returns:



2093
2094
2095
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2093

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:



2098
2099
2100
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2098

def event_name
  @event_name
end

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

The trigger will only fire iff all Conditions are true. @mutable tagmanager. accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts. containers.workspaces.triggers.update Corresponds to the JSON property filter

Returns:



2105
2106
2107
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2105

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) 


2111
2112
2113
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2111

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:



2116
2117
2118
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2116

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:



2121
2122
2123
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2121

def interval
  @interval
end

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

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

Returns:



2126
2127
2128
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2126

def interval_seconds
  @interval_seconds
end

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

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

Returns:



2131
2132
2133
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2131

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:



2136
2137
2138
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2136

def max_timer_length_seconds
  @max_timer_length_seconds
end

#name ⇒ String

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

Returns:

  • (String) 


2143
2144
2145
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2143

def name
  @name
end

#notes ⇒ String

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

Returns:

  • (String) 


2150
2151
2152
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2150

def notes
  @notes
end

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

Additional parameters. @mutable tagmanager.accounts.containers.workspaces. triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers. update Corresponds to the JSON property parameter

Returns:



2157
2158
2159
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2157

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


2162
2163
2164
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2162

def parent_folder_id
  @parent_folder_id
end

#path ⇒ String

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

Returns:

  • (String) 


2167
2168
2169
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2167

def path
  @path
end

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

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

Returns:



2172
2173
2174
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2172

def selector
  @selector
end

#tag_manager_url ⇒ String

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

Returns:

  • (String) 


2177
2178
2179
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2177

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:



2182
2183
2184
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2182

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) 


2187
2188
2189
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2187

def trigger_id
  @trigger_id
end

#type ⇒ String

Defines the data layer event that causes this trigger. @mutable tagmanager. accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts. containers.workspaces.triggers.update Corresponds to the JSON property type

Returns:

  • (String) 


2194
2195
2196
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2194

def type
  @type
end

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

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

Returns:



2199
2200
2201
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2199

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:



2204
2205
2206
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2204

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:



2209
2210
2211
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2209

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:



2214
2215
2216
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2214

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:



2219
2220
2221
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2219

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:



2224
2225
2226
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2224

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:



2229
2230
2231
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2229

def wait_for_tags_timeout
  @wait_for_tags_timeout
end

#workspace_id ⇒ String

GTM Workspace ID. Corresponds to the JSON property workspaceId

Returns:

  • (String) 


2234
2235
2236
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2234

def workspace_id
  @workspace_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2241

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