コマーシャル マーケットプレースのレポート API を取得する

この API は、スケジュールされているすべてのレポートを取得します。

要求構文

方式 要求 URI
GET https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport?reportId={Report ID}&reportName={Report Name}&queryId={Query ID}

要求ヘッダー

Header タイプ 説明
Authorization 文字列 必須。 フォーム内の Microsoft Entra アクセス トークン Bearer <token>
コンテンツタイプ 文字列 Application/JSON

Path パラメーター

None

クエリ パラメーター

パラメーター名 必須 タイプ 説明
reportId いいえ 文字列 この引数で指定された reportId を持つレポートのみの詳細を取得するには、フィルター処理します。 セミコロン (;) で区切ることで、複数の reportId を指定できます。
reportName いいえ 文字列 フィルターを使用して、この引数で指定された reportName を持つレポートのみの詳細を取得します
queryId いいえ ブーリアン 応答に定義済みのシステム クエリを含める

用語集

None

応答

応答ペイロードは、次のように JSON 形式で構成されます。

応答コード: 200、400、401、403、404、500

応答ペイロード:

{
  "Value": [
    {
      "ReportId": "string",
      "ReportName": "string",
      "Description": "string",
      "QueryId": "string",
      "Query": "string",
      "User": "string",
      "CreatedTime": "string",
      "ModifiedTime": "string",
      "StartTime": "string",
      "ReportStatus": "string",
      "RecurrenceInterval": 0,
      " RecurrenceCount": 0,
      "CallbackUrl": "string",
      "Format": "string"
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0
}

用語集

次の表に、応答内の要素のキー定義を示します。

パラメーター Description
ReportId 作成したレポートの汎用一意識別子 (UUID)
ReportName レポートの作成時に要求ペイロードに指定された名前
Description レポートの作成時に要求ペイロードに指定された説明
QueryId レポートの作成時に要求ペイロードに指定されたクエリ ID
Query このレポートに対して実行されるクエリ テキスト
User レポートの作成に使用されるユーザー ID
CreatedTime レポートが作成された UTC 時刻の形式: yyyy-MM-ddTHH:mm:ssZ
ModifiedTime レポートが最後に変更された UTC 時刻:yyyy-MM-ddTHH:mm:ssZ
ExecuteNow レポートの作成時に要求ペイロードに指定された ExecuteNow パラメーター
queryStartTime レポートの作成時に要求ペイロードに指定されたクエリの開始時刻。 これは、 ExecuteNow が "True" に設定されている場合にのみ適用されます
queryEndTime レポートの作成時に要求ペイロードに指定されたクエリの終了時刻。 これは、 ExecuteNow が "True" に設定されている場合にのみ適用されます
StartTime レポートの作成中に要求ペイロードに指定された開始時刻
ReportStatus レポート実行の状態。 指定できる値は 、Paused、 Active、 および Inactive です。
RecurrenceInterval レポートの作成中に要求ペイロードに指定された繰り返し間隔
RecurrenceCount レポートの残りの繰り返し数
CallbackUrl レポートの作成時に要求ペイロードに指定されたコールバック URL
CallbackMethod レポートの作成時に要求ペイロードで提供されるコールバック メソッド
Format レポートの作成時に要求ペイロードに指定されたレポート ファイルの形式
EndTime レポートの作成中に要求ペイロードに指定された終了時刻。 これは、 ExecuteNow が "True" に設定されている場合にのみ適用されます
TotalRecurrenceCount RecurrenceCount レポートの作成時に要求ペイロードに指定された
nextExecutionStartTime 次のレポートの実行が開始される UTC タイムスタンプ
TotalCount Value 配列内のレコードの数
StatusCode 結果コード。 指定できる値は、200、400、401、403、500 です。
message API の実行からのステータス メッセージ
  • Last updated on