Tag Manager API . accounts . containers . environments

Instance Methods

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

Creates a GTM Environment.

delete(path, x__xgafv=None)

Deletes a GTM Environment.

get(path, x__xgafv=None)

Gets a GTM Environment.

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

Lists all GTM Environments of a GTM Container.

list_next(previous_request, previous_response)

Retrieves the next page of results.

reauthorize(path, body=None, x__xgafv=None)

Re-generates the authorization code for a GTM Environment.

update(path, body=None, fingerprint=None, x__xgafv=None)

Updates a GTM Environment.

Method Details

create(parent, body=None, x__xgafv=None)
Creates a GTM Environment.

Args:
  parent: string, GTM Container's API relative path.
Example: accounts/{account_id}/containers/{container_id} (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a Google Tag Manager Environment. Note that a user can create,
      # delete and update environments of type USER, but can only update the
      # enable_debug and url fields of environments of other types.
    "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time.
        # This value is recomputed whenever the environment is modified.
    "name": "A String", # The environment display name. Can be set or changed only on USER type
        # environments.
        # @mutable tagmanager.accounts.containers.environments.create
        # @mutable tagmanager.accounts.containers.environments.update
    "accountId": "A String", # GTM Account ID.
    "containerId": "A String", # GTM Container ID.
    "workspaceId": "A String", # Represents a link to a quick preview of a workspace.
    "containerVersionId": "A String", # Represents a link to a container version.
    "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
    "type": "A String", # The type of this environment.
    "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
    "path": "A String", # GTM Environment's API relative path.
    "description": "A String", # The environment description. Can be set or changed only on USER type
        # environments.
        # @mutable tagmanager.accounts.containers.environments.create
        # @mutable tagmanager.accounts.containers.environments.update
    "enableDebug": True or False, # Whether or not to enable debug by default for the environment.
        # @mutable tagmanager.accounts.containers.environments.create
        # @mutable tagmanager.accounts.containers.environments.update
    "authorizationCode": "A String", # The environment authorization code.
    "authorizationTimestamp": "A String", # The last update time-stamp for the authorization code.
    "url": "A String", # Default preview page url for the environment.
        # @mutable tagmanager.accounts.containers.environments.create
        # @mutable tagmanager.accounts.containers.environments.update
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Environment. Note that a user can create,
        # delete and update environments of type USER, but can only update the
        # enable_debug and url fields of environments of other types.
      "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time.
          # This value is recomputed whenever the environment is modified.
      "name": "A String", # The environment display name. Can be set or changed only on USER type
          # environments.
          # @mutable tagmanager.accounts.containers.environments.create
          # @mutable tagmanager.accounts.containers.environments.update
      "accountId": "A String", # GTM Account ID.
      "containerId": "A String", # GTM Container ID.
      "workspaceId": "A String", # Represents a link to a quick preview of a workspace.
      "containerVersionId": "A String", # Represents a link to a container version.
      "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
      "type": "A String", # The type of this environment.
      "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
      "path": "A String", # GTM Environment's API relative path.
      "description": "A String", # The environment description. Can be set or changed only on USER type
          # environments.
          # @mutable tagmanager.accounts.containers.environments.create
          # @mutable tagmanager.accounts.containers.environments.update
      "enableDebug": True or False, # Whether or not to enable debug by default for the environment.
          # @mutable tagmanager.accounts.containers.environments.create
          # @mutable tagmanager.accounts.containers.environments.update
      "authorizationCode": "A String", # The environment authorization code.
      "authorizationTimestamp": "A String", # The last update time-stamp for the authorization code.
      "url": "A String", # Default preview page url for the environment.
          # @mutable tagmanager.accounts.containers.environments.create
          # @mutable tagmanager.accounts.containers.environments.update
    }
delete(path, x__xgafv=None)
Deletes a GTM Environment.

Args:
  path: string, GTM Environment's API relative path.
Example:
accounts/{account_id}/containers/{container_id}/environments/{environment_id} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
get(path, x__xgafv=None)
Gets a GTM Environment.

Args:
  path: string, GTM Environment's API relative path.
