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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/tagmanager_v1/classes.rb,
lib/google/apis/tagmanager_v1/representations.rb,
lib/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

Constructor Details

#initialize(**args) ⇒ Environment

Returns a new instance of Environment.



553
554
555
 
# File 'lib/google/apis/tagmanager_v1/classes.rb', line 553

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


486
487
488
 
# File 'lib/google/apis/tagmanager_v1/classes.rb', line 486

def 
  @account_id
end

#authorization_code ⇒ String

The environment authorization code. Corresponds to the JSON property authorizationCode

Returns:

  • (String) 


491
492
493
 
# File 'lib/google/apis/tagmanager_v1/classes.rb', line 491

def authorization_code
  @authorization_code
end

#authorization_timestamp_ms ⇒ Fixnum

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

Returns:

  • (Fixnum) 


496
497
498
 
# File 'lib/google/apis/tagmanager_v1/classes.rb', line 496

def authorization_timestamp_ms
  @authorization_timestamp_ms
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


501
502
503
 
# File 'lib/google/apis/tagmanager_v1/classes.rb', line 501

def container_id
  @container_id
end

#container_version_id ⇒ String

Corresponds to the JSON property containerVersionId

Returns:

  • (String) 


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

def container_version_id
  @container_version_id
end

#description ⇒ String

The environment description. Can be set or changed only on USER type environments. @mutable tagmanager.accounts.containers.environments.create @ mutable tagmanager.accounts.containers.environments.update Corresponds to the JSON property description

Returns:

  • (String) 


513
514
515
 
# File 'lib/google/apis/tagmanager_v1/classes.rb', line 513

def description
  @description
end

#enable_debug ⇒ Boolean Also known as: enable_debug?

Whether or not to enable debug by default on for the environment. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager. accounts.containers.environments.update Corresponds to the JSON property enableDebug

Returns:

  • (Boolean) 


520
521
522
 
# File 'lib/google/apis/tagmanager_v1/classes.rb', line 520

def enable_debug
  @enable_debug
end

#environment_id ⇒ String

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

Returns:

  • (String) 


526
527
528
 
# File 'lib/google/apis/tagmanager_v1/classes.rb', line 526

def environment_id
  @environment_id
end

#fingerprint ⇒ String

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) 


532
533
534
 
# File 'lib/google/apis/tagmanager_v1/classes.rb', line 532

def fingerprint
  @fingerprint
end

#name ⇒ String

The environment display name. Can be set or changed only on USER type environments. @mutable tagmanager.accounts.containers.environments.create @ mutable tagmanager.accounts.containers.environments.update Corresponds to the JSON property name

Returns:

  • (String) 


539
540
541
 
# File 'lib/google/apis/tagmanager_v1/classes.rb', line 539

def name
  @name
end

#type ⇒ String

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

Returns:

  • (String) 


544
545
546
 
# File 'lib/google/apis/tagmanager_v1/classes.rb', line 544

def type
  @type
end

#url ⇒ String

Default preview page url for the environment. @mutable tagmanager.accounts. containers.environments.create @mutable tagmanager.accounts.containers. environments.update Corresponds to the JSON property url

Returns:

  • (String) 


551
552
553
 
# File 'lib/google/apis/tagmanager_v1/classes.rb', line 551

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/google/apis/tagmanager_v1/classes.rb', line 558

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