Google Analytics icon

Google Analytics

Use the Google Analytics API

Actions84

Overview

This node integrates with the Google Analytics API, specifically targeting the Admin (V1Alpha) resource for managing Custom Dimensions within a property. The "Update Custom Dimension" operation allows users to modify existing custom dimension configurations in their Google Analytics properties.

Common scenarios include:

  • Adjusting the settings or metadata of a custom dimension after its initial creation.
  • Correcting or updating dimension names, scopes, or other attributes without recreating the dimension.
  • Automating updates to multiple custom dimensions across properties via workflows.

For example, a marketing analyst might update the description or scope of a custom dimension to better reflect new tracking requirements, or a developer could automate batch updates to custom dimensions as part of a deployment pipeline.

Properties

Name Meaning
Property ID The identifier of the Google Analytics property where the custom dimension exists.
Custom Dimension ID The unique identifier of the custom dimension to update.
Query Parameters Optional parameters to customize the request, including:
- Calculated Metric ID: ID for a calculated metric (string).
- Entity: Level of data access report (property or account level) (string).
- Filter: Expression to filter results (string).
- Names: Names of access bindings to retrieve (string).
- Page Size: Maximum number of report tasks to return (number).
- Page Token: Continuation token for pagination (string).
- Show Deleted: Include soft-deleted properties (boolean).
- Universal Analytics Property ID: UA property to look up connected GA4 property (string).
- Update Mask: Comma-separated list of fields to update in snake_case (string).
Request Body JSON object containing the fields and values to update on the custom dimension.

Output

The node outputs a JSON array where each element corresponds to the response from the Google Analytics API for the update operation. The JSON structure reflects the updated custom dimension resource as returned by the API, typically including fields such as:

  • name: Resource name of the custom dimension.
  • parameterName: The parameter name used in reports.
  • displayName: Human-readable name of the custom dimension.
  • description: Description of the custom dimension.
  • scope: Scope of the dimension (e.g., EVENT, USER).
  • Other metadata fields relevant to the custom dimension.

No binary data output is involved in this operation.

Dependencies

  • Requires an OAuth2 credential configured for Google Analytics API access.
  • The node uses the Google Analytics Admin API endpoint at https://analyticsadmin.googleapis.com/v1alpha.
  • Proper permissions on the Google Analytics property are necessary to perform update operations on custom dimensions.

Troubleshooting

  • Missing Credentials Error: If the node throws "Missing Google Analytics API Credentials," ensure that a valid OAuth2 credential for Google Analytics is configured and selected.
  • Required Parameter Errors: Errors like "Property ID is required" or "Custom Dimension ID is required" indicate missing essential input parameters. Verify that these IDs are correctly provided.
  • API Errors: Errors returned from the Google Analytics API will be wrapped and shown with the message prefix "Error calling Google Analytics API." Check the error details for issues such as insufficient permissions, invalid IDs, or malformed request bodies.
  • Update Mask Usage: If partial updates do not apply as expected, verify that the updateMask query parameter correctly lists the fields intended for update in snake_case format.

Links and References

This summary focuses on the "Update Custom Dimension" operation under the Admin (V1Alpha) - Custom Dimension resource, describing its purpose, inputs, outputs, dependencies, and common troubleshooting points based on static analysis of the node's source code and provided property definitions.

Discussion