Adressetikett-Daten abrufen

Artikel
02/25/2024

Eine 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 für Adressetiketten von Hardwareprodukten abzurufen, die in Ihrem 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, müssen das Produkt und die Übermittlung bereits in Ihrem Dev Center-Konto vorhanden sein. Um Produktübermittlungen zu erstellen oder zu verwalten, lesen Sie die Methoden in Produktübermittlungen verwalten.

Beschreibung	Methode	URI
Daten für alle Adressetiketten einer Übermittlung abrufen	GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/`
Daten für ein bestimmtes Adressetikett einer Übermittlung abrufen	GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/{shippingLabelId}`

Voraussetzungen

Falls Sie dies noch nicht getan haben, vervollständigen Sie alle Voraussetzungen für die Microsoft-Hardware-APIs, bevor Sie versuchen, eine dieser Methoden zu verwenden.

Datenressourcen

Die Methoden der Microsoft-Hardware-APIs für das Dashboard zum Abrufen von Adressetiketten verwenden die folgenden JSON-Datenressourcen.

ShippingLabel-Ressource

Diese Ressource stellt ein Adressetikett dar, das für eine Übermittlung Ihres Produkts erstellt wurde, das in Ihrem Konto registriert ist.

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

Wert	Typ	Beschreibung
id	long	Die ID des Adressetiketts
productId	lang	Die private Produkt-ID, mit der dieses Adressetikett verknüpft ist
submissionId	long	Die Übermittlungs-ID, mit der dieses Adressetikett verknüpft ist
publishingSpecifications	Objekt	Weitere Informationen unter Publishing Specifications-Objekt
recipientSpecifications	Array von Objekten	Weitere Informationen unter Recipient Specifications-Objekt
auf Kunden	Objekt	Weitere Informationen unter Targeting-Objekt
workflowStatus	Objekt	Dieses Objekt stellt den Status des Workflows für dieses Adressetikett dar. Weitere Informationen unter Workflow-Status des Adressetiketts
Verknüpfungen	Array von Objekten	Weitere Informationen finden Sie unter Link-Objekt.
name	Zeichenfolge	Der Name des Adressetiketts
destination	Zeichenfolge	Gibt das Ziel des Adressetiketts an. Mögliche Werte sind (Beschreibung in Klammern): anotherPartner (Dieses Adressetikett ist für die gemeinsame Nutzung der Übermittlung mit einem anderen Partner bestimmt.) windowsUpdate (Dieses Adressetikett ist für die Veröffentlichung bei Windows Update gedacht.) notSet

Publishing Specifications-Objekt

Dieses Objekt stellt die Spezifikationen für die Veröffentlichung eines Objekts in Windows Update dar. Dieses Objekt ist nur verfügbar/erforderlich, wenn destination des Adressetiketts 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"
  }
}