Contents x
    Data Source - App Store Connect API
    • 27 Dec 2022
    • Print
    • Dark
      Light
    • PDF
    Contents

    Data Source - App Store Connect API

    • Updated on 27 Dec 2022
    • Print
    • Dark
      Light
    • PDF
    Article Summary

    Note

    This is a machine-translated version of the original Japanese article.
    Please understand that some of the information contained on this page may be inaccurate.

    Overview

    This is a help page for setting up transferring report data from the App Store.

    Importable Data

    We are retrieving data using the App Store Connect API.

    "Financial Report" and "Sales and Trends" can be obtained.
    Each report can be linked with the same reports that can be downloaded from "Payments and Financial Reports" and "Sales and Trends" in App Store Connect.

    * The help page for sales and trends is here.
    * The financial report help page is here.

    Supported Protocols

    Settings

    STEP 1: General Settings

    Field NameRequiredDefault ValueDescription
    App Store Connect API connection informationYes-From the connection information registered in advance, select the one that has the necessary permissions for this transfer setting.
    API EndpointYes-Specify the URL to connect to the API.
    Input file formatYes.CSVSpecifies the format of the input file.
    ・CSV
    ・JSON Lines
    ・JSONPath
    You can choose from:
    Query ParametersNo-You can specify query parameters to include in requests to the API.
    See Query parameter types below for parameter types.
    Parameter values can also be set dynamically during trocco data transfer using custom variables.

    Types of Query Parameters

    The parameters that can be specified differ depending on the type of report (API Endpoint URL) to be retrieved.
    Please refer to the official documentation for details.

    Finance Reports

    Parameter NameDescription
    filter[regionCode]You can specify the units of currency. See the official documentation for the code.
    filter[reportDate]You can specify the date of the report that you want to retrieve based on the Apple Fiscal Calendar. Specify it in YYYY-MM format.
    filter[reportType]You can specify FINANCIAL or FINANCE_DETAIL as the report type.
    filter[vendorNumber]You can specify a vendor number. For more information, please refer to the official documentation.

    Sales and Trends Reports

    Parameter NameDescription
    filter[frequency]You can specify the interval at which reports are retrieved.
    YOU CAN SPECIFY DAILY, WEEKLY, MONTHLY, OR YEARLY.
    filter[reportDate]You can specify the date of the report to retrieve.
    Specify it in YYYY-MM-DD format.
    For more information, please refer to the official documentation.
    filter[reportSubType]You can specify SUMMARY, DETAILED, and OPT_IN report subtypes.
    filter[reportType]YOU CAN SPECIFY SALES, PRE_ORDER, NEWSSTAND, SUBSCRIPTION, SUBSCRIPTION_EVENT, AND SUBSCRIBER REPORT TYPES.
    filter[vendorNumber]You can specify a vendor number.
    For more information, please refer to the official documentation.
    filter[version]You can specify the version of the report.
    For more information, please refer to the official documentation.
    Was this article helpful?
    What's Next