Google AnalyticsInstall

Overview

This node interacts with the Google Analytics API, specifically targeting the Admin (V1Beta) resource for managing Custom Dimensions. The "Archive Custom Dimension" operation allows users to archive a specific custom dimension within a Google Analytics property. Archiving a custom dimension effectively disables it without permanently deleting the data, which can be useful for cleaning up or deprecating unused dimensions while preserving historical data.

Common scenarios where this node is beneficial include:

• Managing and maintaining Google Analytics properties by archiving obsolete or unused custom dimensions.
• Automating administrative tasks in Google Analytics to keep the analytics setup clean and relevant.
• Integrating Google Analytics management into broader workflows that require programmatic control over custom dimensions.

Example use case:

• A marketing team wants to archive a custom dimension that is no longer used in their tracking setup to prevent it from appearing in reports, without losing past data associated with it.

Properties

The Query Parameters collection supports these options (not all are relevant for this operation but available generally):

• Calculated Metric ID
• Entity (property or account level)
• Filter expression
• Names (access bindings to retrieve)
• Page Size (max number of results)
• Page Token (for pagination)
• Show Deleted (include soft-deleted items)
• Universal Analytics Property ID
• Update Mask (fields to update)

Output

The output is a JSON array containing the response from the Google Analytics API after attempting to archive the specified custom dimension. The exact structure depends on the API's response but typically includes metadata about the archived custom dimension or confirmation of the action.

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 https://analyticsadmin.googleapis.com/v1beta.
• Proper permissions on the Google Analytics property are necessary to archive custom dimensions.

Troubleshooting

• Missing Credentials Error: If the node throws an error about missing credentials, ensure that a valid Google Analytics OAuth2 credential is configured and selected.
• Required Parameter Errors: Errors indicating missing "Property ID" or "Custom Dimension ID" mean these inputs must be provided for the operation to succeed.
• API Permission Errors: Insufficient permissions on the Google Analytics property may cause authorization errors; verify that the authenticated user has admin rights.
• Invalid IDs: Providing incorrect or non-existent Property or Custom Dimension IDs will result in API errors; double-check the IDs.
• Network or API Errors: General API call failures might occur due to network issues or API limits; retry or check Google API status.

Links and References

• Google Analytics Admin API Documentation
• Manage Custom Dimensions
• Google Analytics API OAuth2 Setup

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