ウォレットトランザクション合計
このエンドポイントは、個々のトランザクションではなく、指定した日付範囲におけるウォレット金額の合計を返します。ウォレットトランザクション一覧 をページングして金額を自分で集計する代わりに、合計値が必要な場合に使用してください。
エンドポイント
| メソッド | URL |
|---|---|
| GET | https://ws.catappult.io/api/wallet/transactionsTotals |
認証
この API にアクセスするには、Aptoide Connect でアクティブなアカウントサブスクリプションを保有し、API キーで認証する必要があります (生成方法についてはこちらを参照してください)。
ヘッダー
| ヘッダー | 型 | 必須 | 説明 |
|---|---|---|---|
Api-Key | string | 必須 | API リクエストの認証に使用されます。値は Aptoide Connect API キーです。 |
クエリパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
from | string (YYYY-MM-DD) | 必須 | 期間の開始日。例: 2024-01-01。 |
to | string (YYYY-MM-DD) | 必須 | 期間の終了日。例: 2024-01-31。 |
packageName | string | 任意 | アプリのパッケージ名で結果をフィルタリングします。例: com.example.test。 |
countryCode | string | 任意 | ISO 3166-1 alpha-2 形式の国コードで結果をフィルタリングします。例: PT。 |
operatingSystem | string | 任意 | プラットフォームで結果をフィルタリングします。指定可能な値: android、ios。 |
type | string | 任意 (デフォルト: all) | トランザクション種類で結果をフィルタリングします。指定可能な値: all、debit、credit。 |
paymentMethod | string | 任意 | 結果をサンドボックスのテスト購入に限定します。受け付けられる値は sandbox のみです。 |
amountType | string | 任意 (デフォルト: wallet) | 純額と総額のどちらを返すかを指定します。指定可能な値: wallet (純額、ウォレットに入金される金額) または global (総額)。 |
レスポンス
成功
API 呼び出しが HTTP 200 ステータスコードを返した場合、リクエストは成功であり、指定した範囲の合計額が USD で返されます。
| フィールド | 型 | 説明 |
|---|---|---|
iap | object | アプリ内購入収益。{ "usd": number } 形式です。 |
credit | object | ウォレットへの入金合計。{ "usd": number } 形式です。 |
debit | object | ウォレットからの出金合計。{ "usd": number } 形式です。 |
レスポンス例
{
"credit": {
"usd": 103.8
},
"debit": {
"usd": 0
},
"iap": {
"usd": 103.8
}
}
💡
純額と総額は異なる数値です
デフォルトでは、これらは VAT とレベニューシェアを差し引いた後にウォレットへ入金される金額です。amountType=global を指定すると、VAT を含む消費者の総支出額が返され、これは大幅に大きな数値になります。その差は購入者の国によって変動するため、global の合計とデフォルトの合計を比較して、その差額を未入金の収益とみなさないでください。
エラー
| コード | HTTP ステータス | 説明 | 対処方法 |
|---|---|---|---|
| — | 401 Unauthorized | API キーが認識されませんでした | キー、およびアカウントが承認済みかを確認してください |
SUBSCRIPTION-REQUIRED | 402 Payment Required | アクティブなアカウントサブスクリプションがありません | アカウントのサブスクリプションを有効化してください |
DAILY-QUOTA-REACHED | 429 Too Many Requests | 1 日のリクエスト上限を超過しました | UTC 午前 0 時に上限がリセットされた後に再試行してください |