Example:
accounts/{account_id}/containers/{container_id}/environments/{environment_id} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Environment. Note that a user can create,
        # delete and update environments of type USER, but can only update the
        # enable_debug and url fields of environments of other types.
      "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time.
          # This value is recomputed whenever the environment is modified.
      "name": "A String", # The environment display name. Can be set or changed only on USER type
          # environments.
          # @mutable tagmanager.accounts.containers.environments.create
          # @mutable tagmanager.accounts.containers.environments.update
      "accountId": "A String", # GTM Account ID.
      "containerId": "A String", # GTM Container ID.
      "workspaceId": "A String", # Represents a link to a quick preview of a workspace.
      "containerVersionId": "A String", # Represents a link to a container version.
      "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
      "type": "A String", # The type of this environment.
      "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
      "path": "A String", # GTM Environment's API relative path.
      "description": "A String", # The environment description. Can be set or changed only on USER type
          # environments.
          # @mutable tagmanager.accounts.containers.environments.create
          # @mutable tagmanager.accounts.containers.environments.update
      "enableDebug": True or False, # Whether or not to enable debug by default for the environment.
          # @mutable tagmanager.accounts.containers.environments.create
          # @mutable tagmanager.accounts.containers.environments.update
      "authorizationCode": "A String", # The environment authorization code.
      "authorizationTimestamp": "A String", # The last update time-stamp for the authorization code.
      "url": "A String", # Default preview page url for the environment.
          # @mutable tagmanager.accounts.containers.environments.create
          # @mutable tagmanager.accounts.containers.environments.update
    }
list(parent, pageToken=None, x__xgafv=None)
Lists all GTM Environments of a GTM Container.

Args:
  parent: string, GTM Container's API relative path.
