배송 레이블 데이터 가져오기

아티클
02/22/2024

API를 사용하기 위한 필수 구성 요소를 포함하여 Microsoft 하드웨어 API에 대한 소개는 API를 사용하여 하드웨어 제출 관리를 참조 하세요.

Microsoft 하드웨어 API에서 다음 방법을 사용하여 하드웨어 개발자 센터 계정에 등록된 하드웨어 제품의 배송 레이블에 대한 데이터를 가져옵니다.

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

이러한 메서드를 사용하려면 먼저 제품 및 제출이 개발자 센터 계정에 이미 있어야 합니다. 제품에 대한 제출을 만들거나 관리하려면 제품 제출 관리의 방법을 참조하세요.

설명	메서드	URI
제출의 모든 배송 레이블에 대한 데이터 가져오기	GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/`
제출의 특정 배송 레이블에 대한 데이터 가져오기	GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productId}/submissions/{submissionId}/shippingLabels/{shippingLabelId}`

필수 조건

아직 수행하지 않은 경우 이러한 메서드를 사용하기 전에 Microsoft 하드웨어 API에 대한 모든 필수 구성 요소를 완료합니다.

데이터 리소스

배송 레이블 데이터를 가져오기 위한 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
  },
  "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"
}

이 리소스의 값은 다음과 같습니다.

값	Type	설명
id	long	배송 레이블의 ID
productId	long	이 배송 레이블이 연결된 개인 제품 ID
submissionId	long	이 배송 레이블이 연결된 제출 ID
publishingSpecifications	개체	자세한 내용은 게시 사양 개체를 참조하세요.
recipientSpecifications	개체의 배열	자세한 내용은 받는 사람 사양 개체를 참조하세요.
대상 지정	개체	자세한 내용은 대상 지정 개체를 참조하세요.
workflowStatus	개체	이 개체는 이 배송 레이블에 대한 워크플로의 상태 보여 줍니다. 자세한 내용은 배송 레이블 워크플로 상태 개체를 참조하세요.
링크	개체의 배열	자세한 내용은 링크 개체를 참조 하세요.
name	string	배송 레이블의 이름
destination	string	배송 레이블의 대상을 나타냅니다. 가능한 값은 다음과 같습니다(괄호로 설명). anotherPartner(이 배송 레이블은 다른 파트너와 제출을 공유하기 위한 것입니다.) windowsUpdate(이 배송 레이블은 Windows 업데이트 게시용) Notset

Publishing Specifications 개체

이 개체는 개체를 Windows 업데이트 게시하는 방법의 사양을 나타냅니다. 이 개체는 배송 레이블의 대상이 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"
  }
}

이 개체의 값은 다음과 같습니다.

값	Type	설명
goLiveDate	날짜/시간	Windows 업데이트 드라이버를 다운로드할 수 있는 날짜입니다. 날짜가 제공되지 않으면 드라이버가 인증 직후에 게시됩니다.
visibleToAccounts	long 배열	드라이버 및 배송 레이블에 대한 읽기 전용 권한이 있는 SellerID 목록입니다. 이 정보는 파트너를 대신하여 드라이버를 게시하는 경우와 같이 파트너가 배송 레이블 요청을 인식하도록 하려는 경우에 유용합니다.
isAutoInstallDuringOSUpgrade	부울 값	운영 체제 업그레이드 중에 드라이버가 해당 컴퓨터에 배달될지 여부입니다.
isAutoInstallOnApplicableSystems	부울 값	드라이버가 해당 컴퓨터에 자동으로 배달되는지 여부입니다.
isDisclosureRestricted	부울 값	드라이버가 WSUS 및 Windows 업데이트 카탈로그에 표시되지 않도록 할 것인지 여부입니다.
publishToWindows10s	부울 값	드라이버를 Windows 10 S에 게시할지 여부
additionalInfoForMsApproval	개체	자세한 내용은 Microsoft 개체에 대한 추가 정보를 참조 하세요.

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

이 개체의 값은 다음과 같습니다.

