配送ラベルのデータを取得する

Microsoft ハードウェア API の概要と、API 使用の前提条件などについては、API を使用したハードウェア申請の管理をご覧ください。

Microsoft ハードウェア API で次のメソッドを使用して、ハードウェア デベロッパー センター アカウントに登録されているハードウェア製品の出荷ラベルのデータを取得します。

https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/

これらのメソッドを使用する前に、デベロッパー センター アカウントに製品と申請が既に存在している必要があります。 製品の申請を作成または管理する方法については、製品申請の管理の手順をご覧ください。

前提条件

まだ行っていない場合は、これらのメソッドのいずれかを使用する前に、Microsoftハードウェア API のすべての Prerequisites を完了してください。

データ リソース

出荷ラベル データを取得するための Microsoft ハードウェア ダッシュボード API メソッドでは、次の JSON データ リソースを使用します。

ShippingLabelリソース

このリソースは、アカウントに登録されている製品の申請用に作成された配送先住所ラベルを表します。

{
  "id": 1152921504606978422,
  "productId": 14461751976964157,
  "submissionId": 1152921504621467613,
  "publishingSpecifications": {
    "goLiveDate": "2018-04-12T05:28:32.721Z",
    "visibleToAccounts": [
      27691110, 27691111
    ],
    "isAutoInstallDuringOSUpgrade": true,
    "isAutoInstallOnApplicableSystems": true,
    "isDisclosureRestricted": false,
    "publishToWindows10s": false,
    "additionalInfoForMsApproval": {
      "microsoftContact": "abc@microsoft.com",
      "validationsPerformed": "Validation 1",
      "affectedOems": [
        "OEM1", "OEM2"
      ],
      "isRebootRequired": false,
      "isCoEngineered": true,
      "isForUnreleasedHardware": true,
      "hasUiSoftware": false,
      "businessJustification": "This is a business justification"
    }
  },
  "recipientSpecifications": {
    "receiverPublisherId": "27691110",
    "enforceChidTargeting": true,
    "blockDuaCreation": false
  },
  "targeting": {
    "hardwareIds": [
      {
        "bundleId": "amd64",
        "infId": "foo.inf",
        "operatingSystemCode": "WINDOWS_v100_SERVER_X64_RS5_FULL",
        "pnpString": "hid\\vid_dummy256f&pid_dummyc62f",
        "distributionState": "pendingAdd"
      }
    ],
    "chids": [
      {
        "chid": "346511cf-ccee-5c6d-8ee9-3c70fc7aae83",
        "distributionState": "pendingAdd"
      }
    ],
    "restrictedToAudiences": [
      "00000000-0000-0000-0000-000000000000",
      "00000000-0000-0000-0000-000000000001"
      ],
    "inServicePublishInfo": {
      "flooring": "RS1",
      "ceiling": "RS3"
    },
    "coEngDriverPublishInfo": {
      "flooringBuildNumber": 17135,
      "ceilingBuildNumber": 17139
    }  
  },
  "workflowStatus": {
    "currentStep": "finalizePublishing",
    "state": "completed",
    "messages": [],
    "errorReport": ""
  },
  "links": [
    {
      "href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606978422",
      "rel": "self",
      "method": "GET"
    }
  ],
  "name": "Shipping Label Name",
  "destination": "windowsUpdate"
}

このリソースには、次の値があります。

公開仕様オブジェクト

このオブジェクトは、オブジェクトをWindows Updateに発行する方法の仕様を表します。 このオブジェクトは、配送先ラベルの宛先が windowsUpdate の場合にのみ使用できます。

{
  "goLiveDate": "2018-04-12T05:28:32.721Z",
  "visibleToAccounts": [
    27691110,
    27691111
  ],
  "isAutoInstallDuringOSUpgrade": true,
  "isAutoInstallOnApplicableSystems": true,
  "isDisclosureRestricted": false,
  "publishToWindows10s": false,
  "additionalInfoForMsApproval": {
    "microsoftContact": "abc@microsoft.com",
    "validationsPerformed": "Validation 1",
    "affectedOems": [
      "OEM1",
      "OEM2"
    ],
    "isRebootRequired": false,
    "isCoEngineered": true,
    "isForUnreleasedHardware": true,
    "hasUiSoftware": false,
    "businessJustification": "This is a business justification"
  }
}

このオブジェクトの値は次のとおりです。

Microsoft オブジェクトの追加情報

このオブジェクトは、出荷ラベルを確認するためにMicrosoftに必要な追加情報を表します。 このオブジェクトは、配送 先 ラベルの宛先が windowsUpdate で、配送先ラベルが isAutoInstallDuringOSUpgrade または isAutoInstallOnApplicableSystems としてマークされている場合にのみ使用できます。

