Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API
Join our community

Actions57

Overview

This node interacts with the Adobe Analytics API to manage component metadata tags, specifically supporting the "Save Tags" operation under the "Component Meta Data" resource. It allows users to save (add or update) tags associated with components in their Adobe Analytics environment. This is useful for organizing and categorizing components such as dimensions, metrics, or segments by tagging them, which facilitates easier searching, filtering, and management within Adobe Analytics.

Practical scenarios include:

  • Tagging multiple components at once to categorize them by project, team, or purpose.
  • Updating existing tags on components to reflect changes in business context.
  • Automating tag management workflows to maintain consistent metadata across reports and dashboards.

Properties

Name Meaning
Global Company ID The unique identifier of the company in Adobe Analytics where the operation will be performed.
Query Parameters A collection of optional parameters to filter or modify the request. For "Save Tags" operation, these are generally unused but available for other operations.
Request Body JSON object containing the details of the tags to save. This typically includes the component IDs, tag names, and any other relevant tag metadata required by the Adobe Analytics API to perform the save operation.

Output

The output is a JSON array representing the response from the Adobe Analytics API after attempting to save the tags. The structure depends on the API's response but generally includes confirmation of saved tags or error information if the operation failed.

If the API returns a string response, the node attempts to parse it as JSON; otherwise, it outputs the raw text or a status code message like "204 No Content" if no content is returned.

No binary data output is involved in this operation.

Dependencies

  • Requires an Adobe Analytics API credential configured in n8n with client ID, client secret, and scope.
  • The node obtains an OAuth access token via Adobe's IMS token endpoint before making API calls.
  • Network connectivity to Adobe Analytics API endpoints is necessary.

Troubleshooting

  • Missing Credentials: If the Adobe Analytics API credentials are not set or invalid, the node throws an error "Missing Adobe Analytics API Credentials".
  • Access Token Retrieval Failure: If the node cannot retrieve an access token, it throws "Failed to retrieve access token". Ensure credentials are correct and have proper permissions.
  • Required Parameter Missing: For this operation, if required parameters like globalCompanyId or the request body are missing or malformed, the API call may fail.
  • API Errors: Any errors returned by the Adobe Analytics API are wrapped and thrown as node errors with messages prefixed by "Error calling Adobe Analytics API".
  • Invalid JSON in Request Body: The request body must be valid JSON; otherwise, parsing errors will occur.

To resolve issues:

  • Verify that all required input properties are provided and correctly formatted.
  • Check that the Adobe Analytics API credentials are valid and have sufficient permissions.
  • Review the request body JSON structure to match Adobe Analytics API expectations for saving tags.
  • Inspect error messages and stack traces for clues on API response errors.

Links and References

This summary focuses on the "Save Tags" operation of the "Component Meta Data" resource based on the provided source code and property definitions.

Discussion