Google Analytics icon

Google Analytics

Use the Google Analytics API

Actions236

Admin (V1Beta) - Custom Metric → Update Custom Metric

AI-generated

Overview

This node integrates with the Google Analytics API, specifically supporting a wide range of administrative and data operations across different API versions (v1alpha, v1beta) and data endpoints. The "Update Custom Metric" operation under the "Admin (V1Beta) - Custom Metric" resource allows users to update an existing custom metric within a specified Google Analytics property.

Use cases include managing and customizing metrics for Google Analytics properties programmatically, enabling automation of metric updates without manual intervention in the Google Analytics UI. For example, you might update the configuration or attributes of a custom metric to reflect changes in your tracking strategy or business requirements.

Properties

Name Meaning
Property ID The identifier of the Google Analytics property where the custom metric exists.
Custom Metric ID The identifier of the specific custom metric to update within the property.
Query Parameters Optional parameters to customize the request, including:
- Calculated Metric ID: ID for a calculated metric related to this custom metric.
- Entity: Level of data access report (property or account level).
- Filter: Expression to filter results.
- Names: Names of access bindings to retrieve.
- Page Size: Maximum number of report tasks to return.
- Page Token: Token for pagination continuation.
- Show Deleted: Whether to include soft-deleted properties.
- Universal Analytics Property ID: UA property linked to GA4 property.
- Update Mask: Comma-separated list of fields to update (in snake_case).
Request Body JSON object containing the updated data for the custom metric. This is the main payload for the update operation.

Output

The node outputs a JSON array where each element corresponds to the response from the Google Analytics API for the executed operation. For the "Update Custom Metric" operation, the output JSON contains the updated custom metric resource as returned by the API, reflecting the new state after the update.

No binary data output is involved in this operation.

Dependencies

  • Requires valid Google Analytics API OAuth2 credentials configured in n8n.
  • The node uses the Google Analytics Admin API endpoints (https://analyticsadmin.googleapis.com/v1beta) for the "Admin (V1Beta)" resources.
  • Proper permissions on the Google Analytics account and property are necessary to perform update operations on custom metrics.

Troubleshooting

  • Missing Credentials Error: If the node throws "Missing Google Analytics API Credentials," ensure that OAuth2 credentials for Google Analytics are properly set up and connected in n8n.
  • Required Parameter Errors: Errors like "Property ID is required" or "Custom Metric 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: When specifying updateMask in query parameters, ensure field names are in snake_case and correspond exactly to the fields intended for update; otherwise, partial updates may not apply as expected.

Links and References

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

Discussion