転送元 - App Store Connect API
    • PDF

    転送元 - App Store Connect API

    • PDF

    記事の要約

    概要

    App Storeからレポートデータを転送する設定のヘルプページです。

    取得可能なデータ

    App Store Connect APIを利用してデータを取得しています。

    「財務報告」、「売上とトレンド」に基づいたレポートのほか、アプリ内購入情報やそのローカライゼーション情報など、App Store Connect APIを通じて提供されるさまざまなデータを取得できます。

    それぞれ、App Store Connectの「支払と財務報告」「売上とトレンド」などからダウンロードできるレポートと同一のものが連携可能です。

    ※売上とトレンドのヘルプページはこちらです。
    ※財務報告のヘルプページはこちらです。

    設定項目

    STEP1 基本設定

    項目名必須デフォルト値内容
    App Store Connect API接続情報Yes-あらかじめ登録してある接続情報から、今回の転送設定に必要な権限を持つものを選択します。
    API EndpointYes-APIの接続先URLを指定します。
    パスパラメータの値はカスタム変数を利用しTROCCOのデータ転送時に動的に設定値を決定することも可能です。
    入力ファイル形式YesCSV/TSV入力ファイルの形式を指定してください。
    詳しくは、入力ファイル形式の設定についてを参照ください。
    クエリパラメータNo-APIへのリクエストに含めるクエリパラメータを指定できます。
    パラメータの種類については下記のクエリパラメータの種類をご覧ください。
    また、パラメータの値はカスタム変数を利用しTROCCOのデータ転送時に動的に設定値を決定することも可能です。

    クエリパラメータの種類

    取得するレポートの種類(API EndpointのURL)によって指定できるパラメータが異なります。
    詳しくは、下記API Endpointのリンク(公式ドキュメント)をご参照ください。

    財務報告(Finance Reports)

    パラメータ名必須内容
    filter[regionCode]Yes通貨の単位を指定できます。コードについては公式ドキュメントをご覧ください。
    filter[reportDate]YesApple Fiscal Calendarに基づいて取得するレポートの日付を指定できます。 YYYY-MM形式で指定してください。
    filter[reportType]YesレポートタイプとしてFINANCIALまたはFINANCE_DETAILを指定できます。
    filter[vendorNumber]Yesベンダー番号を指定できます。詳しくは公式ドキュメントをご覧ください。

    売上とトレンド(Sales and Trends Reports)

    パラメータ名必須内容
    filter[frequency]Yesレポートの取得間隔を指定できます。
    DAILYWEEKLYMONTHLYYEARLYが指定できます。
    filter[reportType]YesレポートタイプとしてSALESPRE_ORDERNEWSSTANDSUBSCRIPTIONSUBSCRIPTION_EVENTSUBSCRIBERを指定できます。
    filter[reportSubType]YesレポートのサブタイプとしてSUMMARYDETAILEDOPT_INを指定できます。
    filter[vendorNumber]Yesベンダー番号を指定できます。
    詳しくは公式ドキュメントをご覧ください。
    filter[reportDate]No取得するレポートの日付を指定できます。
    YYYY-MM-DD形式で指定してください。
    詳しくは公式ドキュメントをご覧ください。
    filter[version]Noレポートのバージョンを指定できます。
    詳しくは公式ドキュメントをご覧ください。

    アプリ内購入情報

    パラメータ名必須内容
    fields[inAppPurchaseAppStoreReviewScreenshots]NoApp Store審査用スクリーンショットの情報を含めることができます。
    fields[inAppPurchaseContents]No購入内容に関する詳細情報を含めることができます。
    fields[inAppPurchaseLocalizations]No各ローカライズ情報(タイトルや説明など)を含めることができます。
    fields[inAppPurchases]No購入アイテムの基本情報を含めることができます。
    fields[promotedPurchases]Noプロモーション設定された購入情報を含めることができます。
    fields[inAppPurchasePriceSchedules]No購入アイテムの価格スケジュール情報を含めることができます。
    fields[inAppPurchaseAvailabilities]No購入アイテムの提供可否情報を含めることができます。
    fields[inAppPurchaseImages]No購入アイテムに関連付けられた画像情報を含めることができます。
    filter[inAppPurchaseType]No購入種別(PURCHASE、SUBSCRIPTIONなど)を指定してフィルタリングできます。
    filter[name]No名前を指定してフィルタリングできます。
    filter[productId]NoプロダクトIDを指定してフィルタリングできます。
    filter[state]No購入アイテムの状態(審査状況など)を指定してフィルタリングできます。
    includeNo関連リソース(例: localizations)を同時に取得します。
    limitNo結果の最大取得件数を指定できます。
    limit[inAppPurchaseLocalizations]Noローカライズ情報の最大取得件数を指定できます。
    limit[images]No画像情報の最大取得件数を指定できます。
    sortNo並び順を指定できます(例: -id で降順)。

    購入情報ローカライゼーション

    パラメータ名必須内容
    fields[inAppPurchaseLocalizations]Noローカライズ情報(タイトルや説明など)を取得するためのフィールドを指定できます。
    fields[inAppPurchases]No紐づく購入情報の基本項目を含めることができます。
    includeNo関連リソース(例: inAppPurchases)を同時に取得します。
    limitNo最大取得件数を指定できます。

    この記事は役に立ちましたか?