📂 File Browser

📁 Directories

📄 Files

📄 Source: AccountsContainersWorkspacesBuiltInVariables.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\CreateBuiltInVariableResponse;
use Google\Service\TagManager\ListEnabledBuiltInVariablesResponse;
use Google\Service\TagManager\RevertBuiltInVariableResponse;

/**
 * The "built_in_variables" collection of methods.
 * Typical usage is:
 *  <code>
 *   $tagmanagerService = new Google\Service\TagManager(...);
 *   $built_in_variables = $tagmanagerService->accounts_containers_workspaces_built_in_variables;
 *  </code>
 */
class AccountsContainersWorkspacesBuiltInVariables extends \Google\Service\Resource
{
  /**
   * Creates one or more GTM Built-In Variables. (built_in_variables.create)
   *
   * @param string $parent GTM Workspace's API relative path.
   * @param array $optParams Optional parameters.
   *
   * @opt_param string type The types of built-in variables to enable.
   * @return CreateBuiltInVariableResponse
   * @throws \Google\Service\Exception
   */
  public function create($parent, $optParams = [])
  {
    $params = ['parent' => $parent];
    $params = array_merge($params, $optParams);
    return $this->call('create', [$params], CreateBuiltInVariableResponse::class);
  }
  /**
   * Deletes one or more GTM Built-In Variables. (built_in_variables.delete)
   *
   * @param string $path GTM BuiltInVariable's API relative path.
   * @param array $optParams Optional parameters.
   *
   * @opt_param string type The types of built-in variables to delete.
   * @throws \Google\Service\Exception
   */
  public function delete($path, $optParams = [])
  {
    $params = ['path' => $path];
    $params = array_merge($params, $optParams);
    return $this->call('delete', [$params]);
  }
  /**
   * Lists all the enabled Built-In Variables of a GTM Container.
   * (built_in_variables.listAccountsContainersWorkspacesBuiltInVariables)
   *
   * @param string $parent GTM Workspace's API relative path.
   * @param array $optParams Optional parameters.
   *
   * @opt_param string pageToken Continuation token for fetching the next page of
   * results.
   * @return ListEnabledBuiltInVariablesResponse
   * @throws \Google\Service\Exception
   */
  public function listAccountsContainersWorkspacesBuiltInVariables($parent, $optParams = [])
  {
    $params = ['parent' => $parent];
    $params = array_merge($params, $optParams);
    return $this->call('list', [$params], ListEnabledBuiltInVariablesResponse::class);
  }
  /**
   * Reverts changes to a GTM Built-In Variables in a GTM Workspace.
   * (built_in_variables.revert)
   *
   * @param string $path GTM BuiltInVariable's API relative path.
   * @param array $optParams Optional parameters.
   *
   * @opt_param string type The type of built-in variable to revert.
   * @return RevertBuiltInVariableResponse
   * @throws \Google\Service\Exception
   */
  public function revert($path, $optParams = [])
  {
    $params = ['path' => $path];
    $params = array_merge($params, $optParams);
    return $this->call('revert', [$params], RevertBuiltInVariableResponse::class);
  }
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AccountsContainersWorkspacesBuiltInVariables::class, 'Google_Service_TagManager_Resource_AccountsContainersWorkspacesBuiltInVariables');