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

  • [アーティクル]

レポート クエリの取得 API では、レポートで使用できるすべてのクエリが取得されます。 既定では、すべてのシステムおよびユーザー定義クエリが取得されます。

要求構文

Method 要求 URI
GET https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledQueries?queryId={QueryID}&queryName={QueryName}&includeSystemQueries={include_system_queries}&includeOnlySystemQueries={include_only_system_queries}

要求ヘッダー

ヘッダー Type 説明
承認 string 必須。 フォーム内の Microsoft Entra アクセス トークン Bearer <token>
コンテンツタイプ string Application/JSON

パス パラメーター

なし

クエリ パラメーター

パラメーター名 Type 必須 説明
queryId string いいえ 引数で指定された ID を持つクエリのみの詳細を取得するフィルター
queryName string いいえ 引数で指定された名前を持つクエリのみの詳細を取得するフィルター
IncludeSystemQueries boolean いいえ 応答に定義済みのシステム クエリを含めます。 既定値は True です。
IncludeOnlySystemQueries boolean いいえ 応答にシステム クエリのみを含めます。 既定値は False です

要求ペイロード

なし

用語集

なし

回答

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

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

応答ペイロード:

{
  "Value": [
    {
      "QueryId": "string",
      "Name": "string",
      "Description": "string",
      "Query": "string",
      "Type": "string",
      "User": "string",
      "CreatedTime": "string",
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0
}

用語集

次の表では、応答内の要素の主な定義を示しています。

パラメーター 説明
QueryId クエリの一意の UUID
Name クエリの作成時にクエリに指定された名前
Description クエリの作成時に指定された説明
Query レポート クエリ文字列
Type ユーザーが作成したクエリの場合は userDefined に、定義済みのシステム クエリの場合は system に設定します
User クエリを作成したユーザーの ID
CreatedTime クエリの作成時刻
TotalCount Value 配列内のデータセットの数
StatusCode 結果コード。 200、400、401、403、500 の値になる可能性があります