Class: Google::Apis::TagmanagerV1::Trigger

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/tagmanager_v1/classes.rb,
generated/google/apis/tagmanager_v1/representations.rb,
generated/google/apis/tagmanager_v1/representations.rb more...

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

[View source]

1378
1379
1380
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1378

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 

1240
1241
1242
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1240

def 
  @account_id
end

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

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

Returns:


1245
1246
1247
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1245

def auto_event_filter
  @auto_event_filter
end

#check_validation ⇒ Google::Apis::TagmanagerV1::Parameter

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

Returns:


1250
1251
1252
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1250

def check_validation
  @check_validation
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 

1255
1256
1257
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1255

def container_id
  @container_id
end

#continuous_time_min_milliseconds ⇒ Google::Apis::TagmanagerV1::Parameter

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

Returns:


1260
1261
1262
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1260

def continuous_time_min_milliseconds
  @continuous_time_min_milliseconds
end

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

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

Returns:


1265
1266
1267
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1265

def custom_event_filter
  @custom_event_filter
end

#event_name ⇒ Google::Apis::TagmanagerV1::Parameter

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

Returns:


1270
1271
1272
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1270

def event_name
  @event_name
end

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

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

Returns:


1275
1276
1277
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1275

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) 

1281
1282
1283
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1281

def fingerprint
  @fingerprint
end

#horizontal_scroll_percentage_list ⇒ Google::Apis::TagmanagerV1::Parameter

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

Returns:


1286
1287
1288
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1286

def horizontal_scroll_percentage_list
  @horizontal_scroll_percentage_list
end

#interval ⇒ Google::Apis::TagmanagerV1::Parameter

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

Returns:


1291
1292
1293
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1291

def interval
  @interval
end

#interval_seconds ⇒ Google::Apis::TagmanagerV1::Parameter

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

Returns:


1296
1297
1298
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1296

def interval_seconds
  @interval_seconds
end

#limit ⇒ Google::Apis::TagmanagerV1::Parameter

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

Returns:


1301
1302
1303
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1301

def limit
  @limit
end

#max_timer_length_seconds ⇒ Google::Apis::TagmanagerV1::Parameter

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

Returns:


1306
1307
1308
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1306

def max_timer_length_seconds
  @max_timer_length_seconds
end

#name ⇒ String

Trigger display name. Corresponds to the JSON property name

Returns:

  • (String) 

1311
1312
1313
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1311

def name
  @name
end

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

Additional parameters. Corresponds to the JSON property parameter

Returns:


1316
1317
1318
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1316

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 

1321
1322
1323
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1321

def parent_folder_id
  @parent_folder_id
end

#selector ⇒ Google::Apis::TagmanagerV1::Parameter

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

Returns:


1326
1327
1328
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1326

def selector
  @selector
end

#total_time_min_milliseconds ⇒ Google::Apis::TagmanagerV1::Parameter

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

Returns:


1331
1332
1333
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1331

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) 

1336
1337
1338
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1336

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) 

1341
1342
1343
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1341

def type
  @type
end

#unique_trigger_id ⇒ Google::Apis::TagmanagerV1::Parameter

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

Returns:


1346
1347
1348
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1346

def unique_trigger_id
  @unique_trigger_id
end

#vertical_scroll_percentage_list ⇒ Google::Apis::TagmanagerV1::Parameter

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

Returns:


1351
1352
1353
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1351

def vertical_scroll_percentage_list
  @vertical_scroll_percentage_list
end

#visibility_selector ⇒ Google::Apis::TagmanagerV1::Parameter

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

Returns:


1356
1357
1358
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1356

def visibility_selector
  @visibility_selector
end

#visible_percentage_max ⇒ Google::Apis::TagmanagerV1::Parameter

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

Returns:


1361
1362
1363
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1361

def visible_percentage_max
  @visible_percentage_max
end

#visible_percentage_min ⇒ Google::Apis::TagmanagerV1::Parameter

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

Returns:


1366
1367
1368
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1366

def visible_percentage_min
  @visible_percentage_min
end

#wait_for_tags ⇒ Google::Apis::TagmanagerV1::Parameter

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

Returns:


1371
1372
1373
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1371

def wait_for_tags
  @wait_for_tags
end

#wait_for_tags_timeout ⇒ Google::Apis::TagmanagerV1::Parameter

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

Returns:


1376
1377
1378
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1376

def wait_for_tags_timeout
  @wait_for_tags_timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1383

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