Class: Google::Apis::TagmanagerV2::Environment

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



1155
1156
1157
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1155

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


1073
1074
1075
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1073

def 
  @account_id
end

#authorization_code ⇒ String

The environment authorization code. Corresponds to the JSON property authorizationCode

Returns:

  • (String) 


1078
1079
1080
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1078

def authorization_code
  @authorization_code
end

#authorization_timestamp ⇒ String

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

Returns:

  • (String) 


1083
1084
1085
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1083

def authorization_timestamp
  @authorization_timestamp
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


1088
1089
1090
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1088

def container_id
  @container_id
end

#container_version_id ⇒ String

Represents a link to a container version. Corresponds to the JSON property containerVersionId

Returns:

  • (String) 


1093
1094
1095
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1093

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) 


1100
1101
1102
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1100

def description
  @description
end

#enable_debug ⇒ Boolean Also known as: enable_debug?

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

Returns:

  • (Boolean) 


1107
1108
1109
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1107

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) 


1113
1114
1115
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1113

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) 


1119
1120
1121
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1119

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) 


1126
1127
1128
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1126

def name
  @name
end

#path ⇒ String

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

Returns:

  • (String) 


1131
1132
1133
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1131

def path
  @path
end

#tag_manager_url ⇒ String

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

Returns:

  • (String) 


1136
1137
1138
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1136

def tag_manager_url
  @tag_manager_url
end

#type ⇒ String

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

Returns:

  • (String) 


1141
1142
1143
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1141

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) 


1148
1149
1150
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1148

def url
  @url
end

#workspace_id ⇒ String

Represents a link to a quick preview of a workspace. Corresponds to the JSON property workspaceId

Returns:

  • (String) 


1153
1154
1155
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1153

def workspace_id
  @workspace_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
 
# File 'lib/google/apis/tagmanager_v2/classes.rb', line 1160

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 = args[:authorization_timestamp] if args.key?(:authorization_timestamp)
  @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)
  @path = args[:path] if args.key?(:path)
  @tag_manager_url = args[:tag_manager_url] if args.key?(:tag_manager_url)
  @type = args[:type] if args.key?(:type)
  @url = args[:url] if args.key?(:url)
  @workspace_id = args[:workspace_id] if args.key?(:workspace_id)
end