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

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

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) ⇒ Variable

Returns a new instance of Variable



2153
2154
2155
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2153

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


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

def 
  @account_id
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


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

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. Corresponds to the JSON property disablingTriggerId

Returns:

  • (Array<String>) 


2083
2084
2085
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2083

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. Corresponds to the JSON property enablingTriggerId

Returns:

  • (Array<String>) 


2090
2091
2092
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2090

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) 


2096
2097
2098
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2096

def fingerprint
  @fingerprint
end

#name ⇒ String

Variable display name. Corresponds to the JSON property name

Returns:

  • (String) 


2101
2102
2103
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2101

def name
  @name
end

#notes ⇒ String

User notes on how to apply this variable in the container. Corresponds to the JSON property notes

Returns:

  • (String) 


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

def notes
  @notes
end

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

The variable's parameters. Corresponds to the JSON property parameter

Returns:



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

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


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

def parent_folder_id
  @parent_folder_id
end

#path ⇒ String

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

Returns:

  • (String) 


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

def path
  @path
end

#schedule_end_ms ⇒ Fixnum

The end timestamp in milliseconds to schedule a variable. Corresponds to the JSON property scheduleEndMs

Returns:

  • (Fixnum) 


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

def schedule_end_ms
  @schedule_end_ms
end

#schedule_start_ms ⇒ Fixnum

The start timestamp in milliseconds to schedule a variable. Corresponds to the JSON property scheduleStartMs

Returns:

  • (Fixnum) 


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

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) 


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

def tag_manager_url
  @tag_manager_url
end

#type ⇒ String

GTM Variable Type. Corresponds to the JSON property type

Returns:

  • (String) 


2141
2142
2143
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2141

def type
  @type
end

#variable_id ⇒ String

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

Returns:

  • (String) 


2146
2147
2148
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2146

def variable_id
  @variable_id
end

#workspace_id ⇒ String

GTM Workspace ID. Corresponds to the JSON property workspaceId

Returns:

  • (String) 


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

def workspace_id
  @workspace_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2158

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)
  @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