Actions57
- Annotation Actions
- Calculated Metric Actions
- Component Meta Data Actions
- Add Tags
- Delete Multiple Tags
- Delete One Tag
- Delete Shared Component
- Get Shared Component
- Get Tag
- List Shared Components by the User
- List Shared Components to the User
- List Tag Names
- List Tags
- Save Tags
- Search Shared Components
- Search Tags for Multiple Components
- Search Tags for One Component
- Share Component with Multiple User
- Share Component with One User
- Date Range Actions
- Dimension Actions
- Metric Actions
- Project Actions
- Report Actions
- Segment Actions
- Usage Log Actions
- User Actions
Overview
This node interacts with the Adobe Analytics API to retrieve and manage metadata related to components, including shared components. Specifically, the "Get Shared Component" operation fetches detailed information about a particular shared component by its ID within a specified global company context.
Use cases for this node include:
- Retrieving metadata details of a shared component to understand its properties or usage.
- Integrating Adobe Analytics shared component data into workflows for reporting or auditing.
- Automating management tasks involving shared components in Adobe Analytics environments.
For example, you might use this node to get details about a shared calculated metric or segment that has been shared across teams, enabling automated validation or synchronization processes.
Properties
| Name | Meaning |
|---|---|
| Global Company ID | The unique identifier of the global company under which the shared component exists. This is required to scope the API request correctly. |
| Shared Component ID | The unique identifier of the shared component to retrieve. This identifies the specific shared component whose details are requested. |
| Query Parameters | Optional parameters to refine or filter the request. These include various filters and options such as: - Approved (boolean): Include only approved calculated metrics. - Classifiable (boolean): Include classifiable dimensions. - Component ID(s) (string): One or multiple component IDs. - Component Type (string): Filter by component type. - Date range filters (startDate, endDate). - Pagination controls (limit, page, pagination). - Sorting options (sortProperty, sortDirection). - Locale (string): Language/locale for returned data. - And many others for filtering by events, tags, owners, etc. |
Output
The output is a JSON array where each item corresponds to the response from the Adobe Analytics API for the requested shared component. The structure typically includes detailed metadata fields describing the shared component, such as its ID, type, associated tags, sharing information, and other relevant attributes.
If the API returns no content (e.g., on deletion), the output will indicate a "204 No Content" status.
No binary data output is produced by this operation.
Dependencies
Requires an Adobe Analytics API credential configured in n8n, providing:
- Client ID
- Client Secret
- Scope for API access
The node performs OAuth2 client credentials flow to obtain an access token before making API requests.
Network access to Adobe Analytics API endpoints (
https://analytics.adobe.ioandhttps://ims-na1.adobelogin.com) is necessary.
Troubleshooting
Missing Credentials Error: If the node throws "Missing Adobe Analytics API Credentials," ensure that the Adobe Analytics API credential is properly set up in n8n with valid client ID, secret, and scope.
Failed to Retrieve Access Token: Indicates issues with authentication; verify credentials and network connectivity to Adobe IMS token endpoint.
Required ID Missing: For this operation, if the Shared Component ID or Global Company ID is empty, the node will throw an error indicating the missing required parameter. Ensure these inputs are provided.
API Errors: Any errors returned by the Adobe Analytics API will be wrapped and reported with the message prefix "Error calling Adobe Analytics API." Check the error description for details.
Empty or Unexpected Response: If the response is empty or not JSON, the node attempts to parse it; if parsing fails, raw text is returned. Verify the API request parameters and permissions.
Links and References
- Adobe Analytics API Documentation
- Adobe IMS Authentication
- n8n Documentation - Creating Custom Nodes
This summary focuses on the "Component Meta Data" resource and the "Get Shared Component" operation as requested.