Documentation

Google_Service_TagManager_Resource_AccountsContainersWorkspaces extends Google_Service_Resource
in package

Application

The "workspaces" collection of methods.

Typical usage is: $tagmanagerService = new Google_Service_TagManager(...); $workspaces = $tagmanagerService->workspaces;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_TagManager_Workspace: Creates a Workspace. (workspaces.create)
create_version() : Google_Service_TagManager_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. (workspaces.create_version)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: Deletes a Workspace. (workspaces.delete)
get() : Google_Service_TagManager_Workspace: Gets a Workspace. (workspaces.get)
getStatus() : Google_Service_TagManager_GetWorkspaceStatusResponse: Finds conflicting and modified entities in the workspace.
listAccountsContainersWorkspaces() : Google_Service_TagManager_ListWorkspacesResponse: Lists all Workspaces that belong to a GTM Container.
quick_preview() : Google_Service_TagManager_QuickPreviewResponse: Quick previews a workspace by creating a fake container version from all entities in the provided workspace. (workspaces.quick_preview)
resolve_conflict() : mixed: Resolves a merge conflict for a workspace entity by updating it to the resolved entity passed in the request. (workspaces.resolve_conflict)
sync() : Google_Service_TagManager_SyncWorkspaceResponse: Syncs a workspace to the latest container version by updating all unmodified workspace entities and displaying conflicts for modified entities.
update() : Google_Service_TagManager_Workspace: Updates a Workspace. (workspaces.update)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

Creates a Workspace. (workspaces.create)


    public
                create(string $parent, Google_Service_TagManager_Workspace $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_TagManager_Workspace

Parameters

$parent : string: GTM parent Container's API relative path. Example: accounts/{account_id}/containers/{container_id}
$postBody : Google_Service_TagManager_Workspace
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_TagManager_Workspace —

create_version()

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. (workspaces.create_version)


    public
                create_version(string $path, Google_Service_TagManager_CreateContainerVersionRequestVersionOptions $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_TagManager_CreateContainerVersionResponse

Parameters

$path : string: GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}
$postBody : Google_Service_TagManager_CreateContainerVersionRequestVersionOptions
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_TagManager_CreateContainerVersionResponse —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Deletes a Workspace. (workspaces.delete)


    public
                delete(string $path[, array<string|int, mixed> $optParams = array() ]) : mixed

Parameters

$path : string: GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

get()

Gets a Workspace. (workspaces.get)


    public
                get(string $path[, array<string|int, mixed> $optParams = array() ]) : Google_Service_TagManager_Workspace

Parameters

$path : string: GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_TagManager_Workspace —

getStatus()

Finds conflicting and modified entities in the workspace.


    public
                getStatus(string $path[, array<string|int, mixed> $optParams = array() ]) : Google_Service_TagManager_GetWorkspaceStatusResponse

(workspaces.getStatus)

Parameters

$path : string: GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_TagManager_GetWorkspaceStatusResponse —

listAccountsContainersWorkspaces()

Lists all Workspaces that belong to a GTM Container.


    public
                listAccountsContainersWorkspaces(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_TagManager_ListWorkspacesResponse

(workspaces.listAccountsContainersWorkspaces)

Parameters

$parent : string: GTM parent Container's API relative path. Example: accounts/{account_id}/containers/{container_id}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_TagManager_ListWorkspacesResponse —

quick_preview()

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


    public
                quick_preview(string $path[, array<string|int, mixed> $optParams = array() ]) : Google_Service_TagManager_QuickPreviewResponse

Parameters

$path : string: GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_TagManager_QuickPreviewResponse —

resolve_conflict()

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


    public
                resolve_conflict(string $path, Google_Service_TagManager_Entity $postBody[, array<string|int, mixed> $optParams = array() ]) : mixed

Parameters

$path : string: GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}
$postBody : Google_Service_TagManager_Entity
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

sync()

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


    public
                sync(string $path[, array<string|int, mixed> $optParams = array() ]) : Google_Service_TagManager_SyncWorkspaceResponse

(workspaces.sync)

Parameters

$path : string: GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_TagManager_SyncWorkspaceResponse —

update()

Updates a Workspace. (workspaces.update)


    public
                update(string $path, Google_Service_TagManager_Workspace $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_TagManager_Workspace

Parameters

$path : string: GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}
$postBody : Google_Service_TagManager_Workspace
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_TagManager_Workspace —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —