Versandetikett-Daten abrufen

Einführung in Microsoft-Hardware-APIs, einschließlich der Voraussetzungen für die Verwendung der API, finden Sie unter „Verwalten von Hardware-Übermittlungen mithilfe von APIs“.

Verwenden Sie die folgenden Methoden in Microsoft Hardware-APIs um Daten zum Versand von Etiketten von Hardwareprodukten abzurufen, die für Ihr Hardware Dev Center-Konto registriert sind.

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

Bevor Sie diese Methoden verwenden können, muss das Produkt und die Übermittlung bereits in Ihrem Dev Center-Konto vorhanden sein. Um Produktanträge zu erstellen oder zu verwalten, sehen Sie sich die Methoden in "Produktübermittlungen verwalten" an.

Voraussetzungen

Falls noch nicht geschehen, führen Sie alle Prerequisites für die Microsoft Hardware-APIs aus, bevor Sie versuchen, eine dieser Methoden zu verwenden.

Datenressourcen

Die Microsoft Hardwaredashboard-API-Methoden zum Abrufen von Versandetikettdaten verwenden die folgenden JSON-Datenressourcen.

Ressource „ShippingLabel“

Diese Ressource stellt ein Versandetikett dar, das für die Einreichung Ihres in Ihrem Konto registrierten Produkts erstellt wurde.

{
  "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"
}

Diese Ressource hat die folgenden Werte:

Objekt „Veröffentlichungsspezifikationen“

Dieses Objekt stellt die Spezifikationen dar, wie ein Objekt in Windows Update veröffentlicht wird. Dieses Objekt ist nur verfügbar/erforderlich, wenn das Ziel des Versandetiketts windowsUpdate ist.

{
  "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"
  }
}

Dieses Objekt hat die folgenden Werte

Zusätzliche Informationen für das Microsoft-Objekt

Dieses Objekt stellt einige zusätzliche Informationen dar, die von Microsoft zum Überprüfen des Versandetiketts benötigt werden. Dieses Objekt ist nur verfügbar/erforderlich, wenn das Ziel des Versandetiketts windowsUpdate ist und das Versandetikett als "AutoInstallDuringOSUpgrade " oder "isAutoInstallOnApplicableSystems" gekennzeichnet ist.

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

Dieses Objekt hat die folgenden Werte

Empfängerspezifikationsobjekt

Dieses Objekt stellt die Details und Bedingungen dar, unter denen die Übermittlung mit einem anderen Partner geteilt wird. Dieses Objekt ist nur verfügbar/erforderlich, wenn das Ziel des Versandetiketts ein andererPartner ist.

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

Dieses Objekt hat die folgenden Werte

Zielobjekt

Dieses Objekt stellt die Zieldetails des Versandetiketts dar, das bei der Veröffentlichung in Windows Update erforderlich ist.

{
  "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
  }
}

Dieses Objekt hat die folgenden Werte

Hardware-ID-Objekt

Dieses Objekt repräsentiert die Details der Hardware-ID, auf die das Versandetikett ausgerichtet sein muss. Weitere Informationen finden Sie unter Hardware-IDs .

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

Dieses Objekt hat die folgenden Werte

Das Hardware-ID-Objekt sollte eine gültige Kombination aus Paket-ID, PNP-ID, Betriebssystemcode und INF-Namen enthalten, während eine neue Versandbezeichnung erstellt wird. Um die zulässigen/gültigen Kombinationen dieser Attribute für Ihre Übermittlung (Paket) abzurufen, können Sie die Treibermetadatendatei herunterladen, die als Link bereitgestellt wird, wenn Sie Details zu einer Übermittlung erhalten. Weitere Informationen finden Sie in den Metadaten des Treiberpakets.

CHIDs-Objekt

Dieses Objekt repräsentiert die CHID (Computerhardware-ID), auf die das Versandetikett ausgerichtet sein muss. Weitere Informationen finden Sie unter Verwendung von CHIDs .

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

Dieses Objekt hat die folgenden Werte

In Service Publish Information-Objekt

Dieses Objekt stellt Verteilungsbereiche dar, die durch einen Boden und eine Decke definiert werden. Eine Untergrenze beschreibt die früheste Windows-Version, für die der Treiber verteilt wird, und eine Obergrenze kennzeichnet die neueste. Durch Hinzufügen eines Bodens und einer Decke können Sie die Verteilung des Fahrers einschränken.

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

}

Dieses Objekt hat die folgenden Werte

Weitere Informationen zu diesen Werten finden Sie unter Limiting driver distribution by Windows versions.

Co-Engineering-Treiber-Veröffentlichungsinformationsobjekt

Dieses Objekt stellt Verteilungsbereiche dar, die bei der Entwicklung von Treibern für neuere und unveröffentlichte Versionen von Windows durch eine Boden- und Obergrenze definiert werden. Dieses Objekt ist nur für Microsoft Co-Engineering-Partner verfügbar. Eine untere Grenze beschreibt die früheste Windows-Version, für die der Treiber verteilt wird, und eine obere Grenze kennzeichnet die neueste. Durch Hinzufügen eines Bodens und einer Decke können Sie die Verteilung des Fahrers einschränken.

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

Dieses Objekt hat die folgenden Werte

Weitere Informationen finden Sie unter Einschränken der Treiberverteilung nach Windows-Versionen.

Workflowstatusobjekt des Versandetiketts

Dieses Objekt stellt den Status des Workflows für eine bestimmte Entität dar.

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

Dieses Objekt hat die folgenden Werte

Fehlercodes

Informationen zu den Fehlercodes finden Sie unter Fehlercodes.

Siehe auch

• Beispiele für hardwaredashboard-API (GitHub)