ID で収益のエクスポート要求を取得する

既存のキューに登録されたエクスポート要求の状態を取得します。

REST 要求

GET https://api.partner.microsoft.com/v1.0/payouts/transactionhistory/{transactionHistoryRequestId}

要求パラメーター

名前 / 必須 Type 説明
requestId クエリ ○ Guid エクスポート要求 ID

要求ヘッダー

名前 必須 Type 説明
承認 はい String 承認ベアラー トークン。
ms-correlationid いいえ String 内部要求トラッカー。 各要求では、新しいトラッカー (GUID) が生成されます。
ms-requestid いいえ String 要求のべき等 ID。

要求本文

該当なし。

応答ペイロード:

API は HTTP 状態 200 を返します。

要求に基づいて、API は Standard API 応答の状態に記載されている他の標準状態を返すことができます。

名前 説明
400 Bad Request データが見つからないか、正しくありません。
401 権限がありません 呼び出し元は認証されていないため、最初の呼び出しを行う前にパートナー API サービスで認証する必要があります。
403 許可されていません 呼び出し元は、要求を行う権限がありません。
500 内部サーバー エラー API またはその依存関係の 1 つが要求を満たすことができません。 後で再試行してください。
404 見つかりません 入力パラメーターではリソースを使用できません。
429 レート制限 同じ型の要求が多すぎます。 しばらくしてからお試しください。

API 応答ペイロードは、次の属性を返します。

名前 省略可能 説明
値 false 使用可能な値とアクションについては、次の表を参照してください。

使用可能な値とアクション

値 クライアント側の処理
requestId エクスポート要求の要求 ID。
requestDateTime エクスポート要求の開始日時。
requestPath エクスポート要求のクエリ パス。
requestQueryString エクスポート要求の一部として使用されるフィルター。
blobLocation エクスポート ファイルの準備ができたときにトークンを含む BLOB リソース。
Status エクスポート操作の状態。 状態に使用できる値の一覧を次に示します。

状態に使用できる値

  • キューに入っている: エクスポート操作が開始されていません
  • 処理: エクスポート操作が進行中です
  • 失敗: 再試行後にエクスポート操作が失敗し、新しい要求をキューに入れてみてください
  • 完了: エクスポート操作が完了し、エクスポート ファイルをダウンロードする準備ができました。