Google Analytics icon

Google Analytics

Use the Google Analytics API

Actions236

Admin (V1Alpha) - Reporting Data Annotation → Create Reporting Data Annotation

AI-generated

Overview

This node integrates with the Google Analytics API, specifically supporting a wide range of administrative and data-related operations. For the selected resource Admin (V1Alpha) - Reporting Data Annotation and operation Create Reporting Data Annotation, it allows users to create reporting data annotations within a specified Google Analytics property.

Use cases include adding contextual notes or metadata to reporting data in Google Analytics properties, which can help teams document changes, anomalies, or important events related to analytics data. This is useful for audit trails, collaboration, or enhanced reporting clarity.

Example scenario: A marketing analyst wants to annotate a spike in traffic due to a promotional campaign launch by creating a reporting data annotation linked to their GA4 property.

Properties

Name Meaning
Property ID The identifier of the Google Analytics property where the reporting data annotation will be created.
Query Parameters Optional parameters to filter or modify the request; includes options like calculatedMetricId, entity, filter, names, pageSize, pageToken, showDeleted, universalAnalyticsPropertyId, updateMask.
Request Body JSON object containing the details of the reporting data annotation to create.

The Query Parameters collection supports these options (all optional):

  • 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: Max number of report tasks to return.
  • Page Token: Token for pagination.
  • Show Deleted: Include soft-deleted properties.
  • Universal Analytics Property ID: UA property to look up connected GA4 property.
  • Update Mask: List of fields to update (snake case).

The Request Body must be a valid JSON string representing the annotation details as per Google Analytics API requirements.

Output

The node outputs an array of JSON objects representing the response from the Google Analytics API after creating the reporting data annotation. The structure corresponds to the API's response schema for a reporting data annotation resource, typically including fields such as annotation ID, time range, description, and other metadata.

No binary data output is involved.

Dependencies

  • Requires an OAuth2 credential configured for Google Analytics API access.
  • The node uses the Google Analytics Admin API endpoint https://analyticsadmin.googleapis.com/v1alpha.
  • Proper permissions on the Google Analytics property are necessary to create reporting data annotations.

Troubleshooting

  • Missing Credentials Error: If the node throws "Missing Google Analytics API Credentials", ensure that a valid OAuth2 credential for Google Analytics API is configured and selected.
  • Required Parameter Errors: Errors like "Property ID is required" or "Reporting Data Annotation ID is required" indicate missing mandatory inputs. Verify all required fields are set.
  • API Call Failures: Errors returned from the Google Analytics API will be wrapped with "Error calling Google Analytics API". Check the error message and stack trace for details. Common issues include insufficient permissions, invalid JSON in the request body, or incorrect property IDs.
  • JSON Parsing Issues: Ensure the Request Body JSON is well-formed and matches the expected schema for reporting data annotations.

Links and References

This summary focuses on the Admin (V1Alpha) - Reporting Data Annotation resource and the Create Reporting Data Annotation operation as requested.

Discussion