Class: Google::Apis::TagmanagerV2::Variable

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 Variable.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Variable

Returns a new instance of Variable.



2898
2899
2900
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2898

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


2795
2796
2797
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2795

def 
  @account_id
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


2800
2801
2802
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2800

def container_id
  @container_id
end

#disabling_trigger_id ⇒ Array<String>

For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set. @ mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update Corresponds to the JSON property disablingTriggerId

Returns:

  • (Array<String>) 


2809
2810
2811
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2809

def disabling_trigger_id
  @disabling_trigger_id
end

#enabling_trigger_id ⇒ Array<String>

For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set. @ mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update Corresponds to the JSON property enablingTriggerId

Returns:

  • (Array<String>) 


2818
2819
2820
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2818

def enabling_trigger_id
  @enabling_trigger_id
end

#fingerprint ⇒ String

The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified. Corresponds to the JSON property fingerprint

Returns:

  • (String) 


2824
2825
2826
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2824

def fingerprint
  @fingerprint
end

#format_value ⇒ Google::Apis::TagmanagerV2::VariableFormatValue

Option to convert a variable value to other value. Corresponds to the JSON property formatValue

Returns:



2829
2830
2831
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2829

def format_value
  @format_value
end

#name ⇒ String

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

Returns:

  • (String) 


2836
2837
2838
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2836

def name
  @name
end

#notes ⇒ String

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

Returns:

  • (String) 


2843
2844
2845
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2843

def notes
  @notes
end

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

The variable's parameters. @mutable tagmanager.accounts.containers.workspaces. variables.create @mutable tagmanager.accounts.containers.workspaces.variables. update Corresponds to the JSON property parameter

Returns:



2850
2851
2852
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2850

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


2855
2856
2857
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2855

def parent_folder_id
  @parent_folder_id
end

#path ⇒ String

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

Returns:

  • (String) 


2860
2861
2862
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2860

def path
  @path
end

#schedule_end_ms ⇒ Fixnum

The end timestamp in milliseconds to schedule a variable. @mutable tagmanager. accounts.containers.workspaces.variables.create @mutable tagmanager.accounts. containers.workspaces.variables.update Corresponds to the JSON property scheduleEndMs

Returns:

  • (Fixnum) 


2867
2868
2869
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2867

def schedule_end_ms
  @schedule_end_ms
end

#schedule_start_ms ⇒ Fixnum

The start timestamp in milliseconds to schedule a variable. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager. accounts.containers.workspaces.variables.update Corresponds to the JSON property scheduleStartMs

Returns:

  • (Fixnum) 


2874
2875
2876
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2874

def schedule_start_ms
  @schedule_start_ms
end

#tag_manager_url ⇒ String

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

Returns:

  • (String) 


2879
2880
2881
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2879

def tag_manager_url
  @tag_manager_url
end

#type ⇒ String

GTM Variable Type. @mutable tagmanager.accounts.containers.workspaces. variables.create @mutable tagmanager.accounts.containers.workspaces.variables. update Corresponds to the JSON property type

Returns:

  • (String) 


2886
2887
2888
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2886

def type
  @type
end

#variable_id ⇒ String

The Variable ID uniquely identifies the GTM Variable. Corresponds to the JSON property variableId

Returns:

  • (String) 


2891
2892
2893
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2891

def variable_id
  @variable_id
end

#workspace_id ⇒ String

GTM Workspace ID. Corresponds to the JSON property workspaceId

Returns:

  • (String) 


2896
2897
2898
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2896

def workspace_id
  @workspace_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2903

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @container_id = args[:container_id] if args.key?(:container_id)
  @disabling_trigger_id = args[:disabling_trigger_id] if args.key?(:disabling_trigger_id)
  @enabling_trigger_id = args[:enabling_trigger_id] if args.key?(:enabling_trigger_id)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @format_value = args[:format_value] if args.key?(:format_value)
  @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)
  @schedule_end_ms = args[:schedule_end_ms] if args.key?(:schedule_end_ms)
  @schedule_start_ms = args[:schedule_start_ms] if args.key?(:schedule_start_ms)
  @tag_manager_url = args[:tag_manager_url] if args.key?(:tag_manager_url)
  @type = args[:type] if args.key?(:type)
  @variable_id = args[:variable_id] if args.key?(:variable_id)
  @workspace_id = args[:workspace_id] if args.key?(:workspace_id)
end