값	Type	설명
microsoftContact	string	이 요청에 대해 사용자와 함께 작업하는 Microsoft 스폰서의 이메일 주소
validationsPerformed	string	드라이버의 유효성을 검사하는 방법에 대한 설명입니다. Microsoft는 검토 중에 이 정보를 사용합니다.
affectedOems	string	이 게시의 영향을 받는 OEM의 이름 목록입니다. 이 정보는 검토 중에 Microsoft에서 사용됩니다.
isRebootRequired	부울 값	드라이버를 설치한 후 다시 부팅해야 하는지 여부입니다. Microsoft는 검토 중에 이 정보를 사용합니다.
isCoEngineered	부울 값	드라이버가 Windows의 활성(미공개) 빌드에서 작업하는 공동 엔지니어링 드라이버인지 여부입니다. Microsoft는 검토 중에 이 정보를 사용합니다.
isForUnreleasedHardware	부울 값	드라이버에서 새 디바이스 또는 미공개 디바이스를 지원하는지 여부입니다. Microsoft는 검토 중에 이 정보를 사용합니다.
hasUiSoftware	부울 값	드라이버가 UI 및/또는 소프트웨어를 배포할지 여부 Microsoft는 검토 중에 이 정보를 사용합니다.
businessJustification	string	이 게시 요청을 승격하기 위한 비즈니스 근거입니다. Microsoft는 검토 중에 이 정보를 사용합니다.

Recipient specifications 개체

이 개체는 제출이 다른 파트너와 공유되는 세부 정보 및 조건을 나타냅니다. 이 개체는 배송 레이블의 대상이 다른Partner인 경우에만 사용 가능/필요합니다.

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

이 개체의 값은 다음과 같습니다.

값	Type	설명
receiverPublisherId	string	드라이버가 공유되는 판매자 ID입니다. 받는 사람은 드라이버를 다운로드하고, Windows 업데이트 게시하고, DUA 패키지를 만들 수 있습니다. 받는 사람은 다른 파트너와 더 이상 공유할 수 없습니다.
enforceChidTargeting	부울 값	파트너가 이 드라이버 제출을 위해 만든 배송 레이블에 CHID를 적용해야 하는지 여부를 나타냅니다. 이렇게 하면 여러 파트너 회사에서 하드웨어 ID를 공유할 수 있는 경우 사용자를 보호할 수 있습니다.

대상 지정 개체

이 개체는 Windows 업데이트 게시할 때 필요한 배송 레이블의 대상 지정 세부 정보를 나타냅니다.

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

이 개체의 값은 다음과 같습니다.

값	Type	설명
hardwareIds	개체의 배열	자세한 내용은 하드웨어 ID 개체를 참조 하세요.
chids	개체의 배열	자세한 내용은 CHIDs 개체를 참조 하세요.
restrictedToAudiences	문자열 배열	대상 그룹을 나타내는 문자열의 배열입니다. 대상 그룹을 사용하면 이 게시를 특정 구성의 컴퓨터로 제한할 수 있습니다. 예를 들어 테스트 대상 그룹은 특정 레지스트리 키가 설치된 클라이언트에만 전달됩니다. 조직에 적용할 수 있는 대상 그룹을 식별하고 관리하는 방법에 대한 자세한 내용은 대상 그룹 데이터 가져오기를 참조하세요.
inServicePublishInfo	개체	자세한 내용은 서비스 게시 정보 개체를 참조하세요. 대상 지정 개체에는 inServicePublishInfo 또는 coEngDriverPublishInfo가 포함될 수 있습니다.
coEngDriverPublishInfo	개체	자세한 내용은 공동 엔지니어링 드라이버 게시 정보 개체를 참조하세요. 대상 지정 개체에는 inServicePublishInfo 또는 coEngDriverPublishInfo가 포함될 수 있습니다.

하드웨어 ID 개체

이 개체는 배송 레이블의 대상이 되어야 하는 하드웨어 ID의 세부 정보를 나타냅니다. 자세한 내용은 하드웨어 ID를 참조하세요.

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

이 개체의 값은 다음과 같습니다.

