Google Analytics icon

Google Analytics

Use the Google Analytics API

Actions236

Admin (V1Beta) - Key Event → Create Key Event

AI-generated

Overview

This node integrates with the Google Analytics API, specifically supporting the "Admin (V1Beta) - Key Event" resource and its operations. The "Create Key Event" operation allows users to create a key event within a specified Google Analytics property. This is useful for tracking significant user interactions or milestones in your analytics data.

Common scenarios include:

  • Defining important events that should be highlighted in reports.
  • Automating the creation of key events as part of a larger analytics setup workflow.
  • Managing key events programmatically without manual intervention in the Google Analytics UI.

Example use case:

  • Automatically creating a key event when a new product launch campaign starts, so that the event can be tracked and analyzed in Google Analytics.

Properties

Name Meaning
Property ID The identifier of the Google Analytics property where the key event will be created.
Query Parameters Optional additional parameters to customize the request, such as filters or pagination.
Request Body JSON object containing the details of the key event to create (e.g., event name, params).

Query Parameters Options

  • 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 items to return.
  • Page Token: Token for fetching next page.
  • 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).

Output

The node outputs a JSON array where each element corresponds to the response from the Google Analytics API for the create key event request. The JSON structure matches the API's response schema for a key event resource, typically including fields like the event's unique ID, name, 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/v1beta.
  • Proper permissions on the Google Analytics property are necessary to create key events.

Troubleshooting

  • Missing Credentials Error: If the node throws "Missing Google Analytics API Credentials," ensure that you have set up and selected valid OAuth2 credentials for Google Analytics.
  • Required Parameter Errors: Errors like "Property ID is required" indicate missing mandatory inputs; verify all required fields are filled.
  • API Errors: Errors returned by the Google Analytics API will be wrapped and shown with the message prefix "Error calling Google Analytics API." Check the error details for issues like permission denied, invalid request body, or quota limits.
  • Invalid JSON in Request Body: Ensure the JSON provided in the Request Body field is well-formed and matches the expected schema for a key event.

Links and References

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

Discussion