Tag Manager API . accounts . containers . workspaces . built_in_variables

Instance Methods

create(parent, type=None, x__xgafv=None)

Creates one or more GTM Built-In Variables.

delete(path, type=None, x__xgafv=None)

Deletes one or more GTM Built-In Variables.

list(parent, pageToken=None, x__xgafv=None)

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

list_next(previous_request, previous_response)

Retrieves the next page of results.

revert(path, type=None, x__xgafv=None)

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

Method Details

create(parent, type=None, x__xgafv=None)
Creates one or more GTM Built-In Variables.

Args:
  parent: string, GTM Workspace's API relative path.
Example:
accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} (required)
  type: string, The types of built-in variables to enable. (repeated)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "builtInVariable": [ # List of created built-in variables.
      { # Built-in variables are a special category of variables that are pre-created
          # and non-customizable. They provide common functionality like accessing
          # propeties of the gtm data layer, monitoring clicks, or accessing elements
          # of a page URL.
        "containerId": "A String", # GTM Container ID.
        "name": "A String", # Name of the built-in variable to be used to refer to the built-in variable.
        "workspaceId": "A String", # GTM Workspace ID.
        "path": "A String", # GTM BuiltInVariable's API relative path.
        "type": "A String", # Type of built-in variable.
            # @required.tagmanager.accounts.containers.workspaces.built_in_variable.update
            # @mutable tagmanager.accounts.containers.workspaces.built_in_variable.update
        "accountId": "A String", # GTM Account ID.
      },
    ],
  }
delete(path, type=None, x__xgafv=None)
Deletes one or more GTM Built-In Variables.

Args:
  path: string, GTM BuiltInVariable's API relative path.
Example:
accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/built_in_variables (required)
  type: string, The types of built-in variables to delete. (repeated)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
list(parent, pageToken=None, x__xgafv=None)
Lists all the enabled Built-In Variables of a GTM Container.

Args:
  parent: string, GTM Workspace's API relative path.
Example:
accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} (required)
  pageToken: string, Continuation token for fetching the next page of results.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A list of enabled built-in variables.
    "nextPageToken": "A String", # Continuation token for fetching the next page of results.
    "builtInVariable": [ # All GTM BuiltInVariables of a GTM container.
      { # Built-in variables are a special category of variables that are pre-created
          # and non-customizable. They provide common functionality like accessing
          # propeties of the gtm data layer, monitoring clicks, or accessing elements
          # of a page URL.
        "containerId": "A String", # GTM Container ID.
        "name": "A String", # Name of the built-in variable to be used to refer to the built-in variable.
        "workspaceId": "A String", # GTM Workspace ID.
        "path": "A String", # GTM BuiltInVariable's API relative path.
        "type": "A String", # Type of built-in variable.
            # @required.tagmanager.accounts.containers.workspaces.built_in_variable.update
            # @mutable tagmanager.accounts.containers.workspaces.built_in_variable.update
        "accountId": "A String", # GTM Account ID.
      },
    ],
  }
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    
revert(path, type=None, x__xgafv=None)
Reverts changes to a GTM Built-In Variables in a GTM Workspace.

Args:
  path: string, GTM BuiltInVariable's API relative path.
Example:
accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/built_in_variables (required)
  type: string, The type of built-in variable to revert.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The result of reverting a built-in variable in a workspace.
    "enabled": True or False, # Whether the built-in variable is enabled after reversion.
  }