Example: accounts/{account_id}/containers/{container_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:

    { # List Environments Response.
    "environment": [ # All Environments of a GTM Container.
      { # Represents a Google Tag Manager Environment. Note that a user can create,
            # delete and update environments of type USER, but can only update the
            # enable_debug and url fields of environments of other types.
          "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time.
              # This value is recomputed whenever the environment is modified.
          "name": "A String", # The environment display name. Can be set or changed only on USER type
              # environments.
              # @mutable tagmanager.accounts.containers.environments.create
              # @mutable tagmanager.accounts.containers.environments.update
          "accountId": "A String", # GTM Account ID.
          "containerId": "A String", # GTM Container ID.
          "workspaceId": "A String", # Represents a link to a quick preview of a workspace.
          "containerVersionId": "A String", # Represents a link to a container version.
          "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
          "type": "A String", # The type of this environment.
          "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
          "path": "A String", # GTM Environment's API relative path.
          "description": "A String", # The environment description. Can be set or changed only on USER type
              # environments.
              # @mutable tagmanager.accounts.containers.environments.create
              # @mutable tagmanager.accounts.containers.environments.update
          "enableDebug": True or False, # Whether or not to enable debug by default for the environment.
              # @mutable tagmanager.accounts.containers.environments.create
              # @mutable tagmanager.accounts.containers.environments.update
          "authorizationCode": "A String", # The environment authorization code.
          "authorizationTimestamp": "A String", # The last update time-stamp for the authorization code.
          "url": "A String", # Default preview page url for the environment.
              # @mutable tagmanager.accounts.containers.environments.create
              # @mutable tagmanager.accounts.containers.environments.update
        },
    ],
    "nextPageToken": "A String", # Continuation token for fetching the next page of results.
  }
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.
    
reauthorize(path, body=None, x__xgafv=None)
Re-generates the authorization code for a GTM Environment.

Args:
  path: string, GTM Environment's API relative path.
Example:
accounts/{account_id}/containers/{container_id}/environments/{environment_id} (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a Google Tag Manager Environment. Note that a user can create,
      # delete and update environments of type USER, but can only update the
      # enable_debug and url fields of environments of other types.
    "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time.
        # This value is recomputed whenever the environment is modified.
    "name": "A String", # The environment display name. Can be set or changed only on USER type
        # environments.
        # @mutable tagmanager.accounts.containers.environments.create
        # @mutable tagmanager.accounts.containers.environments.update
    "accountId": "A String", # GTM Account ID.
    "containerId": "A String", # GTM Container ID.
    "workspaceId": "A String", # Represents a link to a quick preview of a workspace.
    "containerVersionId": "A String", # Represents a link to a container version.
    "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
    "type": "A String", # The type of this environment.
    "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
    "path": "A String", # GTM Environment's API relative path.
    "description": "A String", # The environment description. Can be set or changed only on USER type
        # environments.
        # @mutable tagmanager.accounts.containers.environments.create
        # @mutable tagmanager.accounts.containers.environments.update
    "enableDebug": True or False, # Whether or not to enable debug by default for the environment.
        # @mutable tagmanager.accounts.containers.environments.create
        # @mutable tagmanager.accounts.containers.environments.update
    "authorizationCode": "A String", # The environment authorization code.
    "authorizationTimestamp": "A String", # The last update time-stamp for the authorization code.
    "url": "A String", # Default preview page url for the environment.
        # @mutable tagmanager.accounts.containers.environments.create
        # @mutable tagmanager.accounts.containers.environments.update
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Environment. Note that a user can create,
        # delete and update environments of type USER, but can only update the
        # enable_debug and url fields of environments of other types.
      "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time.
          # This value is recomputed whenever the environment is modified.
      "name": "A String", # The environment display name. Can be set or changed only on USER type
          # environments.
          # @mutable tagmanager.accounts.containers.environments.create
          # @mutable tagmanager.accounts.containers.environments.update
      "accountId": "A String", # GTM Account ID.
      "containerId": "A String", # GTM Container ID.
      "workspaceId": "A String", # Represents a link to a quick preview of a workspace.
      "containerVersionId": "A String", # Represents a link to a container version.
      "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
      "type": "A String", # The type of this environment.
      "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
      "path": "A String", # GTM Environment's API relative path.
      "description": "A String", # The environment description. Can be set or changed only on USER type
          # environments.
          # @mutable tagmanager.accounts.containers.environments.create
          # @mutable tagmanager.accounts.containers.environments.update
      "enableDebug": True or False, # Whether or not to enable debug by default for the environment.
          # @mutable tagmanager.accounts.containers.environments.create
          # @mutable tagmanager.accounts.containers.environments.update
      "authorizationCode": "A String", # The environment authorization code.
      "authorizationTimestamp": "A String", # The last update time-stamp for the authorization code.
      "url": "A String", # Default preview page url for the environment.
          # @mutable tagmanager.accounts.containers.environments.create
          # @mutable tagmanager.accounts.containers.environments.update
    }
update(path, body=None, fingerprint=None, x__xgafv=None)
Updates a GTM Environment.

Args:
  path: string, GTM Environment's API relative path.
Example:
accounts/{account_id}/containers/{container_id}/environments/{environment_id} (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a Google Tag Manager Environment. Note that a user can create,
      # delete and update environments of type USER, but can only update the
      # enable_debug and url fields of environments of other types.
    "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time.
        # This value is recomputed whenever the environment is modified.
    "name": "A String", # The environment display name. Can be set or changed only on USER type
        # environments.
        # @mutable tagmanager.accounts.containers.environments.create
        # @mutable tagmanager.accounts.containers.environments.update
    "accountId": "A String", # GTM Account ID.
    "containerId": "A String", # GTM Container ID.
    "workspaceId": "A String", # Represents a link to a quick preview of a workspace.
    "containerVersionId": "A String", # Represents a link to a container version.
    "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
    "type": "A String", # The type of this environment.
    "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
    "path": "A String", # GTM Environment's API relative path.
    "description": "A String", # The environment description. Can be set or changed only on USER type
        # environments.
        # @mutable tagmanager.accounts.containers.environments.create
        # @mutable tagmanager.accounts.containers.environments.update
    "enableDebug": True or False, # Whether or not to enable debug by default for the environment.
        # @mutable tagmanager.accounts.containers.environments.create
        # @mutable tagmanager.accounts.containers.environments.update
    "authorizationCode": "A String", # The environment authorization code.
    "authorizationTimestamp": "A String", # The last update time-stamp for the authorization code.
    "url": "A String", # Default preview page url for the environment.
        # @mutable tagmanager.accounts.containers.environments.create
        # @mutable tagmanager.accounts.containers.environments.update
  }

  fingerprint: string, When provided, this fingerprint must match the fingerprint of the
environment in storage.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Environment. Note that a user can create,
        # delete and update environments of type USER, but can only update the
        # enable_debug and url fields of environments of other types.
      "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time.
          # This value is recomputed whenever the environment is modified.
      "name": "A String", # The environment display name. Can be set or changed only on USER type
          # environments.
          # @mutable tagmanager.accounts.containers.environments.create
          # @mutable tagmanager.accounts.containers.environments.update
      "accountId": "A String", # GTM Account ID.
      "containerId": "A String", # GTM Container ID.
      "workspaceId": "A String", # Represents a link to a quick preview of a workspace.
      "containerVersionId": "A String", # Represents a link to a container version.
      "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
      "type": "A String", # The type of this environment.
      "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
      "path": "A String", # GTM Environment's API relative path.
      "description": "A String", # The environment description. Can be set or changed only on USER type
          # environments.
          # @mutable tagmanager.accounts.containers.environments.create
          # @mutable tagmanager.accounts.containers.environments.update
      "enableDebug": True or False, # Whether or not to enable debug by default for the environment.
          # @mutable tagmanager.accounts.containers.environments.create
          # @mutable tagmanager.accounts.containers.environments.update
      "authorizationCode": "A String", # The environment authorization code.
      "authorizationTimestamp": "A String", # The last update time-stamp for the authorization code.
      "url": "A String", # Default preview page url for the environment.
          # @mutable tagmanager.accounts.containers.environments.create
          # @mutable tagmanager.accounts.containers.environments.update
    }