Tag Manager API . accounts . containers

Instance Methods

environments()

Returns the environments Resource.

version_headers()

Returns the version_headers Resource.

versions()

Returns the versions Resource.

workspaces()

Returns the workspaces Resource.

create(parent, body)

Creates a Container.

delete(path)

Deletes a Container.

get(path)

Gets a Container.

list(parent, pageToken=None)

Lists all Containers that belongs to a GTM Account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(path, body, fingerprint=None)

Updates a Container.

Method Details

create(parent, body)
Creates a Container.

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

{ # Represents a Google Tag Manager Container, which specifies the platform tags will run on, manages workspaces, and retains container versions.
    "publicId": "A String", # Container Public ID.
    "containerId": "A String", # The Container ID uniquely identifies the GTM Container.
    "domainName": [ # List of domain names associated with the Container.
      "A String",
    ],
    "notes": "A String", # Container Notes.
    "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
    "usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, or ios.
      "A String",
    ],
    "fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
    "path": "A String", # GTM Container's API relative path.
    "accountId": "A String", # GTM Account ID.
    "name": "A String", # Container display name.
  }


Returns:
  An object of the form:

    { # Represents a Google Tag Manager Container, which specifies the platform tags will run on, manages workspaces, and retains container versions.
      "publicId": "A String", # Container Public ID.
      "containerId": "A String", # The Container ID uniquely identifies the GTM Container.
      "domainName": [ # List of domain names associated with the Container.
        "A String",
      ],
      "notes": "A String", # Container Notes.
      "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
      "usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, or ios.
        "A String",
      ],
      "fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
      "path": "A String", # GTM Container's API relative path.
      "accountId": "A String", # GTM Account ID.
      "name": "A String", # Container display name.
    }
delete(path)
Deletes a Container.

Args:
  path: string, GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id} (required)
get(path)
Gets a Container.

Args:
  path: string, GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id} (required)

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Container, which specifies the platform tags will run on, manages workspaces, and retains container versions.
      "publicId": "A String", # Container Public ID.
      "containerId": "A String", # The Container ID uniquely identifies the GTM Container.
      "domainName": [ # List of domain names associated with the Container.
        "A String",
      ],
      "notes": "A String", # Container Notes.
      "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
      "usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, or ios.
        "A String",
      ],
      "fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
      "path": "A String", # GTM Container's API relative path.
      "accountId": "A String", # GTM Account ID.
      "name": "A String", # Container display name.
    }
list(parent, pageToken=None)
Lists all Containers that belongs to a GTM Account.

Args:
  parent: string, GTM Accounts's API relative path. Example: accounts/{account_id}. (required)
  pageToken: string, Continuation token for fetching the next page of results.

Returns:
  An object of the form:

    { # List Containers Response.
    "nextPageToken": "A String", # Continuation token for fetching the next page of results.
    "container": [ # All Containers of a GTM Account.
      { # Represents a Google Tag Manager Container, which specifies the platform tags will run on, manages workspaces, and retains container versions.
          "publicId": "A String", # Container Public ID.
          "containerId": "A String", # The Container ID uniquely identifies the GTM Container.
          "domainName": [ # List of domain names associated with the Container.
            "A String",
          ],
          "notes": "A String", # Container Notes.
          "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
          "usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, or ios.
            "A String",
          ],
          "fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
          "path": "A String", # GTM Container's API relative path.
          "accountId": "A String", # GTM Account ID.
          "name": "A String", # Container display name.
        },
    ],
  }
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.
    
update(path, body, fingerprint=None)
Updates a Container.

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

{ # Represents a Google Tag Manager Container, which specifies the platform tags will run on, manages workspaces, and retains container versions.
    "publicId": "A String", # Container Public ID.
    "containerId": "A String", # The Container ID uniquely identifies the GTM Container.
    "domainName": [ # List of domain names associated with the Container.
      "A String",
    ],
    "notes": "A String", # Container Notes.
    "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
    "usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, or ios.
      "A String",
    ],
    "fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
    "path": "A String", # GTM Container's API relative path.
    "accountId": "A String", # GTM Account ID.
    "name": "A String", # Container display name.
  }

  fingerprint: string, When provided, this fingerprint must match the fingerprint of the container in storage.

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Container, which specifies the platform tags will run on, manages workspaces, and retains container versions.
      "publicId": "A String", # Container Public ID.
      "containerId": "A String", # The Container ID uniquely identifies the GTM Container.
      "domainName": [ # List of domain names associated with the Container.
        "A String",
      ],
      "notes": "A String", # Container Notes.
      "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
      "usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, or ios.
        "A String",
      ],
      "fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
      "path": "A String", # GTM Container's API relative path.
      "accountId": "A String", # GTM Account ID.
      "name": "A String", # Container display name.
    }