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



2160
2161
2162
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2160

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


2078
2079
2080
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2078

def 
  @account_id
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


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

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


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

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


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

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) 


2103
2104
2105
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2103

def fingerprint
  @fingerprint
end

#name ⇒ String

Variable display name. Corresponds to the JSON property name

Returns:

  • (String) 


2108
2109
2110
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2108

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) 


2113
2114
2115
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2113

def notes
  @notes
end

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

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

Returns:



2118
2119
2120
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2118

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


2123
2124
2125
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2123

def parent_folder_id
  @parent_folder_id
end

#path ⇒ String

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

Returns:

  • (String) 


2128
2129
2130
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2128

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) 


2133
2134
2135
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2133

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) 


2138
2139
2140
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2138

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) 


2143
2144
2145
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2143

def tag_manager_url
  @tag_manager_url
end

#type ⇒ String

GTM Variable Type. Corresponds to the JSON property type

Returns:

  • (String) 


2148
2149
2150
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2148

def type
  @type
end

#variable_id ⇒ String

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

Returns:

  • (String) 


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

def variable_id
  @variable_id
end

#workspace_id ⇒ String

GTM Workspace ID. Corresponds to the JSON property workspaceId

Returns:

  • (String) 


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

def workspace_id
  @workspace_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
 
# File 'generated/google/apis/tagmanager_v2/classes.rb', line 2165

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