Class: Google::Apis::TagmanagerV1::TagManagerService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/tagmanager_v1/service.rb

Overview

Tag Manager API

Accesses Tag Manager accounts and containers.

Examples:

require 'google/apis/tagmanager_v1'

Tagmanager = Google::Apis::TagmanagerV1 # Alias the module
service = Tagmanager::TagManagerService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ TagManagerService

Returns a new instance of TagManagerService



49
50
51
52
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 49

def initialize
  super('https://www.googleapis.com/', 'tagmanager/v1/')
  @batch_path = 'batch/tagmanager/v1'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



38
39
40
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

  • (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.



43
44
45
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 43

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String) —

    Deprecated. Please use quotaUser instead.



47
48
49
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 47

def user_ip
  @user_ip
end

Instance Method Details

#create_account_container_environment(account_id, container_id, environment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Environment

Creates a GTM Environment.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • environment_object (Google::Apis::TagmanagerV1::Environment) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 364

def (, container_id, environment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'accounts/{accountId}/containers/{containerId}/environments', options)
  command.request_representation = Google::Apis::TagmanagerV1::Environment::Representation
  command.request_object = environment_object
  command.response_representation = Google::Apis::TagmanagerV1::Environment::Representation
  command.response_class = Google::Apis::TagmanagerV1::Environment
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#create_account_container_folder(account_id, container_id, folder_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Folder

Creates a GTM Folder.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • folder_object (Google::Apis::TagmanagerV1::Folder) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



607
608
609
610
611
612
613
614
615
616
617
618
619
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 607

def (, container_id, folder_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'accounts/{accountId}/containers/{containerId}/folders', options)
  command.request_representation = Google::Apis::TagmanagerV1::Folder::Representation
  command.request_object = folder_object
  command.response_representation = Google::Apis::TagmanagerV1::Folder::Representation
  command.response_class = Google::Apis::TagmanagerV1::Folder
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#create_container(account_id, container_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Container

Creates a Container.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_object (Google::Apis::TagmanagerV1::Container) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 180

def create_container(, container_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'accounts/{accountId}/containers', options)
  command.request_representation = Google::Apis::TagmanagerV1::Container::Representation
  command.request_object = container_object
  command.response_representation = Google::Apis::TagmanagerV1::Container::Representation
  command.response_class = Google::Apis::TagmanagerV1::Container
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#create_permission(account_id, user_access_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::UserAccess

Creates a user's Account & Container Permissions.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • user_access_object (Google::Apis::TagmanagerV1::UserAccess) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1851

def create_permission(, user_access_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'accounts/{accountId}/permissions', options)
  command.request_representation = Google::Apis::TagmanagerV1::UserAccess::Representation
  command.request_object = user_access_object
  command.response_representation = Google::Apis::TagmanagerV1::UserAccess::Representation
  command.response_class = Google::Apis::TagmanagerV1::UserAccess
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#create_tag(account_id, container_id, tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Tag

Creates a GTM Tag.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • tag_object (Google::Apis::TagmanagerV1::Tag) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



934
935
936
937
938
939
940
941
942
943
944
945
946
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 934

def create_tag(, container_id, tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'accounts/{accountId}/containers/{containerId}/tags', options)
  command.request_representation = Google::Apis::TagmanagerV1::Tag::Representation
  command.request_object = tag_object
  command.response_representation = Google::Apis::TagmanagerV1::Tag::Representation
  command.response_class = Google::Apis::TagmanagerV1::Tag
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#create_trigger(account_id, container_id, trigger_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Trigger

Creates a GTM Trigger.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • trigger_object (Google::Apis::TagmanagerV1::Trigger) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1131

def create_trigger(, container_id, trigger_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'accounts/{accountId}/containers/{containerId}/triggers', options)
  command.request_representation = Google::Apis::TagmanagerV1::Trigger::Representation
  command.request_object = trigger_object
  command.response_representation = Google::Apis::TagmanagerV1::Trigger::Representation
  command.response_class = Google::Apis::TagmanagerV1::Trigger
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#create_variable(account_id, container_id, variable_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Variable

