Tag Manager API . accounts . containers . workspaces . templates

Instance Methods

close()

Close httplib2 connections.

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

Creates a GTM Custom Template.

delete(path, x__xgafv=None)

Deletes a GTM Template.

get(path, x__xgafv=None)

Gets a GTM Template.

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

Lists all GTM Templates of a GTM container workspace.

list_next()

Retrieves the next page of results.

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

Reverts changes to a GTM Template in a GTM Workspace.

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

Updates a GTM Template.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a GTM Custom Template.

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

{ # Represents a Google Tag Manager Custom Template's contents.
  "accountId": "A String", # GTM Account ID.
  "containerId": "A String", # GTM Container ID.
  "fingerprint": "A String", # The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified.
  "galleryReference": { # Represents the link between a custom template and an entry on the Community Template Gallery site. # A reference to the Community Template Gallery entry.
    "host": "A String", # The name of the host for the community gallery template.
    "isModified": True or False, # If a user has manually edited the community gallery template.
    "owner": "A String", # The name of the owner for the community gallery template.
    "repository": "A String", # The name of the repository for the community gallery template.
    "signature": "A String", # The signature of the community gallery template as computed at import time. This value is recomputed whenever the template is updated from the gallery.
    "version": "A String", # The version of the community gallery template.
  },
  "name": "A String", # Custom Template display name.
  "path": "A String", # GTM Custom Template's API relative path.
  "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
  "templateData": "A String", # The custom template in text format.
  "templateId": "A String", # The Custom Template ID uniquely identifies the GTM custom template.
  "workspaceId": "A String", # GTM Workspace ID.
}

  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 Custom Template's contents.
  "accountId": "A String", # GTM Account ID.
  "containerId": "A String", # GTM Container ID.
  "fingerprint": "A String", # The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified.
  "galleryReference": { # Represents the link between a custom template and an entry on the Community Template Gallery site. # A reference to the Community Template Gallery entry.
    "host": "A String", # The name of the host for the community gallery template.
    "isModified": True or False, # If a user has manually edited the community gallery template.
    "owner": "A String", # The name of the owner for the community gallery template.
    "repository": "A String", # The name of the repository for the community gallery template.
    "signature": "A String", # The signature of the community gallery template as computed at import time. This value is recomputed whenever the template is updated from the gallery.
    "version": "A String", # The version of the community gallery template.
  },
  "name": "A String", # Custom Template display name.
  "path": "A String", # GTM Custom Template's API relative path.
  "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
  "templateData": "A String", # The custom template in text format.
  "templateId": "A String", # The Custom Template ID uniquely identifies the GTM custom template.
  "workspaceId": "A String", # GTM Workspace ID.
}
delete(path, x__xgafv=None)
Deletes a GTM Template.

Args:
  path: string, GTM Custom Template's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/templates/{template_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 Template.

Args:
  path: string, GTM Custom Template's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/templates/{template_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 Custom Template's contents.
  "accountId": "A String", # GTM Account ID.
  "containerId": "A String", # GTM Container ID.
  "fingerprint": "A String", # The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified.
  "galleryReference": { # Represents the link between a custom template and an entry on the Community Template Gallery site. # A reference to the Community Template Gallery entry.
    "host": "A String", # The name of the host for the community gallery template.
    "isModified": True or False, # If a user has manually edited the community gallery template.
    "owner": "A String", # The name of the owner for the community gallery template.
    "repository": "A String", # The name of the repository for the community gallery template.
    "signature": "A String", # The signature of the community gallery template as computed at import time. This value is recomputed whenever the template is updated from the gallery.
    "version": "A String", # The version of the community gallery template.
  },
  "name": "A String", # Custom Template display name.
  "path": "A String", # GTM Custom Template's API relative path.
  "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
  "templateData": "A String", # The custom template in text format.
  "templateId": "A String", # The Custom Template ID uniquely identifies the GTM custom template.
  "workspaceId": "A String", # GTM Workspace ID.
}
list(parent, pageToken=None, x__xgafv=None)
Lists all GTM Templates of a GTM container workspace.

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:

    {
  "nextPageToken": "A String", # Continuation token for fetching the next page of results.
  "template": [ # All GTM Custom Templates of a GTM Container.
    { # Represents a Google Tag Manager Custom Template's contents.
      "accountId": "A String", # GTM Account ID.
      "containerId": "A String", # GTM Container ID.
      "fingerprint": "A String", # The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified.
      "galleryReference": { # Represents the link between a custom template and an entry on the Community Template Gallery site. # A reference to the Community Template Gallery entry.
        "host": "A String", # The name of the host for the community gallery template.
        "isModified": True or False, # If a user has manually edited the community gallery template.
        "owner": "A String", # The name of the owner for the community gallery template.
        "repository": "A String", # The name of the repository for the community gallery template.
        "signature": "A String", # The signature of the community gallery template as computed at import time. This value is recomputed whenever the template is updated from the gallery.
        "version": "A String", # The version of the community gallery template.
      },
      "name": "A String", # Custom Template display name.
      "path": "A String", # GTM Custom Template's API relative path.
      "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
      "templateData": "A String", # The custom template in text format.
      "templateId": "A String", # The Custom Template ID uniquely identifies the GTM custom template.
      "workspaceId": "A String", # GTM Workspace ID.
    },
  ],
}
list_next()
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, fingerprint=None, x__xgafv=None)
Reverts changes to a GTM Template in a GTM Workspace.

