Rules: list

Requires authorization

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

Request

HTTP request

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

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:

{
  "rules": [
    accounts.containers.rules Resource
  ]
}

Property name	Value	Description	Notes
rules[]	list	All GTM Rules 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 all rules for the authorized user.
 */
try {
  ListRulesResponse rules = tagmanager.accounts().containers().rules().
      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 rules object.
 * The following code shows how to iterate through them.
 */
for (Rule rule : rules.getRules()) {
  System.out.println("Account Id = " + rule.getAccountId());
  System.out.println("Container Id = " + rule.getContainerId());
  System.out.println("Rule Id = " + rule.getRuleId());
  System.out.println("Rule Name = " + rule.getName());
  System.out.println("Rule Notes = " + rule.getNotes());

  // Get the conditions.
  if (rule.getCondition() != null) {
    for (Condition condition : rule.getCondition()) {
      System.out.println("Condition Type = " + condition.getType());
      if (condition.getParameter() != null) {
        for (Parameter parameter : condition.getParameter()) {
          System.out.println("Parameter Type = " + parameter.getType());
          System.out.println("Parameter Key = " + parameter.getKey());
          System.out.println("Parameter Value = " + parameter.getValue());
        }
      }
    }
  }
  System.out.println("Rule Fingerprint = " + rule.getFingerprint());
}

Python

Uses the Python client library.

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

# This request lists all rules for the authorized user.
try:
  rules = tagmanager.accounts().containers().rules().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 rules object.
# The following code shows how to iterate through them.
for rule in rules.get('rules', []):
  print 'Account Id = %s' % rules.get('accountId')
  print 'Container Id = %s' % rules.get('containerId')
  print 'Rule Id = %s' % rule.get('ruleId')
  print 'Rule Name = %s' % rule.get('name')
  print 'Rule Notes = %s' % rule.get('notes')
  for condition in rule.get('condition', []):
    print 'Condition Type = %s' % condition.get('type')
    for parameter in condition.get('parameter', []):
      print 'Parameter Type = %s' % parameter.get('type')
      print 'Parameter Key = %s' % parameter.get('key')
      print 'Parameter Value = %s' % parameter.get('value')
  print 'Rule Fingerprint = %s\n\n' % rule.get('fingerprint')

Try it!

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