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



51
52
53
54
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 51

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 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. Overrides userIp if both are provided.

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. Overrides userIp if both are provided.



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

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

  • (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.



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

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 384

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



639
640
641
642
643
644
645
646
647
648
649
650
651
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 639

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 190

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1945

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



982
983
984
985
986
987
988
989
990
991
992
993
994
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 982

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1189

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1396

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:



426
427
428
429
430
431
432
433
434
435
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 426

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:



681
682
683
684
685
686
687
688
689
690
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 681

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:



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

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:



1985
1986
1987
1988
1989
1990
1991
1992
1993
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1985

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:



1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1024

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1231

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:



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

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:



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

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



80
81
82
83
84
85
86
87
88
89
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 80

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 465

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



265
266
267
268
269
270
271
272
273
274
275
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 265

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 2021

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1063

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1270

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



504
505
506
507
508
509
510
511
512
513
514
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 504

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



847
848
849
850
851
852
853
854
855
856
857
858
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 847

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



759
760
761
762
763
764
765
766
767
768
769
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 759

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



113
114
115
116
117
118
119
120
121
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 113

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 2058

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1102

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1309

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

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

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 548

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1773

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1818

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1859

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 151

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 596

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:



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

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



940
941
942
943
944
945
946
947
948
949
950
951
952
953
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 940

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 342

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 2096

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

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

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1353

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

    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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
 
# File 'generated/google/apis/tagmanager_v1/service.rb', line 1904

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