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.



2689
2690
2691
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2689

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


2517
2518
2519
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2517

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:



2524
2525
2526
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2524

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:



2529
2530
2531
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2529

def check_validation
  @check_validation
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


2534
2535
2536
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2534

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:



2539
2540
2541
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2539

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:



2546
2547
2548
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2546

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:



2551
2552
2553
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2551

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:



2558
2559
2560
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2558

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) 


2564
2565
2566
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2564

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:



2569
2570
2571
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2569

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:



2574
2575
2576
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2574

def interval
  @interval
end

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

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

Returns:



2579
2580
2581
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2579

def interval_seconds
  @interval_seconds
end

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

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

Returns:



2584
2585
2586
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2584

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:



2589
2590
2591
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2589

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) 


2596
2597
2598
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2596

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) 


2603
2604
2605
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2603

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:



2610
2611
2612
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2610

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


2615
2616
2617
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2615

def parent_folder_id
  @parent_folder_id
end

#path ⇒ String

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

Returns:

  • (String) 


2620
2621
2622
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2620

def path
  @path
end

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

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

Returns:



2625
2626
2627
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2625

def selector
  @selector
end

#tag_manager_url ⇒ String

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

Returns:

  • (String) 


2630
2631
2632
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2630

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:



2635
2636
2637
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2635

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) 


2640
2641
2642
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2640

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) 


2647
2648
2649
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2647

def type
  @type
end

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

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

Returns:



2652
2653
2654
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2652

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:



2657
2658
2659
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2657

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:



2662
2663
2664
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2662

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:



2667
2668
2669
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2667

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:



2672
2673
2674
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2672

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:



2677
2678
2679
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2677

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:



2682
2683
2684
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2682

def wait_for_tags_timeout
  @wait_for_tags_timeout
end

#workspace_id ⇒ String

GTM Workspace ID. Corresponds to the JSON property workspaceId

Returns:

  • (String) 


2687
2688
2689
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2687

def workspace_id
  @workspace_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2694

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