class AccountsContainersWorkspaces extends Resource (View source)

The "workspaces" collection of methods.

Typical usage is:

 $tagmanagerService = new Google\Service\TagManager(...);
 $workspaces = $tagmanagerService->accounts_containers_workspaces;

Methods

create(string $parent, Workspace $postBody, array $optParams = [])

Creates a Workspace. (workspaces.create)

create_version(string $path, CreateContainerVersionRequestVersionOptions $postBody, array $optParams = [])

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)

delete(string $path, array $optParams = [])

Deletes a Workspace. (workspaces.delete)

get(string $path, array $optParams = [])

Gets a Workspace. (workspaces.get)

getStatus(string $path, array $optParams = [])

Finds conflicting and modified entities in the workspace.

listAccountsContainersWorkspaces(string $parent, array $optParams = [])

Lists all Workspaces that belong to a GTM Container.

quick_preview(string $path, array $optParams = [])

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

resolve_conflict(string $path, Entity $postBody, array $optParams = [])

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

sync(string $path, array $optParams = [])

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

update(string $path, Workspace $postBody, array $optParams = [])

Updates a Workspace. (workspaces.update)

Details

Workspace create(string $parent, Workspace $postBody, array $optParams = [])

Creates a Workspace. (workspaces.create)

Parameters

string $parent

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

Workspace $postBody
array $optParams

Optional parameters.

Return Value

Workspace

Exceptions

Exception

CreateContainerVersionResponse create_version(string $path, CreateContainerVersionRequestVersionOptions $postBody, array $optParams = [])

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)

Parameters

string $path

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

CreateContainerVersionRequestVersionOptions $postBody
array $optParams

Optional parameters.

Return Value

CreateContainerVersionResponse

Exceptions

Exception

delete(string $path, array $optParams = [])

Deletes a Workspace. (workspaces.delete)

Parameters

string $path

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

array $optParams

Optional parameters.

Exceptions

Exception

Workspace get(string $path, array $optParams = [])

Gets a Workspace. (workspaces.get)

Parameters

string $path

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

array $optParams

Optional parameters.

Return Value

Workspace

Exceptions

Exception

GetWorkspaceStatusResponse getStatus(string $path, array $optParams = [])

Finds conflicting and modified entities in the workspace.

(workspaces.getStatus)

Parameters

string $path

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

array $optParams

Optional parameters.

Return Value

GetWorkspaceStatusResponse

Exceptions

Exception

ListWorkspacesResponse listAccountsContainersWorkspaces(string $parent, array $optParams = [])

Lists all Workspaces that belong to a GTM Container.

(workspaces.listAccountsContainersWorkspaces)

Parameters

string $parent

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

array $optParams

Optional parameters.

Return Value

ListWorkspacesResponse

Exceptions

Exception

QuickPreviewResponse quick_preview(string $path, array $optParams = [])

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

Parameters

string $path

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

array $optParams

Optional parameters.

Return Value

QuickPreviewResponse

Exceptions

Exception

resolve_conflict(string $path, Entity $postBody, array $optParams = [])

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

Parameters

string $path

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

Entity $postBody
array $optParams

Optional parameters.

Exceptions

Exception

SyncWorkspaceResponse sync(string $path, array $optParams = [])

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

(workspaces.sync)

Parameters

string $path

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

array $optParams

Optional parameters.

Return Value

SyncWorkspaceResponse

Exceptions

Exception

Workspace update(string $path, Workspace $postBody, array $optParams = [])

Updates a Workspace. (workspaces.update)

Parameters

string $path

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

Workspace $postBody
array $optParams

Optional parameters.

Return Value

Workspace

Exceptions

Exception