Class: Google::Apis::TagmanagerV2::TagManagerService

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

Overview

Tag Manager API

Accesses Tag Manager accounts and containers.

Examples:

require 'google/apis/tagmanager_v2'

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

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

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

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeTagManagerService

Returns a new instance of TagManagerService


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

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

Instance Attribute Details

#keyString

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

Returns:

  • (String)

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


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

def key
  @key
end

#quota_userString

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

Returns:

  • (String)

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


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

def quota_user
  @quota_user
end

#user_ipString

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String)

    Deprecated. Please use quotaUser instead.


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

def user_ip
  @user_ip
end

Instance Method Details

#create_account_container(parent, container_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Container

Creates a Container.

Parameters:

  • parent (String)

    GTM Account's API relative path. Example: accounts/account_id.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


183
184
185
186
187
188
189
190
191
192
193
194
# File 'generated/google/apis/tagmanager_v2/service.rb', line 183

def (parent, container_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+parent}/containers', options)
  command.request_representation = Google::Apis::TagmanagerV2::Container::Representation
  command.request_object = container_object
  command.response_representation = Google::Apis::TagmanagerV2::Container::Representation
  command.response_class = Google::Apis::TagmanagerV2::Container
  command.params['parent'] = parent unless parent.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_environment(parent, environment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Environment

Creates a GTM Environment.

Parameters:

  • parent (String)

    GTM Container's API relative path. Example: accounts/account_id/containers/ container_id

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def (parent, environment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+parent}/environments', options)
  command.request_representation = Google::Apis::TagmanagerV2::Environment::Representation
  command.request_object = environment_object
  command.response_representation = Google::Apis::TagmanagerV2::Environment::Representation
  command.response_class = Google::Apis::TagmanagerV2::Environment
  command.params['parent'] = parent unless parent.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_workspace(parent, workspace_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Workspace

Creates a Workspace.

Parameters:

  • parent (String)

    GTM parent Container's API relative path. Example: accounts/account_id/ containers/container_id

  • workspace_object (Google::Apis::TagmanagerV2::Workspace) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


948
949
950
951
952
953
954
955
956
957
958
959
# File 'generated/google/apis/tagmanager_v2/service.rb', line 948

def (parent, workspace_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+parent}/workspaces', options)
  command.request_representation = Google::Apis::TagmanagerV2::Workspace::Representation
  command.request_object = workspace_object
  command.response_representation = Google::Apis::TagmanagerV2::Workspace::Representation
  command.response_class = Google::Apis::TagmanagerV2::Workspace
  command.params['parent'] = parent unless parent.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_workspace_built_in_variable(parent, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::CreateBuiltInVariableResponse

Creates one or more GTM Built-In Variables.

Parameters:

  • parent (String)

    GTM Workspace's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id

  • type (Array<String>, String)

    The types of built-in variables to enable.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1384

def (parent, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+parent}/built_in_variables', options)
  command.response_representation = Google::Apis::TagmanagerV2::CreateBuiltInVariableResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::CreateBuiltInVariableResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['type'] = type unless type.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_workspace_folder(parent, folder_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Folder

Creates a GTM Folder.

Parameters:

  • parent (String)

    GTM Workspace's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1529

def (parent, folder_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+parent}/folders', options)
  command.request_representation = Google::Apis::TagmanagerV2::Folder::Representation
  command.request_object = folder_object
  command.response_representation = Google::Apis::TagmanagerV2::Folder::Representation
  command.response_class = Google::Apis::TagmanagerV2::Folder
  command.params['parent'] = parent unless parent.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_workspace_tag(parent, tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Tag

Creates a GTM Tag.

Parameters:

  • parent (String)

    GTM Workspace's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1898

def (parent, tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+parent}/tags', options)
  command.request_representation = Google::Apis::TagmanagerV2::Tag::Representation
  command.request_object = tag_object
  command.response_representation = Google::Apis::TagmanagerV2::Tag::Representation
  command.response_class = Google::Apis::TagmanagerV2::Tag
  command.params['parent'] = parent unless parent.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_workspace_trigger(parent, trigger_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Trigger

Creates a GTM Trigger.

Parameters:

  • parent (String)

    GTM Workspaces's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
# File 'generated/google/apis/tagmanager_v2/service.rb', line 2117

def (parent, trigger_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+parent}/triggers', options)
  command.request_representation = Google::Apis::TagmanagerV2::Trigger::Representation
  command.request_object = trigger_object
  command.response_representation = Google::Apis::TagmanagerV2::Trigger::Representation
  command.response_class = Google::Apis::TagmanagerV2::Trigger
  command.params['parent'] = parent unless parent.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_workspace_variable(parent, variable_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Variable

Creates a GTM Variable.

Parameters:

  • parent (String)

    GTM Workspace's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
# File 'generated/google/apis/tagmanager_v2/service.rb', line 2336

def (parent, variable_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+parent}/variables', options)
  command.request_representation = Google::Apis::TagmanagerV2::Variable::Representation
  command.request_object = variable_object
  command.response_representation = Google::Apis::TagmanagerV2::Variable::Representation
  command.response_class = Google::Apis::TagmanagerV2::Variable
  command.params['parent'] = parent unless parent.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_workspace_version(path, create_container_version_request_version_options_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::CreateContainerVersionResponse

Creates a Container Version from the entities present in the workspace, deletes the workspace, and sets the base container version to the newly created version.

Parameters:

  • path (String)

    GTM Workspace's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


987
988
989
990
991
992
993
994
995
996
997
998
# File 'generated/google/apis/tagmanager_v2/service.rb', line 987

def (path, create_container_version_request_version_options_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+path}:create_version', options)
  command.request_representation = Google::Apis::TagmanagerV2::CreateContainerVersionRequestVersionOptions::Representation
  command.request_object = create_container_version_request_version_options_object
  command.response_representation = Google::Apis::TagmanagerV2::CreateContainerVersionResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::CreateContainerVersionResponse
  command.params['path'] = path unless path.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_user_permission(parent, user_permission_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::UserPermission

Creates a user's Account & Container access.

Parameters:

  • parent (String)

    GTM Account's API relative path. Example: accounts/account_id

  • user_permission_object (Google::Apis::TagmanagerV2::UserPermission) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
# File 'generated/google/apis/tagmanager_v2/service.rb', line 2554

def (parent, user_permission_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+parent}/user_permissions', options)
  command.request_representation = Google::Apis::TagmanagerV2::UserPermission::Representation
  command.request_object = user_permission_object
  command.response_representation = Google::Apis::TagmanagerV2::UserPermission::Representation
  command.response_class = Google::Apis::TagmanagerV2::UserPermission
  command.params['parent'] = parent unless parent.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_workspace_proposal(parent, create_workspace_proposal_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::WorkspaceProposal

Creates a GTM Workspace Proposal.

Parameters:

  • parent (String)

    GTM Workspace's API relative path. Example: accounts/aid/containers/cid/ workspace/wid

  • create_workspace_proposal_request_object (Google::Apis::TagmanagerV2::CreateWorkspaceProposalRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1829

def create_workspace_proposal(parent, create_workspace_proposal_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+parent}/proposal', options)
  command.request_representation = Google::Apis::TagmanagerV2::CreateWorkspaceProposalRequest::Representation
  command.request_object = create_workspace_proposal_request_object
  command.response_representation = Google::Apis::TagmanagerV2::WorkspaceProposal::Representation
  command.response_class = Google::Apis::TagmanagerV2::WorkspaceProposal
  command.params['parent'] = parent unless parent.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(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a Container.

Parameters:

  • path (String)

    GTM Container's API relative path. Example: accounts/account_id/containers/ container_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


219
220
221
222
223
224
225
226
# File 'generated/google/apis/tagmanager_v2/service.rb', line 219

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{+path}', options)
  command.params['path'] = path unless path.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(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a GTM Environment.

Parameters:

  • path (String)

    GTM Environment's API relative path. Example: accounts/account_id/containers/ container_id/environments/environment_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


399
400
401
402
403
404
405
406
# File 'generated/google/apis/tagmanager_v2/service.rb', line 399

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{+path}', options)
  command.params['path'] = path unless path.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_version(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a Container Version.

Parameters:

  • path (String)

    GTM ContainerVersion's API relative path. Example: accounts/account_id/ containers/container_id/versions/version_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


695
696
697
698
699
700
701
702
# File 'generated/google/apis/tagmanager_v2/service.rb', line 695

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{+path}', options)
  command.params['path'] = path unless path.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_workspace(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a Workspace.

Parameters:

  • path (String)

    GTM Workspace's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1023
1024
1025
1026
1027
1028
1029
1030
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1023

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{+path}', options)
  command.params['path'] = path unless path.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_workspace_built_in_variable(path, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes one or more GTM Built-In Variables.

Parameters:

  • path (String)

    GTM BuiltInVariable's API relative path. Example: accounts/account_id/ containers/container_id/workspaces/workspace_id/built_in_variables

  • type (Array<String>, String)

    The types of built-in variables to delete.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1421
1422
1423
1424
1425
1426
1427
1428
1429
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1421

def (path, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{+path}', options)
  command.params['path'] = path unless path.nil?
  command.query['type'] = type unless type.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_workspace_folder(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a GTM Folder.

Parameters:

  • path (String)

    GTM Folder's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id/folders/folder_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


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

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{+path}', options)
  command.params['path'] = path unless path.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_workspace_proposal(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a GTM Workspace Proposal.

Parameters:

  • path (String)

    GTM workspace proposal's relative path: Example: accounts/aid/containers/ cid/workspace/wid/workspace_proposal

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1865
1866
1867
1868
1869
1870
1871
1872
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1865

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{+path}', options)
  command.params['path'] = path unless path.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_workspace_tag(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a GTM Tag.

Parameters:

  • path (String)

    GTM Tag's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id/tags/tag_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1934
1935
1936
1937
1938
1939
1940
1941
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1934

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{+path}', options)
  command.params['path'] = path unless path.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_workspace_trigger(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a GTM Trigger.

Parameters:

  • path (String)

    GTM Trigger's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id/triggers/trigger_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


2153
2154
2155
2156
2157
2158
2159
2160
# File 'generated/google/apis/tagmanager_v2/service.rb', line 2153

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{+path}', options)
  command.params['path'] = path unless path.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_workspace_variable(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a GTM Variable.

Parameters:

  • path (String)

    GTM Variable's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id/variables/variable_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


2372
2373
2374
2375
2376
2377
2378
2379
# File 'generated/google/apis/tagmanager_v2/service.rb', line 2372

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{+path}', options)
  command.params['path'] = path unless path.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_user_permission(path, 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:

  • path (String)

    GTM UserPermission's API relative path. Example: accounts/account_id/ user_permissions/user_permission_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


2591
2592
2593
2594
2595
2596
2597
2598
# File 'generated/google/apis/tagmanager_v2/service.rb', line 2591

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{+path}', options)
  command.params['path'] = path unless path.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

#entities_account_container_workspace_folder(path, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::FolderEntities

List all entities in a GTM Folder.

Parameters:

  • path (String)

    GTM Folder's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id/folders/folder_id

  • page_token (String)

    Continuation token for fetching the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1599

def (path, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+path}:entities', options)
  command.response_representation = Google::Apis::TagmanagerV2::FolderEntities::Representation
  command.response_class = Google::Apis::TagmanagerV2::FolderEntities
  command.params['path'] = path unless path.nil?
  command.query['pageToken'] = page_token unless page_token.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(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Account

Gets a GTM Account.

Parameters:

  • path (String)

    GTM Accounts's API relative path. Example: accounts/account_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+path}', options)
  command.response_representation = Google::Apis::TagmanagerV2::Account::Representation
  command.response_class = Google::Apis::TagmanagerV2::Account
  command.params['path'] = path unless path.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(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Container

Gets a Container.

Parameters:

  • path (String)

    GTM Container's API relative path. Example: accounts/account_id/containers/ container_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+path}', options)
  command.response_representation = Google::Apis::TagmanagerV2::Container::Representation
  command.response_class = Google::Apis::TagmanagerV2::Container
  command.params['path'] = path unless path.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(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Environment

Gets a GTM Environment.

Parameters:

  • path (String)

    GTM Environment's API relative path. Example: accounts/account_id/containers/ container_id/environments/environment_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


431
432
433
434
435
436
437
438
439
440
# File 'generated/google/apis/tagmanager_v2/service.rb', line 431

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+path}', options)
  command.response_representation = Google::Apis::TagmanagerV2::Environment::Representation
  command.response_class = Google::Apis::TagmanagerV2::Environment
  command.params['path'] = path unless path.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_version(path, container_version_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::ContainerVersion

Gets a Container Version.

Parameters:

  • path (String)

    GTM ContainerVersion's API relative path. Example: accounts/account_id/ containers/container_id/versions/version_id

  • container_version_id (String)

    The GTM ContainerVersion ID. Specify published to retrieve the currently published version.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


730
731
732
733
734
735
736
737
738
739
740
# File 'generated/google/apis/tagmanager_v2/service.rb', line 730

def (path, container_version_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+path}', options)
  command.response_representation = Google::Apis::TagmanagerV2::ContainerVersion::Representation
  command.response_class = Google::Apis::TagmanagerV2::ContainerVersion
  command.params['path'] = path unless path.nil?
  command.query['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_container_workspace(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Workspace

Gets a Workspace.

Parameters:

  • path (String)

    GTM Workspace's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1055

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+path}', options)
  command.response_representation = Google::Apis::TagmanagerV2::Workspace::Representation
  command.response_class = Google::Apis::TagmanagerV2::Workspace
  command.params['path'] = path unless path.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_workspace_folder(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Folder

Gets a GTM Folder.

Parameters:

  • path (String)

    GTM Folder's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id/folders/folder_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1634

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+path}', options)
  command.response_representation = Google::Apis::TagmanagerV2::Folder::Representation
  command.response_class = Google::Apis::TagmanagerV2::Folder
  command.params['path'] = path unless path.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_workspace_proposal(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::WorkspaceProposal

Gets a GTM Workspace Proposal.

Parameters:

  • path (String)

    GTM workspace proposal's relative path: Example: accounts/aid/containers/ cid/workspace/wid/workspace_proposal

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1089

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+path}', options)
  command.response_representation = Google::Apis::TagmanagerV2::WorkspaceProposal::Representation
  command.response_class = Google::Apis::TagmanagerV2::WorkspaceProposal
  command.params['path'] = path unless path.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_workspace_status(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::GetWorkspaceStatusResponse

Finds conflicting and modified entities in the workspace.

Parameters:

  • path (String)

    GTM Workspace's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1123

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+path}/status', options)
  command.response_representation = Google::Apis::TagmanagerV2::GetWorkspaceStatusResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::GetWorkspaceStatusResponse
  command.params['path'] = path unless path.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_workspace_tag(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Tag

Gets a GTM Tag.

Parameters:

  • path (String)

    GTM Tag's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id/tags/tag_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1966

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+path}', options)
  command.response_representation = Google::Apis::TagmanagerV2::Tag::Representation
  command.response_class = Google::Apis::TagmanagerV2::Tag
  command.params['path'] = path unless path.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_workspace_trigger(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Trigger

Gets a GTM Trigger.

Parameters:

  • path (String)

    GTM Trigger's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id/triggers/trigger_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
# File 'generated/google/apis/tagmanager_v2/service.rb', line 2185

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+path}', options)
  command.response_representation = Google::Apis::TagmanagerV2::Trigger::Representation
  command.response_class = Google::Apis::TagmanagerV2::Trigger
  command.params['path'] = path unless path.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_workspace_variable(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Variable

Gets a GTM Variable.

Parameters:

  • path (String)

    GTM Variable's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id/variables/variable_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
# File 'generated/google/apis/tagmanager_v2/service.rb', line 2404

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+path}', options)
  command.response_representation = Google::Apis::TagmanagerV2::Variable::Representation
  command.response_class = Google::Apis::TagmanagerV2::Variable
  command.params['path'] = path unless path.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_user_permission(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::UserPermission

Gets a user's Account & Container access.

Parameters:

  • path (String)

    GTM UserPermission's API relative path. Example: accounts/account_id/ user_permissions/user_permission_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
# File 'generated/google/apis/tagmanager_v2/service.rb', line 2623

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+path}', options)
  command.response_representation = Google::Apis::TagmanagerV2::UserPermission::Representation
  command.response_class = Google::Apis::TagmanagerV2::UserPermission
  command.params['path'] = path unless path.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

#latest_account_container_version_header(parent, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::ContainerVersionHeader

Gets the latest container version header

Parameters:

  • parent (String)

    GTM Container's API relative path. Example: accounts/account_id/containers/ container_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def (parent, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+parent}/version_headers:latest', options)
  command.response_representation = Google::Apis::TagmanagerV2::ContainerVersionHeader::Representation
  command.response_class = Google::Apis::TagmanagerV2::ContainerVersionHeader
  command.params['parent'] = parent unless parent.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(parent, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::ListEnvironmentsResponse

Lists all GTM Environments of a GTM Container.

Parameters:

  • parent (String)

    GTM Container's API relative path. Example: accounts/account_id/containers/ container_id

  • page_token (String)

    Continuation token for fetching the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def (parent, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+parent}/environments', options)
  command.response_representation = Google::Apis::TagmanagerV2::ListEnvironmentsResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::ListEnvironmentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageToken'] = page_token unless page_token.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_version_headers(parent, include_deleted: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::ListContainerVersionsResponse

Lists all Container Versions of a GTM Container.

Parameters:

  • parent (String)

    GTM Container's API relative path. Example: accounts/account_id/containers/ container_id

  • include_deleted (Boolean)

    Also retrieve deleted (archived) versions when true.

  • page_token (String)

    Continuation token for fetching the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


659
660
661
662
663
664
665
666
667
668
669
670
# File 'generated/google/apis/tagmanager_v2/service.rb', line 659

def (parent, include_deleted: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+parent}/version_headers', options)
  command.response_representation = Google::Apis::TagmanagerV2::ListContainerVersionsResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::ListContainerVersionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['includeDeleted'] = include_deleted unless include_deleted.nil?
  command.query['pageToken'] = page_token unless page_token.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_workspace_built_in_variables(parent, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::ListEnabledBuiltInVariablesResponse

Lists all the enabled Built-In Variables of a GTM Container.

Parameters:

  • parent (String)

    GTM Workspace's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id

  • page_token (String)

    Continuation token for fetching the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1456

def (parent, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+parent}/built_in_variables', options)
  command.response_representation = Google::Apis::TagmanagerV2::ListEnabledBuiltInVariablesResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::ListEnabledBuiltInVariablesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageToken'] = page_token unless page_token.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_workspace_folders(parent, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::ListFoldersResponse

Lists all GTM Folders of a Container.

Parameters:

  • parent (String)

    GTM Workspace's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id

  • page_token (String)

    Continuation token for fetching the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1670

def (parent, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+parent}/folders', options)
  command.response_representation = Google::Apis::TagmanagerV2::ListFoldersResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::ListFoldersResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageToken'] = page_token unless page_token.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_workspace_tags(parent, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::ListTagsResponse

Lists all GTM Tags of a Container.

Parameters:

  • parent (String)

    GTM Workspace's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id

  • page_token (String)

    Continuation token for fetching the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
# File 'generated/google/apis/tagmanager_v2/service.rb', line 2002

def (parent, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+parent}/tags', options)
  command.response_representation = Google::Apis::TagmanagerV2::ListTagsResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::ListTagsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageToken'] = page_token unless page_token.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_workspace_triggers(parent, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::ListTriggersResponse

Lists all GTM Triggers of a Container.

Parameters:

  • parent (String)

    GTM Workspaces's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id

  • page_token (String)

    Continuation token for fetching the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
# File 'generated/google/apis/tagmanager_v2/service.rb', line 2221

def (parent, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+parent}/triggers', options)
  command.response_representation = Google::Apis::TagmanagerV2::ListTriggersResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::ListTriggersResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageToken'] = page_token unless page_token.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_workspace_variables(parent, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::ListVariablesResponse

Lists all GTM Variables of a Container.

Parameters:

  • parent (String)

    GTM Workspace's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id

  • page_token (String)

    Continuation token for fetching the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
# File 'generated/google/apis/tagmanager_v2/service.rb', line 2440

def (parent, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+parent}/variables', options)
  command.response_representation = Google::Apis::TagmanagerV2::ListVariablesResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::ListVariablesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageToken'] = page_token unless page_token.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_workspaces(parent, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::ListWorkspacesResponse

Lists all Workspaces that belong to a GTM Container.

Parameters:

  • parent (String)

    GTM parent Container's API relative path. Example: accounts/account_id/ containers/container_id

  • page_token (String)

    Continuation token for fetching the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1159

def (parent, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+parent}/workspaces', options)
  command.response_representation = Google::Apis::TagmanagerV2::ListWorkspacesResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::ListWorkspacesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageToken'] = page_token unless page_token.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_containers(parent, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::ListContainersResponse

Lists all Containers that belongs to a GTM Account.

Parameters:

  • parent (String)

    GTM Accounts's API relative path. Example: accounts/account_id.

  • page_token (String)

    Continuation token for fetching the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def (parent, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+parent}/containers', options)
  command.response_representation = Google::Apis::TagmanagerV2::ListContainersResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::ListContainersResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageToken'] = page_token unless page_token.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_user_permissions(parent, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::ListUserPermissionsResponse

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

Parameters:

  • parent (String)

    GTM Accounts's API relative path. Example: accounts/account_id

  • page_token (String)

    Continuation token for fetching the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
# File 'generated/google/apis/tagmanager_v2/service.rb', line 2659

def (parent, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+parent}/user_permissions', options)
  command.response_representation = Google::Apis::TagmanagerV2::ListUserPermissionsResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::ListUserPermissionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageToken'] = page_token unless page_token.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(page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::ListAccountsResponse

Lists all GTM Accounts that a user has access to.

Parameters:

  • page_token (String)

    Continuation token for fetching the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


109
110
111
112
113
114
115
116
117
118
# File 'generated/google/apis/tagmanager_v2/service.rb', line 109

def list_accounts(page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts', options)
  command.response_representation = Google::Apis::TagmanagerV2::ListAccountsResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::ListAccountsResponse
  command.query['pageToken'] = page_token unless page_token.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

#live_account_container_version(parent, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::ContainerVersion

Gets the live (i.e. published) container version

Parameters:

  • parent (String)

    GTM Container's API relative path. Example: accounts/account_id/containers/ container_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


765
766
767
768
769
770
771
772
773
774
# File 'generated/google/apis/tagmanager_v2/service.rb', line 765

def (parent, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{+parent}/versions:live', options)
  command.response_representation = Google::Apis::TagmanagerV2::ContainerVersion::Representation
  command.response_class = Google::Apis::TagmanagerV2::ContainerVersion
  command.params['parent'] = parent unless parent.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

#move_account_container_workspace_folder_entities_to_folder(path, 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:

  • path (String)

    GTM Folder's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id/folders/folder_id

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

    The tags to be moved to the folder.

  • trigger_id (Array<String>, String)

    The triggers to be moved to the folder.

  • variable_id (Array<String>, String)

    The variables to be moved to the folder.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1712

def (path, 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(:post, '{+path}:move_entities_to_folder', options)
  command.request_representation = Google::Apis::TagmanagerV2::Folder::Representation
  command.request_object = folder_object
  command.params['path'] = path unless path.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

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

Updates a GTM Environment. This method supports patch semantics.

Parameters:

  • path (String)

    GTM Environment's API relative path. Example: accounts/account_id/containers/ container_id/environments/environment_id

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

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


506
507
508
509
510
511
512
513
514
515
516
517
518
# File 'generated/google/apis/tagmanager_v2/service.rb', line 506

def (path, environment_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '{+path}', options)
  command.request_representation = Google::Apis::TagmanagerV2::Environment::Representation
  command.request_object = environment_object
  command.response_representation = Google::Apis::TagmanagerV2::Environment::Representation
  command.response_class = Google::Apis::TagmanagerV2::Environment
  command.params['path'] = path unless path.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_account_container_version(path, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::PublishContainerVersionResponse

Publishes a Container Version.

Parameters:

  • path (String)

    GTM ContainerVersion's API relative path. Example: accounts/account_id/ containers/container_id/versions/version_id

  • fingerprint (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


802
803
804
805
806
807
808
809
810
811
812
# File 'generated/google/apis/tagmanager_v2/service.rb', line 802

def (path, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+path}:publish', options)
  command.response_representation = Google::Apis::TagmanagerV2::PublishContainerVersionResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::PublishContainerVersionResponse
  command.params['path'] = path unless path.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

#quick_account_container_workspace_preview(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::QuickPreviewResponse

Quick previews a workspace by creating a fake container version from all entities in the provided workspace.

Parameters:

  • path (String)

    GTM Workspace's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1195

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+path}:quick_preview', options)
  command.response_representation = Google::Apis::TagmanagerV2::QuickPreviewResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::QuickPreviewResponse
  command.params['path'] = path unless path.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

#reauthorize_account_container_environment(path, environment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Environment

Re-generates the authorization code for a GTM Environment.

Parameters:

  • path (String)

    GTM Environment's API relative path. Example: accounts/account_id/containers/ container_id/environments/environment_id

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


544
545
546
547
548
549
550
551
552
553
554
555
# File 'generated/google/apis/tagmanager_v2/service.rb', line 544

def (path, environment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+path}:reauthorize', options)
  command.request_representation = Google::Apis::TagmanagerV2::Environment::Representation
  command.request_object = environment_object
  command.response_representation = Google::Apis::TagmanagerV2::Environment::Representation
  command.response_class = Google::Apis::TagmanagerV2::Environment
  command.params['path'] = path unless path.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

#resolve_account_container_workspace_conflict(path, entity_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Resolves a merge conflict for a workspace entity by updating it to the resolved entity passed in the request.

Parameters:

  • path (String)

    GTM Workspace's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id

  • entity_object (Google::Apis::TagmanagerV2::Entity) (defaults to: nil)
  • fingerprint (String)

    When provided, this fingerprint must match the fingerprint of the entity_in_workspace in the merge conflict.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1234

def (path, entity_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+path}:resolve_conflict', options)
  command.request_representation = Google::Apis::TagmanagerV2::Entity::Representation
  command.request_object = entity_object
  command.params['path'] = path unless path.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

#revert_account_container_workspace_built_in_variable(path, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::RevertBuiltInVariableResponse

Reverts changes to a GTM Built-In Variables in a GTM Workspace.

Parameters:

  • path (String)

    GTM BuiltInVariable's API relative path. Example: accounts/account_id/ containers/container_id/workspaces/workspace_id/built_in_variables

  • type (String)

    The type of built-in variable to revert.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1493

def (path, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+path}/built_in_variables:revert', options)
  command.response_representation = Google::Apis::TagmanagerV2::RevertBuiltInVariableResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::RevertBuiltInVariableResponse
  command.params['path'] = path unless path.nil?
  command.query['type'] = type unless type.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

#revert_account_container_workspace_folder(path, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::RevertFolderResponse

Reverts changes to a GTM Folder in a GTM Workspace.

Parameters:

  • path (String)

    GTM Folder's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id/folders/folder_id

  • fingerprint (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1752

def (path, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+path}:revert', options)
  command.response_representation = Google::Apis::TagmanagerV2::RevertFolderResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::RevertFolderResponse
  command.params['path'] = path unless path.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

#revert_account_container_workspace_tag(path, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::RevertTagResponse

Reverts changes to a GTM Tag in a GTM Workspace.

Parameters:

  • path (String)

    GTM Tag's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id/tags/tag_id

  • fingerprint (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
# File 'generated/google/apis/tagmanager_v2/service.rb', line 2040

def (path, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+path}:revert', options)
  command.response_representation = Google::Apis::TagmanagerV2::RevertTagResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::RevertTagResponse
  command.params['path'] = path unless path.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

#revert_account_container_workspace_trigger(path, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::RevertTriggerResponse

Reverts changes to a GTM Trigger in a GTM Workspace.

Parameters:

  • path (String)

    GTM Trigger's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id/triggers/trigger_id

  • fingerprint (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
# File 'generated/google/apis/tagmanager_v2/service.rb', line 2259

def (path, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+path}:revert', options)
  command.response_representation = Google::Apis::TagmanagerV2::RevertTriggerResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::RevertTriggerResponse
  command.params['path'] = path unless path.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

#revert_account_container_workspace_variable(path, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::RevertVariableResponse

Reverts changes to a GTM Variable in a GTM Workspace.

Parameters:

  • path (String)

    GTM Variable's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id/variables/variable_id

  • fingerprint (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
# File 'generated/google/apis/tagmanager_v2/service.rb', line 2478

def (path, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+path}:revert', options)
  command.response_representation = Google::Apis::TagmanagerV2::RevertVariableResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::RevertVariableResponse
  command.params['path'] = path unless path.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

#set_account_container_version_latest(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::ContainerVersion

Sets the latest version used for synchronization of workspaces when detecting conflicts and errors.

Parameters:

  • path (String)

    GTM ContainerVersion's API relative path. Example: accounts/account_id/ containers/container_id/versions/version_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


838
839
840
841
842
843
844
845
846
847
# File 'generated/google/apis/tagmanager_v2/service.rb', line 838

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+path}:set_latest', options)
  command.response_representation = Google::Apis::TagmanagerV2::ContainerVersion::Representation
  command.response_class = Google::Apis::TagmanagerV2::ContainerVersion
  command.params['path'] = path unless path.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

#sync_account_container_workspace(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::SyncWorkspaceResponse

Syncs a workspace to the latest container version by updating all unmodified workspace entities and displaying conflicts for modified entities.

Parameters:

  • path (String)

    GTM Workspace's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+path}:sync', options)
  command.response_representation = Google::Apis::TagmanagerV2::SyncWorkspaceResponse::Representation
  command.response_class = Google::Apis::TagmanagerV2::SyncWorkspaceResponse
  command.params['path'] = path unless path.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_account_container_version(path, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::ContainerVersion

Undeletes a Container Version.

Parameters:

  • path (String)

    GTM ContainerVersion's API relative path. Example: accounts/account_id/ containers/container_id/versions/version_id

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


872
873
874
875
876
877
878
879
880
881
# File 'generated/google/apis/tagmanager_v2/service.rb', line 872

def (path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{+path}:undelete', options)
  command.response_representation = Google::Apis::TagmanagerV2::ContainerVersion::Representation
  command.response_class = Google::Apis::TagmanagerV2::ContainerVersion
  command.params['path'] = path unless path.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(path, account_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Account

Updates a GTM Account.

Parameters:

  • path (String)

    GTM Accounts's API relative path. Example: accounts/account_id

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

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'generated/google/apis/tagmanager_v2/service.rb', line 146

def (path,  = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{+path}', options)
  command.request_representation = Google::Apis::TagmanagerV2::Account::Representation
  command.request_object = 
  command.response_representation = Google::Apis::TagmanagerV2::Account::Representation
  command.response_class = Google::Apis::TagmanagerV2::Account
  command.params['path'] = path unless path.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(path, container_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Container

Updates a Container.

Parameters:

  • path (String)

    GTM Container's API relative path. Example: accounts/account_id/containers/ container_id

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

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def (path, container_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{+path}', options)
  command.request_representation = Google::Apis::TagmanagerV2::Container::Representation
  command.request_object = container_object
  command.response_representation = Google::Apis::TagmanagerV2::Container::Representation
  command.response_class = Google::Apis::TagmanagerV2::Container
  command.params['path'] = path unless path.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(path, environment_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Environment

Updates a GTM Environment.

Parameters:

  • path (String)

    GTM Environment's API relative path. Example: accounts/account_id/containers/ container_id/environments/environment_id

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

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


584
585
586
587
588
589
590
591
592
593
594
595
596
# File 'generated/google/apis/tagmanager_v2/service.rb', line 584

def (path, environment_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{+path}', options)
  command.request_representation = Google::Apis::TagmanagerV2::Environment::Representation
  command.request_object = environment_object
  command.response_representation = Google::Apis::TagmanagerV2::Environment::Representation
  command.response_class = Google::Apis::TagmanagerV2::Environment
  command.params['path'] = path unless path.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_version(path, container_version_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::ContainerVersion

Updates a Container Version.

Parameters:

  • path (String)

    GTM ContainerVersion's API relative path. Example: accounts/account_id/ containers/container_id/versions/version_id

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

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


910
911
912
913
914
915
916
917
918
919
920
921
922
# File 'generated/google/apis/tagmanager_v2/service.rb', line 910

def (path, container_version_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{+path}', options)
  command.request_representation = Google::Apis::TagmanagerV2::ContainerVersion::Representation
  command.request_object = container_version_object
  command.response_representation = Google::Apis::TagmanagerV2::ContainerVersion::Representation
  command.response_class = Google::Apis::TagmanagerV2::ContainerVersion
  command.params['path'] = path unless path.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_workspace(path, workspace_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Workspace

Updates a Workspace.

Parameters:

  • path (String)

    GTM Workspace's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id

  • workspace_object (Google::Apis::TagmanagerV2::Workspace) (defaults to: nil)
  • fingerprint (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def (path, workspace_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{+path}', options)
  command.request_representation = Google::Apis::TagmanagerV2::Workspace::Representation
  command.request_object = workspace_object
  command.response_representation = Google::Apis::TagmanagerV2::Workspace::Representation
  command.response_class = Google::Apis::TagmanagerV2::Workspace
  command.params['path'] = path unless path.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_workspace_folder(path, folder_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Folder

Updates a GTM Folder.

Parameters:

  • path (String)

    GTM Folder's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id/folders/folder_id

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

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1791

def (path, folder_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{+path}', options)
  command.request_representation = Google::Apis::TagmanagerV2::Folder::Representation
  command.request_object = folder_object
  command.response_representation = Google::Apis::TagmanagerV2::Folder::Representation
  command.response_class = Google::Apis::TagmanagerV2::Folder
  command.params['path'] = path unless path.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_workspace_proposal(path, update_workspace_proposal_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::WorkspaceProposal

Updates a GTM Workspace Proposal.

Parameters:

  • path (String)

    GTM workspace proposal's relative path: Example: accounts/aid/containers/ cid/workspace/wid/workspace_proposal

  • update_workspace_proposal_request_object (Google::Apis::TagmanagerV2::UpdateWorkspaceProposalRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
# File 'generated/google/apis/tagmanager_v2/service.rb', line 1346

def (path, update_workspace_proposal_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{+path}', options)
  command.request_representation = Google::Apis::TagmanagerV2::UpdateWorkspaceProposalRequest::Representation
  command.request_object = update_workspace_proposal_request_object
  command.response_representation = Google::Apis::TagmanagerV2::WorkspaceProposal::Representation
  command.response_class = Google::Apis::TagmanagerV2::WorkspaceProposal
  command.params['path'] = path unless path.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_workspace_tag(path, tag_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Tag

Updates a GTM Tag.

Parameters:

  • path (String)

    GTM Tag's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id/tags/tag_id

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

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
# File 'generated/google/apis/tagmanager_v2/service.rb', line 2079

def (path, tag_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{+path}', options)
  command.request_representation = Google::Apis::TagmanagerV2::Tag::Representation
  command.request_object = tag_object
  command.response_representation = Google::Apis::TagmanagerV2::Tag::Representation
  command.response_class = Google::Apis::TagmanagerV2::Tag
  command.params['path'] = path unless path.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_workspace_trigger(path, trigger_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Trigger

Updates a GTM Trigger.

Parameters:

  • path (String)

    GTM Trigger's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id/triggers/trigger_id

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

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
# File 'generated/google/apis/tagmanager_v2/service.rb', line 2298

def (path, trigger_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{+path}', options)
  command.request_representation = Google::Apis::TagmanagerV2::Trigger::Representation
  command.request_object = trigger_object
  command.response_representation = Google::Apis::TagmanagerV2::Trigger::Representation
  command.response_class = Google::Apis::TagmanagerV2::Trigger
  command.params['path'] = path unless path.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_workspace_variable(path, variable_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::Variable

Updates a GTM Variable.

Parameters:

  • path (String)

    GTM Variable's API relative path. Example: accounts/account_id/containers/ container_id/workspaces/workspace_id/variables/variable_id

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

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
# File 'generated/google/apis/tagmanager_v2/service.rb', line 2517

def (path, variable_object = nil, fingerprint: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{+path}', options)
  command.request_representation = Google::Apis::TagmanagerV2::Variable::Representation
  command.request_object = variable_object
  command.response_representation = Google::Apis::TagmanagerV2::Variable::Representation
  command.response_class = Google::Apis::TagmanagerV2::Variable
  command.params['path'] = path unless path.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_user_permission(path, user_permission_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TagmanagerV2::UserPermission

Updates a user's Account & Container access.

Parameters:

  • path (String)

    GTM UserPermission's API relative path. Example: accounts/account_id/ user_permissions/user_permission_id

  • user_permission_object (Google::Apis::TagmanagerV2::UserPermission) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

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

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
# File 'generated/google/apis/tagmanager_v2/service.rb', line 2695

def (path, user_permission_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{+path}', options)
  command.request_representation = Google::Apis::TagmanagerV2::UserPermission::Representation
  command.request_object = user_permission_object
  command.response_representation = Google::Apis::TagmanagerV2::UserPermission::Representation
  command.response_class = Google::Apis::TagmanagerV2::UserPermission
  command.params['path'] = path unless path.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