Actions2
Overview
This node downloads and optionally parses financial reports from the Apple App Store Connect API. It is designed to retrieve either summary financial reports or detailed financial reports for a specified vendor, date, and region.
Common scenarios where this node is beneficial include:
- Automating the retrieval of monthly financial data for app sales and in-app purchases.
- Integrating Apple App Store financial data into business intelligence or accounting workflows.
- Parsing detailed transaction-level data for deeper analysis of sales performance by country or currency.
For example, a user can configure the node to download the financial report for vendor number "123456" for March 2024 across all regions, then parse and extract structured JSON data representing sales quantities and partner shares.
Properties
| Name | Meaning |
|---|---|
| Report Type | The type of financial report to download: "Financial Report" (summary) or "Financial Detail Report" (detailed). |
| Vendor Number | The unique identifier of the vendor whose report is being requested. |
| Report Date (YYYY-MM) | The year and month of the report in "YYYY-MM" format. |
| Region Code | The region code for the report, e.g., "ZZ" or "Z1" to represent all regions. |
| Options | Additional options: - Put Result in Field: The name of the output field where the parsed data will be stored (default: "report"). |
Output
The node outputs an array of items corresponding to each input item processed.
For the Download operation:
- Outputs binary data containing the raw TSV report file.
- The binary data is available under the key
reportwith a filename likereport_YYYY-MM.tsv.
For the Download & Parse operation:
- Outputs JSON data structured based on the report type:
- For Financial Detail Reports:
<result_field>_meta: An object with metadata key-value pairs extracted from the report header.<result_field>_detailed: An array of objects representing detailed transaction rows.<result_field>_aggregated: An array of aggregated data objects summarizing quantities and partner shares by country and currency.
- For Financial Reports (summary):
<result_field>_detailed: An array of objects representing detailed rows.<result_field>_aggregated: An array of aggregated summary rows.
- For Financial Detail Reports:
- Outputs JSON data structured based on the report type:
The exact output field name defaults to "report" but can be customized via the "Put Result in Field" option.
Dependencies
- Requires an API authentication token credential for Apple App Store Connect API access.
- Uses the following npm packages bundled within the node:
axiosfor HTTP requests.jsonwebtokenfor creating JWT tokens used in API authorization.zlibfor decompressing the downloaded gzip report files.
- No additional environment variables are required beyond the configured API credentials.
Troubleshooting
- API Authentication Errors: If the API token is invalid or expired, the node will throw an error when attempting to fetch the report. Ensure the API credentials are correctly configured and have the necessary permissions.
- Report Not Found: If the specified report date, vendor number, or region code does not correspond to an available report, the API may return a 404 or empty response. Verify the input parameters.
- Parsing Issues: If the report format changes or contains unexpected data, parsing may fail or produce incomplete results. Check the raw downloaded report to diagnose formatting issues.
- Network Errors: Connectivity problems or rate limiting by the Apple API can cause request failures. Retry after some time or check network settings.