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

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

Overview

Tag Manager API

This API allows clients to access and modify container and tag configuration.

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

#initializeTagManagerService

Returns a new instance of TagManagerService.


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

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

Instance Attribute Details

#keyString

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.


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

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.


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

def quota_user
  @quota_user
end

Instance Method Details

#create_account_container_environment(account_id, container_id, environment_object = nil, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


335
336
337
338
339
340
341
342
343
344
345
346
# File 'generated/google/apis/tagmanager_v1/service.rb', line 335

def (, container_id, environment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#create_account_container_folder(account_id, container_id, folder_object = nil, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


517
518
519
520
521
522
523
524
525
526
527
528
# File 'generated/google/apis/tagmanager_v1/service.rb', line 517

def (, container_id, folder_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#create_container(account_id, container_object = nil, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


166
167
168
169
170
171
172
173
174
175
176
# File 'generated/google/apis/tagmanager_v1/service.rb', line 166

def create_container(, container_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#create_permission(account_id, user_access_object = nil, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1668

def create_permission(, user_access_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#create_tag(account_id, container_id, tag_object = nil, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


820
821
822
823
824
825
826
827
828
829
830
831
# File 'generated/google/apis/tagmanager_v1/service.rb', line 820

def create_tag(, container_id, tag_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#create_trigger(account_id, container_id, trigger_object = nil, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1002

def create_trigger(, container_id, trigger_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#create_variable(account_id, container_id, variable_object = nil, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1184

def create_variable(, container_id, variable_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'tagmanager/v1/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?
  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, 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def create_version(, container_id, create_container_version_request_version_options_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#delete_account_container_environment(account_id, container_id, environment_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    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:


372
373
374
375
376
377
378
379
380
# File 'generated/google/apis/tagmanager_v1/service.rb', line 372

def (, container_id, environment_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#delete_account_container_folder(account_id, container_id, folder_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    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:


554
555
556
557
558
559
560
561
562
# File 'generated/google/apis/tagmanager_v1/service.rb', line 554

def (, container_id, folder_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#delete_container(account_id, container_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    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:


200
201
202
203
204
205
206
207
# File 'generated/google/apis/tagmanager_v1/service.rb', line 200

def delete_container(, container_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#delete_permission(account_id, permission_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    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:


1703
1704
1705
1706
1707
1708
1709
1710
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1703

def delete_permission(, permission_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#delete_tag(account_id, container_id, tag_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    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:


857
858
859
860
861
862
863
864
865
# File 'generated/google/apis/tagmanager_v1/service.rb', line 857

def delete_tag(, container_id, tag_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#delete_trigger(account_id, container_id, trigger_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    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:


1039
1040
1041
1042
1043
1044
1045
1046
1047
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1039

def delete_trigger(, container_id, trigger_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#delete_variable(account_id, container_id, variable_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    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:


1221
1222
1223
1224
1225
1226
1227
1228
1229
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1221

def delete_variable(, container_id, variable_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#delete_version(account_id, container_id, container_version_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    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:


1403
1404
1405
1406
1407
1408
1409
1410
1411
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1403

def delete_version(, container_id, container_version_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

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

Gets a GTM Account.

Parameters:

  • account_id (String)

    The GTM Account ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


71
72
73
74
75
76
77
78
79
# File 'generated/google/apis/tagmanager_v1/service.rb', line 71

def (, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#get_account_container_environment(account_id, container_id, environment_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def (, container_id, environment_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#get_account_container_folder(account_id, container_id, folder_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


588
589
590
591
592
593
594
595
596
597
598
# File 'generated/google/apis/tagmanager_v1/service.rb', line 588

def (, container_id, folder_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#get_container(account_id, container_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


231
232
233
234
235
236
237
238
239
240
# File 'generated/google/apis/tagmanager_v1/service.rb', line 231

def get_container(, container_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#get_permission(account_id, permission_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1734

def get_permission(, permission_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#get_tag(account_id, container_id, tag_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


891
892
893
894
895
896
897
898
899
900
901
# File 'generated/google/apis/tagmanager_v1/service.rb', line 891

def get_tag(, container_id, tag_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#get_trigger(account_id, container_id, trigger_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1073

def get_trigger(, container_id, trigger_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#get_variable(account_id, container_id, variable_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1255

def get_variable(, container_id, variable_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#get_version(account_id, container_id, container_version_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1438

def get_version(, container_id, container_version_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#list_account_container_environments(account_id, container_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def (, container_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#list_account_container_folder_entities(account_id, container_id, folder_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


700
701
702
703
704
705
706
707
708
709
710
# File 'generated/google/apis/tagmanager_v1/service.rb', line 700

def (, container_id, folder_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#list_account_container_folders(account_id, container_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


622
623
624
625
626
627
628
629
630
631
# File 'generated/google/apis/tagmanager_v1/service.rb', line 622

def (, container_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

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

Lists all GTM Accounts that a user has access to.

Parameters:

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


99
100
101
102
103
104
105
106
# File 'generated/google/apis/tagmanager_v1/service.rb', line 99

def list_accounts(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#list_containers(account_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


262
263
264
265
266
267
268
269
270
# File 'generated/google/apis/tagmanager_v1/service.rb', line 262

def list_containers(, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#list_permissions(account_id, fields: nil, quota_user: 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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1766
1767
1768
1769
1770
1771
1772
1773
1774
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1766

def list_permissions(, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#list_tags(account_id, container_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


925
926
927
928
929
930
931
932
933
934
# File 'generated/google/apis/tagmanager_v1/service.rb', line 925

def list_tags(, container_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#list_triggers(account_id, container_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1107

def list_triggers(, container_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#list_variables(account_id, container_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def list_variables(, container_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#list_versions(account_id, container_id, headers: nil, include_deleted: nil, fields: nil, quota_user: 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) (defaults to: nil)

    Retrieve headers only when true.

  • include_deleted (Boolean) (defaults to: nil)

    Also retrieve deleted (archived) versions when true.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1476

def list_versions(, container_id, headers: nil, include_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#publish_version(account_id, container_id, container_version_id, fingerprint: nil, fields: nil, quota_user: 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) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1516

def publish_version(, container_id, container_version_id, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#restore_version(account_id, container_id, container_version_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1556

def restore_version(, container_id, container_version_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#undelete_version(account_id, container_id, container_version_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1592

def undelete_version(, container_id, container_version_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#update_account(account_id, account_object = nil, fingerprint: nil, fields: nil, quota_user: 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) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


132
133
134
135
136
137
138
139
140
141
142
143
# File 'generated/google/apis/tagmanager_v1/service.rb', line 132

def (,  = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'tagmanager/v1/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?
  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, 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) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def (, container_id, environment_id, environment_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'tagmanager/v1/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?
  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, 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) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


661
662
663
664
665
666
667
668
669
670
671
672
673
674
# File 'generated/google/apis/tagmanager_v1/service.rb', line 661

def (, container_id, folder_id, folder_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'tagmanager/v1/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?
  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, 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) (defaults to: nil)

    The tags to be moved to the folder.

  • trigger_id (Array<String>, String) (defaults to: nil)

    The triggers to be moved to the folder.

  • variable_id (Array<String>, String) (defaults to: nil)

    The variables to be moved to the folder.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    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:


743
744
745
746
747
748
749
750
751
752
753
754
755
756
# File 'generated/google/apis/tagmanager_v1/service.rb', line 743

def (, container_id, folder_id, folder_object = nil, tag_id: nil, trigger_id: nil, variable_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'tagmanager/v1/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?
  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, 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


783
784
785
786
787
788
789
790
791
792
793
794
795
# File 'generated/google/apis/tagmanager_v1/service.rb', line 783

def (, container_id, environment_id, environment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#update_container(account_id, container_id, container_object = nil, fingerprint: nil, fields: nil, quota_user: 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) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


298
299
300
301
302
303
304
305
306
307
308
309
310
# File 'generated/google/apis/tagmanager_v1/service.rb', line 298

def update_container(, container_id, container_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end

#update_permission(account_id, permission_id, user_access_object = nil, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1799

def update_permission(, permission_id, user_access_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'tagmanager/v1/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?
  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, 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) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


964
965
966
967
968
969
970
971
972
973
974
975
976
977
# File 'generated/google/apis/tagmanager_v1/service.rb', line 964

def update_tag(, container_id, tag_id, tag_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'tagmanager/v1/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?
  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, 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) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1146

def update_trigger(, container_id, trigger_id, trigger_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'tagmanager/v1/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?
  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, 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) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    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
1341
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1328

def update_variable(, container_id, variable_id, variable_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'tagmanager/v1/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?
  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, 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) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1632

def update_version(, container_id, container_version_id, container_version_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'tagmanager/v1/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?
  execute_or_queue_command(command, &block)
end