Creates a GTM Variable.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • variable_object (Google::Apis::TagmanagerV1::Variable) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1328

def create_variable(, container_id, variable_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'accounts/{accountId}/containers/{containerId}/variables', options)
  command.request_representation = Google::Apis::TagmanagerV1::Variable::Representation
  command.request_object = variable_object
  command.response_representation = Google::Apis::TagmanagerV1::Variable::Representation
  command.response_class = Google::Apis::TagmanagerV1::Variable
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#create_version(account_id, container_id, create_container_version_request_version_options_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::CreateContainerVersionResponse

Creates a Container Version.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • create_container_version_request_version_options_object (Google::Apis::TagmanagerV1::CreateContainerVersionRequestVersionOptions) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1525

def create_version(, container_id, create_container_version_request_version_options_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'accounts/{accountId}/containers/{containerId}/versions', options)
  command.request_representation = Google::Apis::TagmanagerV1::CreateContainerVersionRequestVersionOptions::Representation
  command.request_object = create_container_version_request_version_options_object
  command.response_representation = Google::Apis::TagmanagerV1::CreateContainerVersionResponse::Representation
  command.response_class = Google::Apis::TagmanagerV1::CreateContainerVersionResponse
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_account_container_environment(account_id, container_id, environment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a GTM Environment.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • environment_id (String) —

    The GTM Environment ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



404
405
406
407
408
409
410
411
412
413
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 404

def (, container_id, environment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'accounts/{accountId}/containers/{containerId}/environments/{environmentId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['environmentId'] = environment_id unless environment_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_account_container_folder(account_id, container_id, folder_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a GTM Folder.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • folder_id (String) —

    The GTM Folder ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



647
648
649
650
651
652
653
654
655
656
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 647

def (, container_id, folder_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'accounts/{accountId}/containers/{containerId}/folders/{folderId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['folderId'] = folder_id unless folder_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_container(account_id, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a Container.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



217
218
219
220
221
222
223
224
225
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 217

def delete_container(, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'accounts/{accountId}/containers/{containerId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_permission(account_id, permission_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Removes a user from the account, revoking access to it and all of its containers.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • permission_id (String) —

    The GTM User ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



1889
1890
1891
1892
1893
1894
1895
1896
1897
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1889

def delete_permission(, permission_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'accounts/{accountId}/permissions/{permissionId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['permissionId'] = permission_id unless permission_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_tag(account_id, container_id, tag_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a GTM Tag.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • tag_id (String) —

    The GTM Tag ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



974
975
976
977
978
979
980
981
982
983
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 974

def delete_tag(, container_id, tag_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'accounts/{accountId}/containers/{containerId}/tags/{tagId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['tagId'] = tag_id unless tag_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_trigger(account_id, container_id, trigger_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a GTM Trigger.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • trigger_id (String) —

    The GTM Trigger ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1171

def delete_trigger(, container_id, trigger_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'accounts/{accountId}/containers/{containerId}/triggers/{triggerId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['triggerId'] = trigger_id unless trigger_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_variable(account_id, container_id, variable_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a GTM Variable.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • variable_id (String) —

    The GTM Variable ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1368

def delete_variable(, container_id, variable_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'accounts/{accountId}/containers/{containerId}/variables/{variableId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['variableId'] = variable_id unless variable_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_version(account_id, container_id, container_version_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a Container Version.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • container_version_id (String) —

    The GTM Container Version ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1565

def delete_version(, container_id, container_version_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['containerVersionId'] = container_version_id unless container_version_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_account(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Account

Gets a GTM Account.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



76
77
78
79
80
81
82
83
84
85
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 76

def (, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}', options)
  command.response_representation = Google::Apis::TagmanagerV1::Account::Representation
  command.response_class = Google::Apis::TagmanagerV1::Account
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_account_container_environment(account_id, container_id, environment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Environment

Gets a GTM Environment.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • environment_id (String) —

    The GTM Environment ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 441

def (, container_id, environment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/environments/{environmentId}', options)
  command.response_representation = Google::Apis::TagmanagerV1::Environment::Representation
  command.response_class = Google::Apis::TagmanagerV1::Environment
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['environmentId'] = environment_id unless environment_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_account_container_folder(account_id, container_id, folder_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Folder

Gets a GTM Folder.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • folder_id (String) —

    The GTM Folder ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



684
685
686
687
688
689
690
691
692
693
694
695
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 684

def (, container_id, folder_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/folders/{folderId}', options)
  command.response_representation = Google::Apis::TagmanagerV1::Folder::Representation
  command.response_class = Google::Apis::TagmanagerV1::Folder
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['folderId'] = folder_id unless folder_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_container(account_id, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Container

Gets a Container.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



251
252
253
254
255
256
257
258
259
260
261
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 251

def get_container(, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}', options)
  command.response_representation = Google::Apis::TagmanagerV1::Container::Representation
  command.response_class = Google::Apis::TagmanagerV1::Container
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_permission(account_id, permission_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::UserAccess

Gets a user's Account & Container Permissions.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • permission_id (String) —

    The GTM User ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1923

def get_permission(, permission_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/permissions/{permissionId}', options)
  command.response_representation = Google::Apis::TagmanagerV1::UserAccess::Representation
  command.response_class = Google::Apis::TagmanagerV1::UserAccess
  command.params['accountId'] =  unless .nil?
  command.params['permissionId'] = permission_id unless permission_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_tag(account_id, container_id, tag_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Tag

Gets a GTM Tag.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • tag_id (String) —

    The GTM Tag ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1011

def get_tag(, container_id, tag_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/tags/{tagId}', options)
  command.response_representation = Google::Apis::TagmanagerV1::Tag::Representation
  command.response_class = Google::Apis::TagmanagerV1::Tag
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['tagId'] = tag_id unless tag_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_trigger(account_id, container_id, trigger_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Trigger

Gets a GTM Trigger.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • trigger_id (String) —

    The GTM Trigger ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1208

def get_trigger(, container_id, trigger_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/triggers/{triggerId}', options)
  command.response_representation = Google::Apis::TagmanagerV1::Trigger::Representation
  command.response_class = Google::Apis::TagmanagerV1::Trigger
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['triggerId'] = trigger_id unless trigger_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_variable(account_id, container_id, variable_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Variable

Gets a GTM Variable.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • variable_id (String) —

    The GTM Variable ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1405

def get_variable(, container_id, variable_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/variables/{variableId}', options)
  command.response_representation = Google::Apis::TagmanagerV1::Variable::Representation
  command.response_class = Google::Apis::TagmanagerV1::Variable
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['variableId'] = variable_id unless variable_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_version(account_id, container_id, container_version_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::ContainerVersion

Gets a Container Version.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • container_version_id (String) —

    The GTM Container Version ID. Specify published to retrieve the currently published version.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1603

def get_version(, container_id, container_version_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}', options)
  command.response_representation = Google::Apis::TagmanagerV1::ContainerVersion::Representation
  command.response_class = Google::Apis::TagmanagerV1::ContainerVersion
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['containerVersionId'] = container_version_id unless container_version_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_account_container_environments(account_id, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::ListEnvironmentsResponse

Lists all GTM Environments of a GTM Container.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



478
479
480
481
482
483
484
485
486
487
488
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 478

def (, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/environments', options)
  command.response_representation = Google::Apis::TagmanagerV1::ListEnvironmentsResponse::Representation
  command.response_class = Google::Apis::TagmanagerV1::ListEnvironmentsResponse
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_account_container_folder_entities(account_id, container_id, folder_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::FolderEntities

List all entities in a GTM Folder.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • folder_id (String) —

    The GTM Folder ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 805

def (, container_id, folder_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/folders/{folderId}/entities', options)
  command.response_representation = Google::Apis::TagmanagerV1::FolderEntities::Representation
  command.response_class = Google::Apis::TagmanagerV1::FolderEntities
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['folderId'] = folder_id unless folder_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_account_container_folders(account_id, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::ListFoldersResponse

Lists all GTM Folders of a Container.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



721
722
723
724
725
726
727
728
729
730
731
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 721

def (, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/folders', options)
  command.response_representation = Google::Apis::TagmanagerV1::ListFoldersResponse::Representation
  command.response_class = Google::Apis::TagmanagerV1::ListFoldersResponse
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_accounts(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::ListAccountsResponse

Lists all GTM Accounts that a user has access to.

Parameters:

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



107
108
109
110
111
112
113
114
115
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 107

def list_accounts(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts', options)
  command.response_representation = Google::Apis::TagmanagerV1::ListAccountsResponse::Representation
  command.response_class = Google::Apis::TagmanagerV1::ListAccountsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_containers(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::ListContainersResponse

Lists all Containers that belongs to a GTM Account.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



285
286
287
288
289
290
291
292
293
294
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 285

def list_containers(, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/containers', options)
  command.response_representation = Google::Apis::TagmanagerV1::ListContainersResponse::Representation
  command.response_class = Google::Apis::TagmanagerV1::ListContainersResponse
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_permissions(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::ListAccountUsersResponse

List all users that have access to the account along with Account and Container Permissions granted to each of them.

Parameters:

  • account_id (String) —

    The GTM Account ID. @required tagmanager.accounts.permissions.list

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1958

def list_permissions(, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/permissions', options)
  command.response_representation = Google::Apis::TagmanagerV1::ListAccountUsersResponse::Representation
  command.response_class = Google::Apis::TagmanagerV1::ListAccountUsersResponse
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_tags(account_id, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::ListTagsResponse

Lists all GTM Tags of a Container.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1048

def list_tags(, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/tags', options)
  command.response_representation = Google::Apis::TagmanagerV1::ListTagsResponse::Representation
  command.response_class = Google::Apis::TagmanagerV1::ListTagsResponse
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_triggers(account_id, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::ListTriggersResponse

Lists all GTM Triggers of a Container.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1245

def list_triggers(, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/triggers', options)
  command.response_representation = Google::Apis::TagmanagerV1::ListTriggersResponse::Representation
  command.response_class = Google::Apis::TagmanagerV1::ListTriggersResponse
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_variables(account_id, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::ListVariablesResponse

Lists all GTM Variables of a Container.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1442

def list_variables(, container_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/variables', options)
  command.response_representation = Google::Apis::TagmanagerV1::ListVariablesResponse::Representation
  command.response_class = Google::Apis::TagmanagerV1::ListVariablesResponse
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_versions(account_id, container_id, headers: nil, include_deleted: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::ListContainerVersionsResponse

Lists all Container Versions of a GTM Container.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • headers (Boolean) —

    Retrieve headers only when true.

  • include_deleted (Boolean) —

    Also retrieve deleted (archived) versions when true.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1644

def list_versions(, container_id, headers: nil, include_deleted: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{accountId}/containers/{containerId}/versions', options)
  command.response_representation = Google::Apis::TagmanagerV1::ListContainerVersionsResponse::Representation
  command.response_class = Google::Apis::TagmanagerV1::ListContainerVersionsResponse
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.query['headers'] = headers unless headers.nil?
  command.query['includeDeleted'] = include_deleted unless include_deleted.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_account_container_environment(account_id, container_id, environment_id, environment_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Environment

Updates a GTM Environment. This method supports patch semantics.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • environment_id (String) —

    The GTM Environment ID.

  • environment_object (Google::Apis::TagmanagerV1::Environment) (defaults to: nil)
  • fingerprint (String) —

    When provided, this fingerprint must match the fingerprint of the environment in storage.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 520

def (, container_id, environment_id, environment_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'accounts/{accountId}/containers/{containerId}/environments/{environmentId}', options)
  command.request_representation = Google::Apis::TagmanagerV1::Environment::Representation
  command.request_object = environment_object
  command.response_representation = Google::Apis::TagmanagerV1::Environment::Representation
  command.response_class = Google::Apis::TagmanagerV1::Environment
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['environmentId'] = environment_id unless environment_id.nil?
  command.query['fingerprint'] = fingerprint unless fingerprint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#publish_version(account_id, container_id, container_version_id, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::PublishContainerVersionResponse

Publishes a Container Version.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • container_version_id (String) —

    The GTM Container Version ID.

  • fingerprint (String) —

    When provided, this fingerprint must match the fingerprint of the container version in storage.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1687

def publish_version(, container_id, container_version_id, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/publish', options)
  command.response_representation = Google::Apis::TagmanagerV1::PublishContainerVersionResponse::Representation
  command.response_class = Google::Apis::TagmanagerV1::PublishContainerVersionResponse
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['containerVersionId'] = container_version_id unless container_version_id.nil?
  command.query['fingerprint'] = fingerprint unless fingerprint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#restore_version(account_id, container_id, container_version_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::ContainerVersion

Restores a Container Version. This will overwrite the container's current configuration (including its variables, triggers and tags). The operation will not have any effect on the version that is being served (i.e. the published version).

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • container_version_id (String) —

    The GTM Container Version ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1730

def restore_version(, container_id, container_version_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/restore', options)
  command.response_representation = Google::Apis::TagmanagerV1::ContainerVersion::Representation
  command.response_class = Google::Apis::TagmanagerV1::ContainerVersion
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['containerVersionId'] = container_version_id unless container_version_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#undelete_version(account_id, container_id, container_version_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::ContainerVersion

Undeletes a Container Version.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • container_version_id (String) —

    The GTM Container Version ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1769

def undelete_version(, container_id, container_version_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/undelete', options)
  command.response_representation = Google::Apis::TagmanagerV1::ContainerVersion::Representation
  command.response_class = Google::Apis::TagmanagerV1::ContainerVersion
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['containerVersionId'] = container_version_id unless container_version_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_account(account_id, account_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Account

Updates a GTM Account.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • account_object (Google::Apis::TagmanagerV1::Account) (defaults to: nil)
  • fingerprint (String) —

    When provided, this fingerprint must match the fingerprint of the account in storage.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 143

def (,  = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'accounts/{accountId}', options)
  command.request_representation = Google::Apis::TagmanagerV1::Account::Representation
  command.request_object = 
  command.response_representation = Google::Apis::TagmanagerV1::Account::Representation
  command.response_class = Google::Apis::TagmanagerV1::Account
  command.params['accountId'] =  unless .nil?
  command.query['fingerprint'] = fingerprint unless fingerprint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_account_container_environment(account_id, container_id, environment_id, environment_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Environment

Updates a GTM Environment.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • environment_id (String) —

    The GTM Environment ID.

  • environment_object (Google::Apis::TagmanagerV1::Environment) (defaults to: nil)
  • fingerprint (String) —

    When provided, this fingerprint must match the fingerprint of the environment in storage.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 566

def (, container_id, environment_id, environment_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'accounts/{accountId}/containers/{containerId}/environments/{environmentId}', options)
  command.request_representation = Google::Apis::TagmanagerV1::Environment::Representation
  command.request_object = environment_object
  command.response_representation = Google::Apis::TagmanagerV1::Environment::Representation
  command.response_class = Google::Apis::TagmanagerV1::Environment
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['environmentId'] = environment_id unless environment_id.nil?
  command.query['fingerprint'] = fingerprint unless fingerprint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_account_container_folder(account_id, container_id, folder_id, folder_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Folder

Updates a GTM Folder.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • folder_id (String) —

    The GTM Folder ID.

  • folder_object (Google::Apis::TagmanagerV1::Folder) (defaults to: nil)
  • fingerprint (String) —

    When provided, this fingerprint must match the fingerprint of the folder in storage.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 763

def (, container_id, folder_id, folder_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'accounts/{accountId}/containers/{containerId}/folders/{folderId}', options)
  command.request_representation = Google::Apis::TagmanagerV1::Folder::Representation
  command.request_object = folder_object
  command.response_representation = Google::Apis::TagmanagerV1::Folder::Representation
  command.response_class = Google::Apis::TagmanagerV1::Folder
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['folderId'] = folder_id unless folder_id.nil?
  command.query['fingerprint'] = fingerprint unless fingerprint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_account_container_move_folder(account_id, container_id, folder_id, folder_object = nil, tag_id: nil, trigger_id: nil, variable_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Moves entities to a GTM Folder.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • folder_id (String) —

    The GTM Folder ID.

  • folder_object (Google::Apis::TagmanagerV1::Folder) (defaults to: nil)
  • tag_id (Array<String>, String) —

    The tags to be moved to the folder.

  • trigger_id (Array<String>, String) —

    The triggers to be moved to the folder.

  • variable_id (Array<String>, String) —

    The variables to be moved to the folder.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 851

def (, container_id, folder_id, folder_object = nil, tag_id: nil, trigger_id: nil, variable_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'accounts/{accountId}/containers/{containerId}/move_folders/{folderId}', options)
  command.request_representation = Google::Apis::TagmanagerV1::Folder::Representation
  command.request_object = folder_object
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['folderId'] = folder_id unless folder_id.nil?
  command.query['tagId'] = tag_id unless tag_id.nil?
  command.query['triggerId'] = trigger_id unless trigger_id.nil?
  command.query['variableId'] = variable_id unless variable_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_account_container_reauthorize_environment(account_id, container_id, environment_id, environment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Environment

Re-generates the authorization code for a GTM Environment.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • environment_id (String) —

    The GTM Environment ID.

  • environment_object (Google::Apis::TagmanagerV1::Environment) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



894
895
896
897
898
899
900
901
902
903
904
905
906
907
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 894

def (, container_id, environment_id, environment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'accounts/{accountId}/containers/{containerId}/reauthorize_environments/{environmentId}', options)
  command.request_representation = Google::Apis::TagmanagerV1::Environment::Representation
  command.request_object = environment_object
  command.response_representation = Google::Apis::TagmanagerV1::Environment::Representation
  command.response_class = Google::Apis::TagmanagerV1::Environment
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['environmentId'] = environment_id unless environment_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_container(account_id, container_id, container_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Container

Updates a Container.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • container_object (Google::Apis::TagmanagerV1::Container) (defaults to: nil)
  • fingerprint (String) —

    When provided, this fingerprint must match the fingerprint of the container in storage.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 324

def update_container(, container_id, container_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'accounts/{accountId}/containers/{containerId}', options)
  command.request_representation = Google::Apis::TagmanagerV1::Container::Representation
  command.request_object = container_object
  command.response_representation = Google::Apis::TagmanagerV1::Container::Representation
  command.response_class = Google::Apis::TagmanagerV1::Container
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.query['fingerprint'] = fingerprint unless fingerprint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_permission(account_id, permission_id, user_access_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::UserAccess

Updates a user's Account & Container Permissions.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • permission_id (String) —

    The GTM User ID.

  • user_access_object (Google::Apis::TagmanagerV1::UserAccess) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1994

def update_permission(, permission_id, user_access_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'accounts/{accountId}/permissions/{permissionId}', options)
  command.request_representation = Google::Apis::TagmanagerV1::UserAccess::Representation
  command.request_object = user_access_object
  command.response_representation = Google::Apis::TagmanagerV1::UserAccess::Representation
  command.response_class = Google::Apis::TagmanagerV1::UserAccess
  command.params['accountId'] =  unless .nil?
  command.params['permissionId'] = permission_id unless permission_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_tag(account_id, container_id, tag_id, tag_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Tag

Updates a GTM Tag.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • tag_id (String) —

    The GTM Tag ID.

  • tag_object (Google::Apis::TagmanagerV1::Tag) (defaults to: nil)
  • fingerprint (String) —

    When provided, this fingerprint must match the fingerprint of the tag in storage.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1090

def update_tag(, container_id, tag_id, tag_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'accounts/{accountId}/containers/{containerId}/tags/{tagId}', options)
  command.request_representation = Google::Apis::TagmanagerV1::Tag::Representation
  command.request_object = tag_object
  command.response_representation = Google::Apis::TagmanagerV1::Tag::Representation
  command.response_class = Google::Apis::TagmanagerV1::Tag
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['tagId'] = tag_id unless tag_id.nil?
  command.query['fingerprint'] = fingerprint unless fingerprint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_trigger(account_id, container_id, trigger_id, trigger_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Trigger

Updates a GTM Trigger.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • trigger_id (String) —

    The GTM Trigger ID.

  • trigger_object (Google::Apis::TagmanagerV1::Trigger) (defaults to: nil)
  • fingerprint (String) —

    When provided, this fingerprint must match the fingerprint of the trigger in storage.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1287

def update_trigger(, container_id, trigger_id, trigger_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'accounts/{accountId}/containers/{containerId}/triggers/{triggerId}', options)
  command.request_representation = Google::Apis::TagmanagerV1::Trigger::Representation
  command.request_object = trigger_object
  command.response_representation = Google::Apis::TagmanagerV1::Trigger::Representation
  command.response_class = Google::Apis::TagmanagerV1::Trigger
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['triggerId'] = trigger_id unless trigger_id.nil?
  command.query['fingerprint'] = fingerprint unless fingerprint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_variable(account_id, container_id, variable_id, variable_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::Variable

Updates a GTM Variable.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • variable_id (String) —

    The GTM Variable ID.

  • variable_object (Google::Apis::TagmanagerV1::Variable) (defaults to: nil)
  • fingerprint (String) —

    When provided, this fingerprint must match the fingerprint of the variable in storage.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1484

def update_variable(, container_id, variable_id, variable_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'accounts/{accountId}/containers/{containerId}/variables/{variableId}', options)
  command.request_representation = Google::Apis::TagmanagerV1::Variable::Representation
  command.request_object = variable_object
  command.response_representation = Google::Apis::TagmanagerV1::Variable::Representation
  command.response_class = Google::Apis::TagmanagerV1::Variable
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['variableId'] = variable_id unless variable_id.nil?
  command.query['fingerprint'] = fingerprint unless fingerprint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_version(account_id, container_id, container_version_id, container_version_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV1::ContainerVersion

Updates a Container Version.

Parameters:

  • account_id (String) —

    The GTM Account ID.

  • container_id (String) —

    The GTM Container ID.

  • container_version_id (String) —

    The GTM Container Version ID.

  • container_version_object (Google::Apis::TagmanagerV1::ContainerVersion) (defaults to: nil)
  • fingerprint (String) —

    When provided, this fingerprint must match the fingerprint of the container version in storage.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1812

def update_version(, container_id, container_version_id, container_version_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}', options)
  command.request_representation = Google::Apis::TagmanagerV1::ContainerVersion::Representation
  command.request_object = container_version_object
  command.response_representation = Google::Apis::TagmanagerV1::ContainerVersion::Representation
  command.response_class = Google::Apis::TagmanagerV1::ContainerVersion
  command.params['accountId'] =  unless .nil?
  command.params['containerId'] = container_id unless container_id.nil?
  command.params['containerVersionId'] = container_version_id unless container_version_id.nil?
  command.query['fingerprint'] = fingerprint unless fingerprint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end