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

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 Trigger

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Trigger

Returns a new instance of Trigger.



2323
2324
2325
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2323

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


2151
2152
2153
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2151

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:



2158
2159
2160
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2158

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:



2163
2164
2165
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2163

def check_validation
  @check_validation
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


2168
2169
2170
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2168

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:



2173
2174
2175
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2173

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:



2180
2181
2182
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2180

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:



2185
2186
2187
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2185

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:



2192
2193
2194
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2192

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) 


2198
2199
2200
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2198

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:



2203
2204
2205
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2203

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:



2208
2209
2210
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2208

def interval
  @interval
end

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

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

Returns:



2213
2214
2215
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2213

def interval_seconds
  @interval_seconds
end

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

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

Returns:



2218
2219
2220
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2218

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:



2223
2224
2225
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2223

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) 


2230
2231
2232
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2230

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) 


2237
2238
2239
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2237

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:



2244
2245
2246
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2244

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


2249
2250
2251
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2249

def parent_folder_id
  @parent_folder_id
end

#path ⇒ String

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

Returns:

  • (String) 


2254
2255
2256
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2254

def path
  @path
end

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

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

Returns:



2259
2260
2261
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2259

def selector
  @selector
end

#tag_manager_url ⇒ String

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

Returns:

  • (String) 


2264
2265
2266
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2264

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:



2269
2270
2271
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2269

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) 


2274
2275
2276
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2274

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) 


2281
2282
2283
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2281

def type
  @type
end

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

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

Returns:



2286
2287
2288
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2286

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:



2291
2292
2293
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2291

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:



2296
2297
2298
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2296

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:



2301
2302
2303
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2301

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:



2306
2307
2308
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2306

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:



2311
2312
2313
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2311

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:



2316
2317
2318
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2316

def wait_for_tags_timeout
  @wait_for_tags_timeout
end

#workspace_id ⇒ String

GTM Workspace ID. Corresponds to the JSON property workspaceId

Returns:

  • (String) 


2321
2322
2323
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2321

def workspace_id
  @workspace_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2328

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