{
    "microsoftContact": "abc@microsoft.com",
    "validationsPerformed": "Validation 1",
    "affectedOems": [
      "OEM1",
      "OEM2"
    ],
    "isRebootRequired": false,
    "isCoEngineered": true,
    "isForUnreleasedHardware": true,
    "hasUiSoftware": false,
    "businessJustification": "This is a business justification"
}

このオブジェクトの値は次のとおりです。

受信者仕様オブジェクト

このオブジェクトは、申請が別のパートナーと共有される詳細と条件を表します。 このオブジェクトは、配送先ラベルの 宛先 が anotherPartner の場合にのみ使用できます。

{
	"receiverPublisherId": "27691110",
	"enforceChidTargeting": false,
    "blockDuaCreation": false
}

このオブジェクトの値は次のとおりです。

対象オブジェクト

このオブジェクトは、Windows Updateに発行するときに必要な出荷ラベルのターゲットの詳細を表します。

{
  "hardwareIds": [
    {
      "bundleId": "amd64",
      "infId": "foo.inf",
      "operatingSystemCode": "WINDOWS_v100_SERVER_X64_RS5_FULL",
      "pnpString": "hid\\vid_dummy256f&pid_dummyc62f",
      "distributionState": "pendingAdd"
    }
  ],
  "chids": [
    {
      "chid": "346511cf-ccee-5c6d-8ee9-3c70fc7aae83",
      "distributionState": "pendingAdd"
    }
  ],
  "restrictedToAudiences": [
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000001"
  ],
  "inServicePublishInfo": {
    "flooring": "RS1",
    "ceiling": "RS3"
  },
  "coEngDriverPublishInfo": {
    "flooringBuildNumber": 17135,
    "ceilingBuildNumber": 17139
  }
}

このオブジェクトの値は次のとおりです。

ハードウェア ID オブジェクト

このオブジェクトは、出荷ラベルの対象にする必要があるハードウェア ID の詳細を表します。 詳細については 、ハードウェア ID を参照してください。

{
	"bundleId": "amd64",
	"infId": "foo.inf",
	"operatingSystemCode": "WINDOWS_v100_SERVER_X64_RS5_FULL",
	"pnpString": "hid\\vid_dummy256f&pid_dummyc62f",
	"distributionState": "pendingAdd"
}

このオブジェクトの値は次のとおりです。

ハードウェア ID オブジェクトには、新しい配送先住所ラベルの作成時に、バンドル ID、PNP ID、OS コード、INF 名の有効な組み合わせが含まれている必要があります。 申請 (パッケージ) のこれらの属性の許可/有効な組み合わせを取得するには、申請の詳細を取得するときにリンクとして提供されるドライバー メタデータ ファイルをダウンロードできます。 詳細については、 ドライバー パッケージのメタデータを参照してください。

CHIDs オブジェクト

このオブジェクトは、出荷ラベルの対象にする必要がある CHID (コンピューター ハードウェア ID) を表します。 詳細については、 CHID の使用 を参照してください。

{
	"chid": "346511cf-ccee-5c6d-8ee9-3c70fc7aae83",
	"distributionState": "pendingAdd"
}

このオブジェクトの値は次のとおりです。

In Service Publish Information オブジェクト

このオブジェクトは、床と天井によって定義される分布範囲を表します。 下限は、ドライバーの配布対象となる最も古い Windows バージョンを示し、上限は最も新しい Windows バージョンを示します。 床と天井を追加することで、ドライバーの分布を制限できます。

{
  "flooring": "RS1",
  "ceiling": "RS3",

}

このオブジェクトの値は次のとおりです。

これらの値の詳細については、「Windows のバージョン別にドライバー配布を制限する」を参照してください。

Co-Engineering Driver 公開情報オブジェクト

このオブジェクトは、Windowsの新しいバージョンとリリースされていないバージョンのドライバーを開発するときに、フロアと天井によって定義される配布範囲を表します。 このオブジェクトは、Microsoftの共同エンジニアリング パートナーでのみ使用できます。 下限は、ドライバーの配布対象となる最も古い Windows バージョンを示し、上限は最も新しいバージョンを示します。 床と天井を追加することで、ドライバーの分布を制限できます。

{
  "flooringBuildNumber": 17135,
  "ceilingBuildNumber": 17139
}

このオブジェクトの値は次のとおりです。

詳細については、Windows のバージョンごとのドライバー配布の制限を参照してください。

Shipping Label Workflow Status オブジェクト

このオブジェクトは、特定のエンティティのワークフローの状態を表します。

{
      "currentStep": "Created",
      "state": "completed",
      "messages": []
    }

このオブジェクトの値は次のとおりです。

エラー コード

エラー コードの詳細については、「 エラー コード」を参照してください。

こちらも参照ください

• ハードウェア ダッシュボード API のサンプル (GitHub)