📄 Source: AccountsContainersWorkspaces.php
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\TagManager\Resource;
use Google\Service\TagManager\BulkUpdateWorkspaceResponse;
use Google\Service\TagManager\CreateContainerVersionRequestVersionOptions;
use Google\Service\TagManager\CreateContainerVersionResponse;
use Google\Service\TagManager\Entity;
use Google\Service\TagManager\GetWorkspaceStatusResponse;
use Google\Service\TagManager\ListWorkspacesResponse;
use Google\Service\TagManager\ProposedChange;
use Google\Service\TagManager\QuickPreviewResponse;
use Google\Service\TagManager\SyncWorkspaceResponse;
use Google\Service\TagManager\Workspace;
/**
* The "workspaces" collection of methods.
* Typical usage is:
* <code>
* $tagmanagerService = new Google\Service\TagManager(...);
* $workspaces = $tagmanagerService->accounts_containers_workspaces;
* </code>
*/
class AccountsContainersWorkspaces extends \Google\Service\Resource
{
/**
* Applies multiple entity changes to a workspace in one call. When creating new
* entities, their entity IDs must be unique and in correct format. That is,
* they must start with "new_" and followed by number, e.g. "new_1", "new_2".
* Example body snippet to create myNewTag under myNewFolder is: ``` "changes":
* [ { "folder": { "folderId": "new_1", "name": "myNewFolder", ... },
* "changeStatus": "added" }, { "tag": { "tagId": "new_2", "name": "myNewTag",
* "parentFolderId": "new_1", ... }, "changeStatus": "added" } ] ```
* (workspaces.bulk_update)
*
* @param string $path GTM Workspace's API relative path.
* @param ProposedChange $postBody
* @param array $optParams Optional parameters.
* @return BulkUpdateWorkspaceResponse
* @throws \Google\Service\Exception
*/
public function bulk_update($path, ProposedChange $postBody, $optParams = [])
{
$params = ['path' => $path, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('bulk_update', [$params], BulkUpdateWorkspaceResponse::class);
}
/**
* Creates a Workspace. (workspaces.create)
*
* @param string $parent GTM parent Container's API relative path.
* @param Workspace $postBody
* @param array $optParams Optional parameters.
* @return Workspace
* @throws \Google\Service\Exception
*/
public function create($parent, Workspace $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Workspace::class);
}
/**
* 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)
*
* @param string $path GTM Workspace's API relative path.
* @param CreateContainerVersionRequestVersionOptions $postBody
* @param array $optParams Optional parameters.
* @return CreateContainerVersionResponse
* @throws \Google\Service\Exception
*/
public function create_version($path, CreateContainerVersionRequestVersionOptions $postBody, $optParams = [])
{
$params = ['path' => $path, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create_version', [$params], CreateContainerVersionResponse::class);
}
/**
* Deletes a Workspace. (workspaces.delete)
*
* @param string $path GTM Workspace's API relative path.
* @param array $optParams Optional parameters.
* @throws \Google\Service\Exception
*/
public function delete($path, $optParams = [])
{
$params = ['path' => $path];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params]);
}
/**
* Gets a Workspace. (workspaces.get)
*
* @param string $path GTM Workspace's API relative path.
* @param array $optParams Optional parameters.
* @return Workspace
* @throws \Google\Service\Exception
*/
public function get($path, $optParams = [])
{
$params = ['path' => $path];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Workspace::class);
}
/**
* Finds conflicting and modified entities in the workspace.
* (workspaces.getStatus)
*
* @param string $path GTM Workspace's API relative path.
* @param array $optParams Optional parameters.
* @return GetWorkspaceStatusResponse
* @throws \Google\Service\Exception
*/
public function getStatus($path, $optParams = [])
{
$params = ['path' => $path];
$params = array_merge($params, $optParams);
return $this->call('getStatus', [$params], GetWorkspaceStatusResponse::class);
}
/**
* Lists all Workspaces that belong to a GTM Container.
* (workspaces.listAccountsContainersWorkspaces)
*
* @param string $parent GTM parent Container's API relative path.
* @param array $optParams Optional parameters.
*
* @opt_param string pageToken Continuation token for fetching the next page of
* results.
* @return ListWorkspacesResponse
* @throws \Google\Service\Exception
*/
public function listAccountsContainersWorkspaces($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListWorkspacesResponse::class);
}
/**
* Quick previews a workspace by creating a fake container version from all
* entities in the provided workspace. (workspaces.quick_preview)
*
* @param string $path GTM Workspace's API relative path.
* @param array $optParams Optional parameters.
* @return QuickPreviewResponse
* @throws \Google\Service\Exception
*/
public function quick_preview($path, $optParams = [])
{
$params = ['path' => $path];
$params = array_merge($params, $optParams);
return $this->call('quick_preview', [$params], QuickPreviewResponse::class);
}
/**
* Resolves a merge conflict for a workspace entity by updating it to the
* resolved entity passed in the request. (workspaces.resolve_conflict)
*
* @param string $path GTM Workspace's API relative path.
* @param Entity $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string fingerprint When provided, this fingerprint must match the
* fingerprint of the entity_in_workspace in the merge conflict.
* @throws \Google\Service\Exception
*/
public function resolve_conflict($path, Entity $postBody, $optParams = [])
{
$params = ['path' => $path, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('resolve_conflict', [$params]);
}
/**
* Syncs a workspace to the latest container version by updating all unmodified
* workspace entities and displaying conflicts for modified entities.
* (workspaces.sync)
*
* @param string $path GTM Workspace's API relative path.
* @param array $optParams Optional parameters.
* @return SyncWorkspaceResponse
* @throws \Google\Service\Exception
*/
public function sync($path, $optParams = [])
{
$params = ['path' => $path];
$params = array_merge($params, $optParams);
return $this->call('sync', [$params], SyncWorkspaceResponse::class);
}
/**
* Updates a Workspace. (workspaces.update)
*
* @param string $path GTM Workspace's API relative path.
* @param Workspace $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string fingerprint When provided, this fingerprint must match the
* fingerprint of the workspace in storage.
* @return Workspace
* @throws \Google\Service\Exception
*/
public function update($path, Workspace $postBody, $optParams = [])
{
$params = ['path' => $path, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('update', [$params], Workspace::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AccountsContainersWorkspaces::class, 'Google_Service_TagManager_Resource_AccountsContainersWorkspaces');
← Back