収益のエクスポート要求を作成する

この API を使用して、新しい収益と基になるトランザクション/支払いデータエクスポート要求をキューに入れ、収益とトランザクションのデータをスライスおよびサイコロにするオプションのフィルターを使用します。 202 HTTP 状態と要求 ID が返されます。これを使用して、キューに入ったトランザクション エクスポート要求の状態をチェックするためにポーリングできます。

トランザクション/収益の新しいエクスポート要求をキューに登録するために、API エンドポイントに POST 要求を送信します。

REST 要求

要求パラメーター

$filter クエリ パラメーターは、エクスポート操作を作成するための省略可能なパラメーターです。 ただし、エクスポート レポートのパフォーマンスを向上させ、可用性を向上させるには、$filtersを使用することを強くお勧めします。 エクスポート操作の一部として使用できる主要な属性フィルターの一部を次に示します。

複数の要求パラメーターを含むサンプル トランザクション履歴フィルター:

”?$filter=earningForDate ge 2019-01-27T23:16:31.009Z and earningForDate le 2019-09-25T23:16:31.009Z and (enrollmentParticipantId eq 'XXXXXXX') and (programName eq ‘Microsoft Commerce Incentives’) and (payableSubType eq 'REBATE') and (paymentId eq '000000000000') and (engagementName eq 'Azure Enterprise and Self-Service Incentive' or engagementName eq 'Azure CSP motion incentives - Indirect Provider') and (leverCode eq ‘Azure Enterprise and Self-Service Motion’) and (payoutStatus eq 'SENT')”

要求ヘッダー

詳細については、パートナー センターの REST ヘッダーを参照してください 。

要求本文

該当なし。

API 応答

HTTP/1.1 202 Accepted

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

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

状態に使用できる値

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

サンプル応答

{
    "value": [
        {
            "requestId": "93c2b3cf-c6d8-4e7e-ade1-007768a6eba4",
            "requestDateTime": "2023-05-25T21:20:46.3727561Z",
            "requestPath": "/v1.0/payouts/transactionhistory",
            "requestQueryString": "earningForDate ge 2023-03-01 and earningForDate le 2023-04-12",
            "blobLocation": "",
            "status": "Queued"
        }
    ],
    "nextLink": null,
    "totalCount": 1
}

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

要求に応じて、API は他の標準状態を返すことができます。