コンテナー用 Product Ingestion API

[アーティクル]
06/14/2024

Product Ingestion API は、すべてのコマーシャルマーケットプレース製品にわたって既存のすべての申請 API を統合する最新化された API です。開始方法の詳細については、 Product Ingestion API を参照してください。

この記事では、コンテナー専用の API を使用する方法に関するガイダンスを提供します。

既存のリソース構成を取得する

1 回の API 呼び出しで、特定の製品内のすべてのリソースを取得します。

GET resource-tree/<product-durableID>?$version=<schema-version>

"resource-tree" リソースの種類と製品の永続 ID を使用して、特定の製品内のすべてのリソース構成を取得できます。指定したスキーマバージョンは、要求された製品の該当する各リソースでサポートされている最大バージョンとして使用されます。

Note

製品の永続 ID がわからない場合は、代わりに製品の外部 ID を使用して実行することで、まず製品リソースを取得できます。詳細については、「 Product API: 方法 1: リソースツリー」を参照してください。

GET 呼び出しの例:

GET https://graph.microsoft.com/rp/product-ingestion/resource-tree/product/12345678-abcd-efgh-1234-12345678901?targetType="preview"&$version=2022-03-01-preview5

応答の例:

{
  "$schema": "https://schema.mp.microsoft.com/schema/resource-tree/2022-03-01-preview2",
  "root": "product/12345678-abcd-efgh-1234-12345678901",
  "target": {
    "targetType": "preview"
  },
  "resources": [
  { 
    "$schema": "https://schema.mp.microsoft.com/schema/product/2022-03-01-preview3",
    "id": "product/12345678-abcd-efgh-1234-12345678901",
    "identity": {
      "externalID": "product_external_id_example"
    },
    "type": "azureContainer",
    "alias": "product_example"
  },
  { 
    "$schema": "https://schema.mp.microsoft.com/schema/commercial-marketplace-setup/2022-03-01-preview2",
    "id": "commercial-marketplace-setup/12345678-abcd-efgh-1234-12345678901",
    "product": "product/12345678-abcd-efgh-1234-12345678901",
    "sellThroughMicrosoft": true
  },
  {
    "$schema": "https://schema.mp.microsoft.com/schema/plan/2022-03-01-preview2",
    "id": "plan/12345678-abcd-efgh-1234-12345678901/98756328-04e9-55ae-9403-52b6c971a956
  ...
  }, 
     // The response would include all existing resources within this product.
  {
     ...
  }]
}

プライベート対象ユーザーを同期する

ライブ製品の場合、ドラフト、プレビュー、ライブ環境のプライベート対象ユーザーに対する更新は、公開を必要とせずに同時に実行できます。特定のプランに追加または削除する対象ユーザーを指定することで、"price-and-availability-update-private-audience" リソースを使用してプライベート対象ユーザーを同期できます。これにより、ドラフト、プレビュー、ライブ環境が同期され、プライベート対象ユーザーの値が同じになります。プライベート対象ユーザーを同期するときに、申請リソースを指定する必要はありません。

ドラフト対象ユーザーを編集するには、"price-and-availability-plan" リソースと "privateAudiences" プロパティを使用します。これは、プレビューとライブで設定する値の通常の発行フローを通過する必要があります。

重要

プライベート対象ユーザーを構成するために複数の種類の識別子 (テナント ID とサブスクリプション ID の両方など) が製品でサポートされている場合は、完全発行を実行する必要があります (初めて新しい識別子の種類を指定する場合)。この場合、プライベート対象ユーザーを同期することはできません。

プライベート対象ユーザー構成を同期するためのサンプル要求: