Google Analytics icon

Google Analytics

Use the Google Analytics API

Actions236

Admin (V1Alpha) - Property → Update Property Data Retention Settings

AI-generated

Overview

This node integrates with the Google Analytics API, specifically targeting the Admin (V1Alpha) resource for managing properties. The "Update Property Data Retention Settings" operation allows users to update data retention settings for a specified Google Analytics property. This is useful for administrators who need to configure how long user and event data is retained within their Google Analytics properties to comply with privacy policies or organizational requirements.

Common scenarios include:

  • Adjusting data retention periods to meet GDPR or other regulatory compliance.
  • Changing retention settings as part of property configuration updates.
  • Automating property management workflows that involve data retention policies.

Example use case:
An analytics administrator wants to programmatically update the data retention period for a specific property to 14 months instead of the default setting. Using this node operation, they can specify the property ID and provide the new retention settings in the request body to apply the change via the Google Analytics API.

Properties

Name Meaning
Property ID The unique identifier of the Google Analytics property whose data retention settings will be updated.
Query Parameters Optional parameters to customize the API request, including:
- Calculated Metric ID: ID for a calculated metric
- Entity: Level of data access report (property or account)
- 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 fetching next page
- Show Deleted: Whether to include soft-deleted properties
- Universal Analytics Property ID: UA property to look up connected GA4 property
- Update Mask: List of fields to update (in snake case)
Request Body JSON object containing the new data retention settings to apply to the property.

Output

The output is a JSON array where each element corresponds to the response from the Google Analytics API for the update request. The structure of the JSON depends on the API's response for updating property data retention settings, typically including the updated settings and metadata about the property.

No binary data output is involved in this operation.

Dependencies

  • Requires an OAuth2 API credential for Google Analytics with appropriate permissions to manage properties.
  • The node uses the Google Analytics Admin API endpoint https://analyticsadmin.googleapis.com/v1alpha.
  • Proper configuration of the OAuth2 credentials in n8n is necessary for authentication.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing credentials, ensure that the Google Analytics OAuth2 API credentials are configured correctly in n8n.
  • Required Parameter Errors: The node requires the Property ID to be set; if omitted, it will throw an error indicating the missing parameter.
  • API Errors: Errors returned by the Google Analytics API (e.g., permission denied, invalid request body) will be surfaced with messages prefixed by "Error calling Google Analytics API". Check the request body format and permissions.
  • Invalid Update Mask: If using the update mask query parameter, ensure field names are in snake case and valid according to the API specification.

Links and References

This summary is based solely on static analysis of the provided source code and input property definitions.

Discussion