Class: Google::Apis::TagmanagerV2::Tag

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Tag

Returns a new instance of Tag.



2427
2428
2429
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2427

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


2265
2266
2267
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2265

def 
  @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. @mutable tagmanager.accounts.containers.workspaces.tags.create @ mutable tagmanager.accounts.containers.workspaces.tags.update Corresponds to the JSON property blockingRuleId

Returns:

  • (Array<String>) 


2272
2273
2274
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2272

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. @mutable tagmanager.accounts.containers.workspaces.tags.create @ mutable tagmanager.accounts.containers.workspaces.tags.update Corresponds to the JSON property blockingTriggerId

Returns:

  • (Array<String>) 


2279
2280
2281
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2279

def blocking_trigger_id
  @blocking_trigger_id
end

#consent_settings ⇒ Google::Apis::TagmanagerV2::TagConsentSetting

Consent settings of a tag. @mutable tagmanager.accounts.containers.workspaces. tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update Corresponds to the JSON property consentSettings

Returns:



2285
2286
2287
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2285

def consent_settings
  @consent_settings
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


2290
2291
2292
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2290

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

Returns:

  • (String) 


2296
2297
2298
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2296

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. @mutable tagmanager. accounts.containers.workspaces.tags.create @mutable tagmanager.accounts. containers.workspaces.tags.update Corresponds to the JSON property firingRuleId

Returns:

  • (Array<String>) 


2304
2305
2306
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2304

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. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager. accounts.containers.workspaces.tags.update Corresponds to the JSON property firingTriggerId

Returns:

  • (Array<String>) 


2312
2313
2314
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2312

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). @mutable tagmanager.accounts.containers.workspaces. tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update Corresponds to the JSON property liveOnly

Returns:

  • (Boolean) 


2319
2320
2321
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2319

def live_only
  @live_only
end

#monitoring_metadata ⇒ Google::Apis::TagmanagerV2::Parameter

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

Returns:



2325
2326
2327
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2325

def monitoring_metadata
  @monitoring_metadata
end

#monitoring_metadata_tag_name_key ⇒ String

If non-empty, then the tag display name will be included in the monitoring metadata map using the key specified. @mutable tagmanager.accounts.containers. workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags. update Corresponds to the JSON property monitoringMetadataTagNameKey

Returns:

  • (String) 


2333
2334
2335
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2333

def monitoring_metadata_tag_name_key
  @monitoring_metadata_tag_name_key
end

#name ⇒ String

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

Returns:

  • (String) 


2339
2340
2341
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2339

def name
  @name
end

#notes ⇒ String

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

Returns:

  • (String) 


2346
2347
2348
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2346

def notes
  @notes
end

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

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

Returns:



2352
2353
2354
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2352

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


2357
2358
2359
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2357

def parent_folder_id
  @parent_folder_id
end

#path ⇒ String

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

Returns:

  • (String) 


2362
2363
2364
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2362

def path
  @path
end

#paused ⇒ Boolean Also known as: paused?

Indicates whether the tag is paused, which prevents the tag from firing. @ mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update Corresponds to the JSON property paused

Returns:

  • (Boolean) 


2369
2370
2371
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2369

def paused
  @paused
end

#priority ⇒ Google::Apis::TagmanagerV2::Parameter

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

Returns:



2375
2376
2377
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2375

def priority
  @priority
end

#schedule_end_ms ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2382
2383
2384
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2382

def schedule_end_ms
  @schedule_end_ms
end

#schedule_start_ms ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2389
2390
2391
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2389

def schedule_start_ms
  @schedule_start_ms
end

#setup_tag ⇒ Array<Google::Apis::TagmanagerV2::SetupTag>

The list of setup tags. Currently we only allow one. Corresponds to the JSON property setupTag

Returns:



2394
2395
2396
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2394

def setup_tag
  @setup_tag
end

#tag_firing_option ⇒ String

Option to fire this tag. Corresponds to the JSON property tagFiringOption

Returns:

  • (String) 


2399
2400
2401
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2399

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

Returns:

  • (String) 


2404
2405
2406
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2404

def tag_id
  @tag_id
end

#tag_manager_url ⇒ String

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

Returns:

  • (String) 


2409
2410
2411
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2409

def tag_manager_url
  @tag_manager_url
end

#teardown_tag ⇒ Array<Google::Apis::TagmanagerV2::TeardownTag>

The list of teardown tags. Currently we only allow one. Corresponds to the JSON property teardownTag

Returns:



2414
2415
2416
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2414

def teardown_tag
  @teardown_tag
end

#type ⇒ String

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

Returns:

  • (String) 


2420
2421
2422
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2420

def type
  @type
end

#workspace_id ⇒ String

GTM Workspace ID. Corresponds to the JSON property workspaceId

Returns:

  • (String) 


2425
2426
2427
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2425

def workspace_id
  @workspace_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2432

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)
  @consent_settings = args[:consent_settings] if args.key?(:consent_settings)
  @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)
  @monitoring_metadata = args[:monitoring_metadata] if args.key?(:monitoring_metadata)
  @monitoring_metadata_tag_name_key = args[:monitoring_metadata_tag_name_key] if args.key?(:monitoring_metadata_tag_name_key)
  @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)
  @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)
  @tag_manager_url = args[:tag_manager_url] if args.key?(:tag_manager_url)
  @teardown_tag = args[:teardown_tag] if args.key?(:teardown_tag)
  @type = args[:type] if args.key?(:type)
  @workspace_id = args[:workspace_id] if args.key?(:workspace_id)
end