Args:
  path: string, GTM Custom Template's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/templates/{template_id} (required)
  fingerprint: string, When provided, this fingerprint must match the fingerprint of the template in storage.
  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 template in a workspace.
  "template": { # Represents a Google Tag Manager Custom Template's contents. # Template as it appears in the latest container version since the last workspace synchronization operation. If no template is present, that means the template was deleted in the latest container version.
    "accountId": "A String", # GTM Account ID.
    "containerId": "A String", # GTM Container ID.
    "fingerprint": "A String", # The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified.
    "galleryReference": { # Represents the link between a custom template and an entry on the Community Template Gallery site. # A reference to the Community Template Gallery entry.
      "host": "A String", # The name of the host for the community gallery template.
      "isModified": True or False, # If a user has manually edited the community gallery template.
      "owner": "A String", # The name of the owner for the community gallery template.
      "repository": "A String", # The name of the repository for the community gallery template.
      "signature": "A String", # The signature of the community gallery template as computed at import time. This value is recomputed whenever the template is updated from the gallery.
      "version": "A String", # The version of the community gallery template.
    },
    "name": "A String", # Custom Template display name.
    "path": "A String", # GTM Custom Template's API relative path.
    "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
    "templateData": "A String", # The custom template in text format.
    "templateId": "A String", # The Custom Template ID uniquely identifies the GTM custom template.
    "workspaceId": "A String", # GTM Workspace ID.
  },
}
update(path, body=None, fingerprint=None, x__xgafv=None)
Updates a GTM Template.

Args:
  path: string, GTM Custom Template's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/templates/{template_id} (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a Google Tag Manager Custom Template's contents.
  "accountId": "A String", # GTM Account ID.
  "containerId": "A String", # GTM Container ID.
  "fingerprint": "A String", # The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified.
  "galleryReference": { # Represents the link between a custom template and an entry on the Community Template Gallery site. # A reference to the Community Template Gallery entry.
    "host": "A String", # The name of the host for the community gallery template.
    "isModified": True or False, # If a user has manually edited the community gallery template.
    "owner": "A String", # The name of the owner for the community gallery template.
    "repository": "A String", # The name of the repository for the community gallery template.
    "signature": "A String", # The signature of the community gallery template as computed at import time. This value is recomputed whenever the template is updated from the gallery.
    "version": "A String", # The version of the community gallery template.
  },
  "name": "A String", # Custom Template display name.
  "path": "A String", # GTM Custom Template's API relative path.
  "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
  "templateData": "A String", # The custom template in text format.
  "templateId": "A String", # The Custom Template ID uniquely identifies the GTM custom template.
  "workspaceId": "A String", # GTM Workspace ID.
}

  fingerprint: string, When provided, this fingerprint must match the fingerprint of the templates 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 Custom Template's contents.
  "accountId": "A String", # GTM Account ID.
  "containerId": "A String", # GTM Container ID.
  "fingerprint": "A String", # The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified.
  "galleryReference": { # Represents the link between a custom template and an entry on the Community Template Gallery site. # A reference to the Community Template Gallery entry.
    "host": "A String", # The name of the host for the community gallery template.
    "isModified": True or False, # If a user has manually edited the community gallery template.
    "owner": "A String", # The name of the owner for the community gallery template.
    "repository": "A String", # The name of the repository for the community gallery template.
    "signature": "A String", # The signature of the community gallery template as computed at import time. This value is recomputed whenever the template is updated from the gallery.
    "version": "A String", # The version of the community gallery template.
  },
  "name": "A String", # Custom Template display name.
  "path": "A String", # GTM Custom Template's API relative path.
  "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
  "templateData": "A String", # The custom template in text format.
  "templateId": "A String", # The Custom Template ID uniquely identifies the GTM custom template.
  "workspaceId": "A String", # GTM Workspace ID.
}