Actions27
- Account Actions
- Built-In Variable Actions
- Client Actions
- Container Actions
- Destination Actions
- Environment Actions
Client → List Clients
AI-generatedOverview
This node interacts with the Google Tag Manager (GTM) API to manage GTM Clients within a specified GTM container workspace. Specifically, the 'List Clients' operation retrieves all GTM Clients associated with a given GTM account, container, and workspace. This is useful for users who want to programmatically access and manage client configurations within their GTM setup, such as auditing or synchronizing client data.
Use Case Examples
- A marketing team wants to list all clients in a specific GTM container workspace to review their configurations.
- A developer automates the retrieval of GTM clients to integrate with another system for analytics or tag management.
Properties
| Name | Meaning |
|---|---|
| Account ID | The GTM Account ID to specify which account's clients to list. |
| Container ID | The GTM Container ID within the account to specify the container whose clients are to be listed. |
| Workspace ID | The GTM Workspace ID within the container to specify the workspace context for listing clients. |
| Optional Query Parameters | Additional optional parameters to customize the API request, such as pagination tokens or filters. |
Output
JSON
clientId- The unique identifier of the GTM Client.name- The name of the GTM Client.path- The API path of the GTM Client resource.type- The type of the GTM Client.parameter- Parameters associated with the GTM Client.fingerprint- Fingerprint for concurrency control of the GTM Client.
Dependencies
- Google Tag Manager API OAuth2 credentials
Troubleshooting
- Ensure that the GTM Account ID, Container ID, and Workspace ID are provided as they are required parameters for listing clients.
- Check that the OAuth2 credentials for Google Tag Manager API are correctly configured and authorized.
- If the API returns an error, verify that the user has sufficient permissions to access the specified GTM account and container.
- Pagination issues may occur if the 'Page Token' optional parameter is not handled correctly when listing large numbers of clients.
Links
- Google Tag Manager API - List Clients - Official documentation for the List Clients operation in the Google Tag Manager API.