Class: Google::Apis::TagmanagerV1::Environment

Inherits:
Object
  • Object
show all
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 Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.

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

Returns a new instance of Environment.


530
531
532
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 530

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

Instance Attribute Details

#account_idString

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String)

469
470
471
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 469

def 
  @account_id
end

#authorization_codeString

The environment authorization code. Corresponds to the JSON property authorizationCode

Returns:

  • (String)

474
475
476
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 474

def authorization_code
  @authorization_code
end

#authorization_timestamp_msString

The last update time-stamp for the authorization code. Corresponds to the JSON property authorizationTimestampMs

Returns:

  • (String)

479
480
481
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 479

def authorization_timestamp_ms
  @authorization_timestamp_ms
end

#container_idString

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String)

484
485
486
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 484

def container_id
  @container_id
end

#container_version_idString

Corresponds to the JSON property containerVersionId

Returns:

  • (String)

489
490
491
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 489

def container_version_id
  @container_version_id
end

#descriptionString

The environment description. Can be set or changed only on USER type environments. Corresponds to the JSON property description

Returns:

  • (String)

495
496
497
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 495

def description
  @description
end

#enable_debugBoolean Also known as: enable_debug?

Whether or not to enable debug by default on for the environment. Corresponds to the JSON property enableDebug

Returns:

  • (Boolean)

500
501
502
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 500

def enable_debug
  @enable_debug
end

#environment_idString

GTM Environment ID uniquely identifies the GTM Environment. Corresponds to the JSON property environmentId

Returns:

  • (String)

506
507
508
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 506

def environment_id
  @environment_id
end

#fingerprintString

The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified. Corresponds to the JSON property fingerprint

Returns:

  • (String)

512
513
514
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 512

def fingerprint
  @fingerprint
end

#nameString

The environment display name. Can be set or changed only on USER type environments. Corresponds to the JSON property name

Returns:

  • (String)

518
519
520
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 518

def name
  @name
end

#typeString

The type of this environment. Corresponds to the JSON property type

Returns:

  • (String)

523
524
525
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 523

def type
  @type
end

#urlString

Default preview page url for the environment. Corresponds to the JSON property url

Returns:

  • (String)

528
529
530
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 528

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


535
536
537
538
539
540
541
542
543
544
545
546
547
548
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 535

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @authorization_code = args[:authorization_code] if args.key?(:authorization_code)
  @authorization_timestamp_ms = args[:authorization_timestamp_ms] if args.key?(:authorization_timestamp_ms)
  @container_id = args[:container_id] if args.key?(:container_id)
  @container_version_id = args[:container_version_id] if args.key?(:container_version_id)
  @description = args[:description] if args.key?(:description)
  @enable_debug = args[:enable_debug] if args.key?(:enable_debug)
  @environment_id = args[:environment_id] if args.key?(:environment_id)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @name = args[:name] if args.key?(:name)
  @type = args[:type] if args.key?(:type)
  @url = args[:url] if args.key?(:url)
end