XCode 16.2 日本語化計画
Web Service Endpoint
Get Transaction History
(取引履歴を取得する)あなたのアプリの顧客のアプリ内購入取引履歴を取得します。
App Store Server API 1.12+
URL
Sandbox URL
パスパラメータ
| transactionId transactionId | (必須) 顧客に属する取引の ID。元の取引 ID である場合もある。(originalTransactionId) |
問い合わせパラメータ
| revision revision | 次の最大 20 件の取引セットを取得するためにあなたが提供するトークン。すべての応答にはrevision トークンが含まれます。前の HistoryResponse の revision トークンを使用します。 |
| 注: rivision トークンは、最初の要求を除くすべての要求に必要です。revision トークンを使用する要求の場合は、最初の要求と同じ問い合わせパラメータを含めます。 | |
| startDate startDate | あなたが要求している取引履歴レコードの期間の開始日（オプション）。両方の日付を指定する場合、startDate は endDate より前である必要があります。purchaseDate が startDate 以上の場合、結果には取引が含まれます。 |
| endDate endDate | あなたが要求する取引履歴レコードの期間の終了日 (オプション)。両方の日付を指定する場合は、startDate より後の endDate を選択します。将来の endDate を使用することは有効です。purchaseDate が endDate より小さい場合、取引が結果に含まれます。 |
| productId [productId] | 取引履歴に含めるべき製品 ID を示すオプションのフィルター。あなたの問い合わせでは複数の productID を指定できます。 |
| productType [string] | 取引履歴に含めるべき製品型を示すオプションのフィルター。あなたの問い合わせでは複数の productType を指定できます。 可能な値：AUTO_RENEWABLE, NON_RENEWABLE, CONSUMABLE, NON_CONSUMABLE |
| inAppOwnershipType inAppOwnershipType | アプリ内の所有権型によって取引履歴を制限するオプションのフィルター。 |
| sort string | 取引履歴レコードのオプションの並べ替え順序。応答では、取引レコードが最近変更された日付で並べ替えられます。デフォルト値は ASCENDING なので、最も古いレコードが最初に表示されます。 可能な値: ASCENDING, DESCENDING |
| revoked boolean | 応答に、値が true の場合に取り消された取引のみが含まれるか、値が false の場合には取り消されていない取引のみが含まれるかを示すオプションのブール値。デフォルトでは、要求にはこのパラメータは含まれません。 可能な値: true, false |
| subscriptionGroup Identifier [subscriptionGroup Identifier] | 取引履歴に含めるべきサブスクリプショングループ ID を示すオプションのフィルター。あなたの問い合わせでは、複数の subscriptionGroupIdentifier を指定できます。 |
boolean | 廃止 取り消された取引を代わりに除外するには、revoked を false に設定します。 |
反応コード
InvalidAppIdentifierError
| 200 HistoryResponse | OK 要求は成功した。 Content-Type: application/json |
| 400 (InvalidAppIdentifier Error | InvalidRequest RevisionError | Invalid TransactionIdError | InvalidSortError | InvalidStartDateError | InvalidEndDateError | InvalidProductTypeError | InvalidProductIdError | InvalidSubscription GroupIdentifierError | InvalidInAppOwnership TypeError | Invalid ExcludeRevokedError | InvalidRevokedError) | 不正な要求 無効な要求です。 Content-Type: application/json |
| 401 | 未承認 承認ヘッダ内の JSON Web トークン (JWT) が無効です。詳細については、API 要求用の JSON Web トークンの生成 を参照して下さい。 |
| 404 (AccountNotFoundError | AccountNotFoundRetryable Error | AppNotFoundError | AppNotFoundRetryable Error | TransactionIdNot FoundError) | 見つからない Content-Type: application/json |
| 429 RateLimitExceededError | 要求がレート制限を超えました。 Content-Type: application/json |
| 500 (GeneralInternalError | GeneralInternalRetryable Error) | 内部サーバーエラー サーバーエラーです。しばらくしてからもう一度お試しください。 Content-Type: application/json |
以下で言及
議論
Get Transaction History エンドポイントは、自動更新サブスクリプション、非更新サブスクリプション、非消耗品、消耗品など、すべてのアプリ内購入製品型の結果を返します。結果は、返金または取り消された取引、アプリが完了としてマークした取引、またはマークしていない取引など、あらゆる状態の取引を返します。
取引履歴をフィルターするクエリ(query,問い合わせ) パラメータを含めることで、あなたの要求をカスタマイズできます。クエリパラメータは、日付、製品 ID、製品型、およびサブスクリプショングループ ID によって要求の範囲を制限します。取り消された取引または取り消されていない取引を除外したり、アプリ内所有権の型によって取引を制限したりすることもできます。クエリで複数のフィルタを提供した場合、返される取引はすべてのフィルタと一致します。
並び替え順序も指定できます。App Store は、最近変更された日付に基づいて取引を並び替えます。最新の取引を最初に取得するには、DESCENDING (降順) を使用します。顧客がサブスクリプションをアップグレードするか、App Store がアプリ内購入を取り消すと、App Store は最近変更された日付を更新します。取引履歴の受信中に取引が更新され、応答が ASCENDING (昇順) で並び替えられている場合、更新されたデータで取引を再度受信することがあります。
productId、productType、subscriptionGroupIdentifier のクエリパラメータを使用すると、複数の値を指定できます。クエリパラメータに複数の値を指定するには、そのパラメータを要求に複数回含めます。たとえば、非消耗型および自動更新型の製品型で取引履歴をフィルター処理するには、あなたの要求に以下の内容を含めます。
1 つのクエリパラメータに複数の値を指定すると、応答にはいずれかの値に一致する取引が含まれます。
注意
あなたがオプションのクエリパラメータを使用する場合は、revision パラメータを含む後続の要求でも同じクエリパラメータを使用するようにしてください。あなたのアプリの完全な取引履歴を昇順で要求するには、まず以下のようにクエリパラメータなしでエンドポイントを呼び出します。
後続の要求には、以前の HistoryResponse からの revision トークンを含めます。
以下も見よ
アプリ内購入履歴
object HistoryResponse
アプリに関する顧客の取引履歴が含まれる応答。
終了した消耗品のアプリ内購入を除く、あなたのアプリの顧客のアプリ内購入取引履歴を取得します。
廃止
トップへ
トップへ
トップへ
トップへ
トップへ
トップへ
トップへ
トップへ
トップへ
トップへ
トップへ
トップへ
トップへ
トップへ
トップへ
トップへ
トップへ