값	Type	설명
bundleId	string	하드웨어 ID가 있는 번들을 나타내는 ID입니다.
infId	string	이 하드웨어 ID를 포함하는 inf 파일의 이름입니다.
operatingSystemCode	string	이 특정 하드웨어 ID - 아키텍처 조합에 적용할 수 있는 운영 체제 코드입니다. 가능한 값은 OS 코드 목록을 참조하세요.
pnpString	string	대상으로 지정할 PNP ID 또는 하드웨어 ID입니다.
distributionState	string	이 하드웨어 ID의 현재 대상 지정 상태 나타냅니다. 가능한 값은 다음과 같습니다(매개 변수의 설명). pendingAdd(이 하드웨어 ID에 대해 추가가 요청되었으며 진행 중) pendingRemove(이 하드웨어 ID에 대한 제거(만료)가 요청되었으며 진행 중입니다. 추가됨(이 하드웨어 ID는 이 배송 레이블에서 대상으로 성공적으로 추가되었습니다.) notSet(이 하드웨어 ID에서 작업이 수행되지 않았거나 상태 설정되지 않은 경우)
작업	string	이는 배송 레이블의 업데이트/패치 동안에만 적용됩니다. 가능한 값은 다음과 같습니다. add remove

하드웨어 ID 개체는 새 배송 레이블을 만드는 동안 번들 ID, PNP ID, OS 코드 및 INF 이름의 유효한 조합을 포함해야 합니다. 제출(패키지)에 대해 이러한 특성의 허용/유효한 조합을 얻으려면 제출 세부 정보를 가져올 때 링크로 제공되는 드라이버 메타데이터 파일을 다운로드할 수 있습니다. 자세한 내용은 드라이버 패키지 메타데이터를 참조하세요.

CHIDs 개체

이 개체는 배송 레이블의 대상이 되어야 하는 CHID(컴퓨터 하드웨어 ID)를 나타냅니다. 자세한 내용은 CHID 사용을 참조하세요.

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

이 개체의 값은 다음과 같습니다.

값	Type	설명
chid	GUID	대상으로 지정해야 하는 CHID
distributionState	string	이 CHID의 현재 대상 지정 상태 나타내는 선택적 값입니다. 기본값은 알 수 없음(정의되지 않은 경우)입니다. 가능한 값(괄호로 된 설명): Unknown PendingAdd(이 하드웨어 ID에 대해 추가가 요청되었으며 진행 중) 추가됨 PendingRemove(이 하드웨어 ID에 대한 제거(만료)가 요청되었으며 진행 중입니다. PendingRecovery 복구
작업	string	이는 배송 레이블의 업데이트/패치 동안에만 적용됩니다. 가능한 값은 다음과 같습니다. add remove

서비스 게시 정보 개체에서

이 개체는 바닥과 천장으로 정의된 분포 범위를 나타냅니다. 바닥은 드라이버가 배포될 초기 Windows 버전을 설명하고 천장은 최신 버전을 표시합니다. 바닥과 천장을 추가하여 드라이버의 분포를 제한할 수 있습니다.

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

}

이 개체의 값은 다음과 같습니다.

값	Type	설명
마루	string	나열된 Windows 10 운영 체제 이상에서만 드라이버를 제공하려는 경우 이 옵션을 사용합니다. 예를 들어 RS4 바닥재를 선택하면 Windows 10 1803(RS4)을 실행하는 시스템만 이 드라이버가 제공됩니다. 가능한 값은 다음과 같습니다. TH RS1 RS2 RS3 RS4 RS5 19H1 VB FE CO NI 가능한 값은 OS의 현재 버전을 포함하도록 확장됩니다.
천장	string	이 기능에 대한 액세스는 제한됩니다. 나열된 운영 체제 및 이전 시스템에 대해서만 드라이버를 제공하려는 경우 이 옵션을 사용합니다. 예를 들어 Windows 10 1607 RS1 인증 드라이버에서 RS3 천장을 선택하면 Windows 10 1803(RS4) 이상을 실행하는 시스템에 드라이버가 제공되지 않습니다. 가능한 값은 다음과 같습니다. TH RS1 RS2 RS3 RS4 RS5 19H1 VB FE CO 가능한 값은 OS의 현재 버전을 포함하도록 확장됩니다.

이러한 값에 대한 자세한 내용은 Windows 버전별 드라이버 배포 제한을 참조하세요.

공동 엔지니어링 드라이버 게시 정보 개체

이 개체는 최신 및 미공개 버전의 Windows용 드라이버를 개발할 때 바닥 및 천장에 의해 정의된 배포 범위를 나타냅니다. 이 개체는 Microsoft 공동 엔지니어링 파트너만 사용할 수 있습니다. 바닥은 드라이버가 배포될 초기 Windows 버전을 설명하고 천장은 최신 버전을 표시합니다. 바닥과 천장을 추가하여 드라이버의 분포를 제한할 수 있습니다.

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

이 개체의 값은 다음과 같습니다.

값	Type	설명
flooringBuildNumber	number	이 빌드 번호 이상에서만 드라이버를 제공하려는 경우 릴리스의 빌드 번호입니다. 예를 들어 바닥이 10.1.17135여야 하는 경우 입력은 17135여야 합니다. 주 버전(10.1)은 항상 자동으로 적절한 버전으로 기본 설정됩니다.
ceilingBuildNumber	number	이 빌드 번호 이하에서만 드라이버를 제공하려는 경우 릴리스의 빌드 번호입니다. 예를 들어 최대값이 10.1.17139여야 하는 경우 입력은 17139여야 합니다. 주 버전(10.1)은 항상 자동으로 적절한 버전으로 기본 설정됩니다.

자세한 내용은 Windows 버전별 드라이버 배포 제한을 참조 하세요.

배송 레이블 워크플로 상태 개체

이 개체는 지정된 엔터티에 대한 워크플로의 상태 나타냅니다.

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

이 개체의 값은 다음과 같습니다.

값	Type	설명
currentStep	string	이 엔터티에 대한 전체 워크플로의 현재 단계 이름입니다. Windows 업데이트 게시되는 배송 레이블의 경우 가능한 값은 (괄호로 된 설명)입니다. 생성됨(배송 레이블 만들기) PreProcessShippingLabel(대상 지정 정보 유효성 검사) FinalizePreProcessing(사전 prpcess 후 적절한 다음 단계 호출) PublishJobValidation(패키지 수집/제출이 완료되었는지 확인) UpdateGeneration(WU에 대한 게시 세부 정보 생성) MicrosoftApproval(프로모션/플라이팅) 게시(게시 세부 정보를 WU에 푸시) FinalizePublishing(게시 프로세스 완료) 다른 파트너와 공유되는 배송 레이블의 경우 가능한 값은 다음과 같습니다(괄호로 설명). 생성됨(배송 레이블 만들기) PreProcessShippingLabel(대상 지정 정보 유효성 검사) FinalizePreProcessing(사전 prpcess 후 적절한 다음 단계 호출) PublishJobValidation(패키지 수집/제출이 완료되었는지 확인) ProcessSharing(수신기에 대한 공유 세부 정보 생성) FinalizeSharing(공유 프로세스 완료)
State(상태)	string	현재 단계의 상태입니다. 가능한 값은 다음과 같습니다. notStarted 시작됨 실패 완료됨
메시지	array	현재 단계에 대한 메시지를 제공하는 문자열 배열(특히 실패 시)

값

Type

설명

currentStep

string

이 엔터티에 대한 전체 워크플로의 현재 단계 이름입니다.
Windows 업데이트 게시되는 배송 레이블의 경우 가능한 값은 (괄호로 된 설명)입니다.

생성됨(배송 레이블 만들기)
PreProcessShippingLabel(대상 지정 정보 유효성 검사)
FinalizePreProcessing(사전 prpcess 후 적절한 다음 단계 호출)
PublishJobValidation(패키지 수집/제출이 완료되었는지 확인)
UpdateGeneration(WU에 대한 게시 세부 정보 생성)
MicrosoftApproval(프로모션/플라이팅)
게시(게시 세부 정보를 WU에 푸시)
FinalizePublishing(게시 프로세스 완료)

다른 파트너와 공유되는 배송 레이블의 경우 가능한 값은 다음과 같습니다(괄호로 설명).

생성됨(배송 레이블 만들기)
PreProcessShippingLabel(대상 지정 정보 유효성 검사)
FinalizePreProcessing(사전 prpcess 후 적절한 다음 단계 호출)
PublishJobValidation(패키지 수집/제출이 완료되었는지 확인)
ProcessSharing(수신기에 대한 공유 세부 정보 생성)
FinalizeSharing(공유 프로세스 완료)

State(상태)

string

현재 단계의 상태입니다. 가능한 값은 다음과 같습니다.

notStarted
시작됨
실패
완료됨

메시지

array

현재 단계에 대한 메시지를 제공하는 문자열 배열(특히 실패 시)

참고 항목

점진적 롤아웃에 매핑되는 currentStep에 대한 값은 없습니다.

오류 코드

오류 코드에 대한 자세한 내용은 오류 코드를 참조 하세요.

참고 항목

하드웨어 대시보드 API 샘플(GitHub)

다음을 통해 공유

배송 레이블 데이터 가져오기

필수 조건

데이터 리소스

ShippingLabel 리소스

Publishing Specifications 개체

Microsoft 개체에 대한 추가 정보

Recipient specifications 개체

대상 지정 개체

하드웨어 ID 개체

CHIDs 개체

서비스 게시 정보 개체에서

공동 엔지니어링 드라이버 게시 정보 개체

배송 레이블 워크플로 상태 개체

오류 코드

참고 항목

피드백

추가 리소스