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.



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

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


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

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


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

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


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

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:



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

def consent_settings
  @consent_settings
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


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

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) 


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

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


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

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


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

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) 


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

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:



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

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) 


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

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) 


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

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) 


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

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:



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

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


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

def parent_folder_id
  @parent_folder_id
end

#path ⇒ String

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

Returns:

  • (String) 


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

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) 


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

def paused
  @paused
end

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

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

Returns:



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

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) 


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

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) 


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

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:



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

def setup_tag
  @setup_tag
end

#tag_firing_option ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


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

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:



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

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) 


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

def type
  @type
end

#workspace_id ⇒ String

GTM Workspace ID. Corresponds to the JSON property workspaceId

Returns:

  • (String) 


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

def workspace_id
  @workspace_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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
2461
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 2433

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