Google Analytics

Use the Google Analytics API

Actions84

Admin (V1Alpha) - Account Actions
Admin (V1Alpha) - Account Access Binding Actions
Admin (V1Alpha) - Account Summary Actions
- List Account Summaries
Admin (V1Alpha) - AdSense Link Actions
Admin (V1Alpha) - Audience Actions
Admin (V1Alpha) - BigQuery Link Actions
Admin (V1Alpha) - Calculated Metric Actions
Admin (V1Alpha) - Channel Group Actions
Admin (V1Alpha) - Custom Dimension Actions
Admin (V1Alpha) - Custom Metric Actions
Admin (V1Alpha) - Data Stream Actions
Admin (V1Alpha) - Display & Video 360 Advertiser Link Actions
Admin (V1Alpha) - Display & Video 360 Advertiser Link Proposal Actions
Admin (V1Alpha) - Event Create Rule Actions
Admin (V1Alpha) - Event Edit Rule Actions

Overview

This node interacts with the Google Analytics API, specifically supporting a wide range of administrative and data management operations across different Google Analytics resources. The "Archive Custom Dimension" operation under the "Admin (V1Alpha) - Custom Dimension" resource allows users to archive (soft-delete) a specific custom dimension within a Google Analytics property.

This operation is useful when you want to deactivate or retire a custom dimension without permanently deleting it, preserving historical data while preventing further use. For example, if a custom dimension is no longer relevant for your analytics tracking but you want to keep its data intact, archiving it is appropriate.

Properties

Name	Meaning
Property ID	The identifier of the Google Analytics property that contains the custom dimension.
Custom Dimension ID	The identifier of the custom dimension to be archived.
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: Whether to include soft-deleted properties in results (boolean).
	- Universal Analytics Property ID: UA property to look up connected GA4 property (string).
	- Update Mask: List of fields to update (snake case) (string).

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 confirmation of the archived resource or relevant metadata.

No binary data output is involved in this operation.

Dependencies

Requires an OAuth2 API credential for Google Analytics to authenticate requests.
The node uses the Google Analytics Admin API endpoint https://analyticsadmin.googleapis.com/v1alpha.
Proper permissions on the Google Analytics property are necessary to perform archival actions.

Troubleshooting

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

Links and References

This summary focuses on the "Archive Custom Dimension" operation within the "Admin (V1Alpha) - Custom Dimension" resource as requested.