Class: Google::Apis::TagmanagerV1::Tag
- Inherits:
-
Object
- Object
- Google::Apis::TagmanagerV1::Tag
- 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
Overview
Represents a Google Tag Manager Tag.
Instance Attribute Summary collapse
-
#account_id ⇒ String
GTM Account ID.
-
#blocking_rule_id ⇒ Array<String>
Blocking rule IDs.
-
#blocking_trigger_id ⇒ Array<String>
Blocking trigger IDs.
-
#container_id ⇒ String
GTM Container ID.
-
#fingerprint ⇒ String
The fingerprint of the GTM Tag as computed at storage time.
-
#firing_rule_id ⇒ Array<String>
Firing rule IDs.
-
#firing_trigger_id ⇒ Array<String>
Firing trigger IDs.
-
#live_only ⇒ Boolean
(also: #live_only?)
If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).
-
#name ⇒ String
Tag display name.
-
#notes ⇒ String
User notes on how to apply this tag in the container.
-
#parameter ⇒ Array<Google::Apis::TagmanagerV1::Parameter>
The tag's parameters.
-
#parent_folder_id ⇒ String
Parent folder id.
-
#paused ⇒ Boolean
(also: #paused?)
True if the tag is paused.
-
#priority ⇒ Google::Apis::TagmanagerV1::Parameter
Represents a Google Tag Manager Parameter.
-
#schedule_end_ms ⇒ Fixnum
The end timestamp in milliseconds to schedule a tag.
-
#schedule_start_ms ⇒ Fixnum
The start timestamp in milliseconds to schedule a tag.
-
#setup_tag ⇒ Array<Google::Apis::TagmanagerV1::SetupTag>
The list of setup tags.
-
#tag_firing_option ⇒ String
Option to fire this tag.
-
#tag_id ⇒ String
The Tag ID uniquely identifies the GTM Tag.
-
#teardown_tag ⇒ Array<Google::Apis::TagmanagerV1::TeardownTag>
The list of teardown tags.
-
#type ⇒ String
GTM Tag Type.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Tag
constructor
A new instance of Tag.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Tag
Returns a new instance of Tag.
1314 1315 1316 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1314 def initialize(**args) update!(**args) end |
Instance Attribute Details
#account_id ⇒ String
GTM Account ID.
Corresponds to the JSON property accountId
1178 1179 1180 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1178 def account_id @account_id end |
#blocking_rule_id ⇒ Array<String>
Blocking rule IDs. If any of the listed rules evaluate to true, the tag
will not fire.
Corresponds to the JSON property blockingRuleId
1186 1187 1188 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1186 def blocking_rule_id @blocking_rule_id end |
#blocking_trigger_id ⇒ Array<String>
Blocking trigger IDs. If any of the listed triggers evaluate to true, the
tag
will not fire.
Corresponds to the JSON property blockingTriggerId
1195 1196 1197 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1195 def blocking_trigger_id @blocking_trigger_id end |
#container_id ⇒ String
GTM Container ID.
Corresponds to the JSON property containerId
1200 1201 1202 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1200 def container_id @container_id end |
#fingerprint ⇒ String
The fingerprint of the GTM Tag as computed at storage time.
This value is recomputed whenever the tag is modified.
Corresponds to the JSON property fingerprint
1206 1207 1208 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1206 def fingerprint @fingerprint end |
#firing_rule_id ⇒ Array<String>
Firing rule IDs. A tag will fire when any of the listed rules are true and
all of its blockingRuleIds
(if any specified) are false.
Corresponds to the JSON property firingRuleId
1214 1215 1216 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1214 def firing_rule_id @firing_rule_id end |
#firing_trigger_id ⇒ Array<String>
Firing trigger IDs. A tag will fire when any of the listed triggers are
true and all of its blockingTriggerIds
(if any specified) are
false.
Corresponds to the JSON property firingTriggerId
1223 1224 1225 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1223 def firing_trigger_id @firing_trigger_id end |
#live_only ⇒ Boolean Also known as: live_only?
If set to true, this tag will only fire in the live environment (e.g. not
in preview or debug mode).
Corresponds to the JSON property liveOnly
1231 1232 1233 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1231 def live_only @live_only end |
#name ⇒ String
Tag display name.
Corresponds to the JSON property name
1239 1240 1241 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1239 def name @name end |
#notes ⇒ String
User notes on how to apply this tag in the container.
Corresponds to the JSON property notes
1246 1247 1248 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1246 def notes @notes end |
#parameter ⇒ Array<Google::Apis::TagmanagerV1::Parameter>
The tag's parameters.
Corresponds to the JSON property parameter
1253 1254 1255 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1253 def parameter @parameter end |
#parent_folder_id ⇒ String
Parent folder id.
Corresponds to the JSON property parentFolderId
1258 1259 1260 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1258 def parent_folder_id @parent_folder_id end |
#paused ⇒ Boolean Also known as: paused?
True if the tag is paused.
Corresponds to the JSON property paused
1265 1266 1267 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1265 def paused @paused end |
#priority ⇒ Google::Apis::TagmanagerV1::Parameter
Represents a Google Tag Manager Parameter.
Corresponds to the JSON property priority
1271 1272 1273 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1271 def priority @priority end |
#schedule_end_ms ⇒ Fixnum
The end timestamp in milliseconds to schedule a tag.
Corresponds to the JSON property scheduleEndMs
1278 1279 1280 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1278 def schedule_end_ms @schedule_end_ms end |
#schedule_start_ms ⇒ Fixnum
The start timestamp in milliseconds to schedule a tag.
Corresponds to the JSON property scheduleStartMs
1285 1286 1287 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1285 def schedule_start_ms @schedule_start_ms end |
#setup_tag ⇒ Array<Google::Apis::TagmanagerV1::SetupTag>
The list of setup tags. Currently we only allow one.
Corresponds to the JSON property setupTag
1290 1291 1292 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1290 def setup_tag @setup_tag end |
#tag_firing_option ⇒ String
Option to fire this tag.
Corresponds to the JSON property tagFiringOption
1295 1296 1297 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1295 def tag_firing_option @tag_firing_option end |
#tag_id ⇒ String
The Tag ID uniquely identifies the GTM Tag.
Corresponds to the JSON property tagId
1300 1301 1302 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1300 def tag_id @tag_id end |
#teardown_tag ⇒ Array<Google::Apis::TagmanagerV1::TeardownTag>
The list of teardown tags. Currently we only allow one.
Corresponds to the JSON property teardownTag
1305 1306 1307 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1305 def teardown_tag @teardown_tag end |
#type ⇒ String
GTM Tag Type.
Corresponds to the JSON property type
1312 1313 1314 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1312 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 |
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1319 def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @blocking_rule_id = args[:blocking_rule_id] if args.key?(:blocking_rule_id) @blocking_trigger_id = args[:blocking_trigger_id] if args.key?(:blocking_trigger_id) @container_id = args[:container_id] if args.key?(:container_id) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @firing_rule_id = args[:firing_rule_id] if args.key?(:firing_rule_id) @firing_trigger_id = args[:firing_trigger_id] if args.key?(:firing_trigger_id) @live_only = args[:live_only] if args.key?(:live_only) @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) @paused = args[:paused] if args.key?(:paused) @priority = args[:priority] if args.key?(:priority) @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) @setup_tag = args[:setup_tag] if args.key?(:setup_tag) @tag_firing_option = args[:tag_firing_option] if args.key?(:tag_firing_option) @tag_id = args[:tag_id] if args.key?(:tag_id) @teardown_tag = args[:teardown_tag] if args.key?(:teardown_tag) @type = args[:type] if args.key?(:type) end |