Note: This developer site is moving to developers.google.com/tag-platform and will be redirected by September 30, 2021

Variables: list

Requires authorization

Lists all GTM variables of a container. Try it now or see an example.

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
accountId string The GTM Account ID.
containerId string The GTM Container ID.

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

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

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "variables": [
    accounts.containers.variables Resource
  ]
}
Property name Value Description Notes
variables[] list All GTM Variables of a GTM Container.

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 lists variables for the authorized user.
 */
try {
  ListVariablesResponse variables = tagmanager.accounts().containers().
      variables().list("123456", "54321").execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

/*
 * The results of the list method are stored in the variables object.
 * The following code shows how to iterate through them.
 */
for (Variable variable: variables.getVariables()) {
  System.out.println("Account Id = " + variable.getAccountId());
  System.out.println("Container Id = " + variable.getContainerId());
  System.out.println("Variable Id = " + variable.getVariableId());
  System.out.println("Variable Name = " + variable.getName());
  System.out.println("Variable Type = " + variable.getType());
  System.out.println("Variable Notes = " + variable.getNotes());
  if (variable.getParameter() != null) {
    for (Parameter parameter : variable.getParameter()) {
      System.out.println("Parameter Type = " + parameter.getType());
      System.out.println("Parameter Key = " + parameter.getKey());
      System.out.println("Parameter Value = " + parameter.getValue());
    }
  }
  if (variable.getEnablingTriggerId() != null) {
    for (String enablingTriggerId : variable.getEnablingTriggerId()) {
      System.out.println("Enabling Trigger Id = " + enablingTriggerId);
    }
  }
  if (variable.getDisablingTriggerId() != null) {
    for (String disablingTriggerId : variable.getDisablingTriggerId()) {
      System.out.println("Disabling Trigger Id " + disablingTriggerId);
    }
  }
  System.out.println("Variable Fingerprint = "
      + variable.getFingerprint());
}

Python

Uses the Python client library.

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

# This request lists variables for the authorized user.
try:
  variables = tagmanager.accounts().containers().variables().list(
      accountId='123456',
      containerId='54321'
  ).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 list method are stored in the variables object.
# The following code shows how to iterate through them.
for variable in variables.get('variables', []):
  print 'Account Id = %s' % variable.get('accountId')
  print 'Container Id = %s' % variable.get('containerId')
  print 'Variable Id = %s' % variable.get('variableId')
  print 'Variable Name = %s' % variable.get('name')
  print 'Variable Type = %s' % variable.get('type')
  print 'Variable notes = %s' % variable.get('notes')
  for parameter in variable.get('parameter', []):
    print 'Parameter Type = %s' % parameter.get('type')
    print 'Parameter Key = %s' % parameter.get('key')
    print 'Parameter Value = %s' % parameter.get('value')
  for enablingTrigerId in variable.get('enablingTrigerId', []):
    print 'Enabling Trigger Id = %s' % enablingTrigerId
  for disablingTriggerId in variable.get('disablingTriggerId', []):
    print 'Disabling Trigger Id = %s' % disablingTriggerId
  print 'Variable Fingerprint = %s\n\n' % variable.get('fingerprint')

Try it!

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