Google Tag Manager

Use the Google Tag Manager API

Actions84

Overview

This node integrates with the Google Tag Manager (GTM) API, allowing users to manage various GTM resources programmatically. Specifically, for the Client resource and the List Clients operation, it lists all GTM clients within a specified container workspace. This is useful for scenarios where you want to retrieve and process client configurations or audit existing clients in your GTM setup.

Practical examples include:

Automating the retrieval of all clients in a workspace to synchronize or analyze them.
Integrating GTM client data into other workflows or reporting tools.
Monitoring changes or updates to clients across multiple containers or workspaces.

Properties

Name	Meaning
Account ID	The GTM Account ID under which the container and workspace exist.
Container ID	The GTM Container ID that holds the workspace containing the clients.
Workspace ID	The GTM Workspace ID within the container where clients are managed.
Optional Query Parameters	Additional optional parameters to customize the request. For this operation, typically empty.

Details on input properties relevant to "List Clients":

Account ID: Required to specify the GTM account.
Container ID: Required to specify the container within the account.
Workspace ID: Required to specify the workspace inside the container.
Optional Query Parameters: A collection of optional parameters; none are specifically required or commonly used for listing clients.

Output

The output is a JSON array where each item represents a GTM Client object retrieved from the specified workspace. Each client object contains details as defined by the GTM API's client resource schema, such as client identifiers, names, and configuration details.

No binary data is output by this operation.

Example output structure (simplified):

[
  {
    "clientId": "12345",
    "name": "Client Name",
    "type": "someType",
    "parameter": [...],
    ...
  },
  ...
]

Dependencies

Requires an OAuth2 credential configured for Google Tag Manager API access.
The node uses the Google Tag Manager API endpoint https://www.googleapis.com/tagmanager/v2.
Proper permissions on the GTM account, container, and workspace are necessary to list clients.

Troubleshooting

Missing Credentials Error: If the node throws an error about missing credentials, ensure that a valid OAuth2 credential for Google Tag Manager API is set up and connected.
Required Parameter Errors: Errors indicating missing Account ID, Container ID, or Workspace ID mean these fields must be provided and correctly filled.
API Errors: Errors returned from the GTM API may indicate permission issues, invalid IDs, or network problems. Check the error message for details.
Empty Results: If no clients are returned, verify that the specified workspace actually contains clients.