Containers: update

Requires authorization

Updates a container. Try it now or see an example.

Request

HTTP request

PUT https://www.googleapis.com/tagmanager/v1/accounts/accountId/containers/containerId

Parameters

Parameter name Value Description
Path parameters
accountId string The GTM Account ID.
containerId string The GTM Container ID.
Optional query parameters
fingerprint string When provided, this fingerprint must match the fingerprint of the container in storage.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/tagmanager.edit.containers

Request body

In the request body, supply a Containers resource with the following properties:

Property name Value Description Notes
Optional Properties
domainName[] list Optional list of domain names associated with the Container. writable
enabledBuiltInVariable[] list List of enabled built-in variables. Valid values include: pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId. writable
name string Container display name. writable
notes string Container Notes. writable
timeZoneCountryId string Container Country ID. writable
timeZoneId string Container Time Zone ID. writable
usageContext[] list List of Usage Contexts for the Container. Valid values include: web, android, ios. writable

Response

If successful, this method returns a Containers resource in the response body.

Examples

Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).

Java

Uses the Java client library.

/*
 * Note: This code assumes you have an authorized tagmanager service object.
 */

/*
 * This request updates an existing container for the authorized user.
 */

// Construct the container object.
Container container = new Container();
container.setName("Example Container");
container.setNotes("Example Container Notes.");
container.setTimeZoneCountryId("US");
container.setTimeZoneId("America/Los_Angeles");
container.setUsageContext(Arrays.asList("web", "android", "ios"));

try {
  Container response = tagmanager.accounts().
      containers().update("123456", "54321", container).execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

/*
 * The results of the update method are stored in the response object.
 * The following code shows how to access the updated name and fingerprint.
 */
System.out.println("Updated Name = " + response.getName());
System.out.println("Updated Fingerprint = " + response.getFingerprint());

Python

Uses the Python client library.

# Note: This code assumes you have an authorized tagmanager service object.

# This request updates an existing container.
try:
  response = tagmanager.accounts().containers().update(
      accountId='123456',
      containerId='54321',
      body={
          'name': 'Example Container',
          'timeZoneCountryId': 'US',
          'timeZoneId': 'America/Los_Angeles',
          'usageContext': ['web', 'android']
      }
  ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

# The results of the update method are stored in the response object.
# The following code shows how to access the updated name and fingerprint.
print 'Updated Name = %s' % response.get('name')
print 'Updated Fingerprint = %s' % response.get('fingerprint')

Try it!

Use the APIs Explorer below to call this method on live data and see the response.