여백 가져오기

적용 대상: 파트너 센터

적절한 역할: 관리 에이전트

CSP 프로그램의 파트너는 GetMargins API를 호출하여 ISV 게시자가 확장한 프라이빗 제품 마진 목록을 가져올 수 있습니다.

필수 조건

자격 증명(파트너 센터 인증에서 설명). 이 시나리오는 독립 실행형 앱과 App+사용자 자격 증명을 모두 사용하여 인증을 지원합니다.

REST 요청

[GET] /v1/여백

요청 구문

메서드 요청 URI
GET {baseURL}/v1/margins HTTP/1.1

요청 헤더

자세한 내용은 파트너 센터 REST 헤더를 참조하세요.

요청 본문

None

요청 예제

GET https://api.partnercenter.microsoft.com/v1/margins HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US

REST 응답

성공하면 이 요청은 프라이빗 제품 여백 목록을 반환합니다. ISV 게시자는 제품의 원래 가격에 적용되는 고정 비율 할인 또는 제품의 원래 가격을 재정의하는 사용자 지정 가격으로 프라이빗 제품 마진을 구성할 수 있습니다. 두 여백 유형 모두 GetMargins API 응답에서 반환됩니다.

응답의 각 품목에는 시작 날짜와 종료 날짜가 포함됩니다. 프라이빗 제품 마진은 해당 두 날짜 내에 이루어진 구매에만 적용됩니다. 해당 시간 프레임을 벗어난 구매는 프라이빗 제품 마진의 이점을 얻지 못합니다.

응답 성공 및 오류 코드

각 응답에는 성공 또는 실패 및 더 많은 디버깅 정보를 나타내는 HTTP 상태 코드가 함께 제공됩니다. 네트워크 추적 도구를 사용하여 이 코드, 오류 유형 및 기타 매개 변수를 읽습니다. 전체 목록은 오류 코드를 참조하세요.

응답 예

백분율 기반 프라이빗 제품 마진

이 예제에서 ISV 게시자는 프라이빗 제품 마진을 제품의 원래 가격에서 고정 백분율 할인으로 구성했습니다. 할인은 "percentageMargin" 속성에 표시됩니다. 이 프라이빗 제품은 특정 SKU에 대해 확장되므로 SKU 이름 및 SKU ID와 같은 SKU 정보가 지정됩니다. ISV 게시자가 모든 SKU에 대한 프라이빗 제품을 확장하도록 선택한 경우 이 정보는 지정되지 않습니다.

응답

HTTP/1.1 200 OK
Content-Type: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
{
"pageSize": 1,
"totalSize": 1,
"results": [
{
      "id": "1aa125798b04_01a14813-f6d1-494a-ace1-b84525cf3db4",
      "type": "Percentage",
      "productId": "DZH318Z0HJ49",
      "publisherName": "Test Publisher Name",
      "productTitle": "Test Offer Beta",
      "skuTitle": "Test Offer Beta SKU 1",
      "skuId": "0001",
      "productType": "SaaS",
      "marginPercentage": 10.0,
      "startDate": "2022-02-24T18:38:02.8104364Z",
      "endDate": "2022-04-30T23:59:59Z",
      "status": "live",
      "statusDate": "2022-02-24T18:38:02.8104364Z"
}
]
}

사용자 지정 가격 프라이빗 제품 마진

이 예제에서 ISV 게시자는 프라이빗 제품 마진을 사용자 지정 미터로 SaaS 솔루션의 원래 가격을 재정의하는 사용자 지정 가격으로 구성했습니다. 이전 예제와 같이 marginPercentage 속성 대신 이 품목에는 사용자 지정 가격 책정의 세부 정보가 포함된 priceConfiguration 속성이 포함됩니다.

이 예제의 pricingModel은 "고정 요금" 모델로 나열됩니다. 즉, 용어당 설정된 금액을 지불합니다. ISV가 사용자당 설정된 금액을 청구하는 경우 pricingModel은 "사용자당"이라고 말합니다.

"구매" 배열에는 각 기간의 가격 책정 세부 정보가 포함됩니다. 이 예제의 ISV는 "월별" 기간만 구성했지만 "구매" 배열에는 "연간" 기간도 포함될 수 있습니다. 지정된 기간에 대한 구매 구성 내에서 includedMeterQuantities는 가격에 포함된 각 사용자 지정 미터의 금액을 나타냅니다. ISV 게시자는 다양한 고객 시장에 대해 서로 다른 가격 요소를 구성할 수 있으므로 marketSetPrices 배열에는 각 시장에 대한 사용자 지정 가격과 프라이빗 제품을 사용할 수 있는 통화가 포함됩니다. 이 예제에서는 GB(영국) 시장에서 고객의 고정 요금인 448.75262 GPB에는 매월 20개의 디바이스와 30,000개의 전자 메일이 포함됩니다.

"소비" 배열에는 각 사용자 지정 미터에 대한 초과분 가격 정보가 포함됩니다. ISV 제품에 사용자 지정 미터가 없으면 이 배열은 비어 있습니다. 소비 배열에는 "includedMeterQuantities"에 나열된 각 사용자 지정 측정기에 대한 품목이 포함되어 있습니다. 이 예제에서는 매월 20개 이상의 디바이스를 사용하는 경우 매월 1개의 추가 디바이스당 0.44729GBP를 추가로 지불하게 됩니다. 30,000개 이상의 전자 메일을 사용하는 경우 매월 100개의 추가 전자 메일당 0.38765GBP를 지불하게 됩니다.

응답

HTTP/1.1 200 OK
Content-Type: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
{
"pageSize": 1,
"totalSize": 1,
"results": [
{
      "id": "15680381dbad_fe3f0bc2-6372-48af-bbec-2df83918dbf2",
      "type": "CustomPrice",
      "productId": "DZH318Z0BDGN",
      "publisherName": "Test Publisher Name",
      "productTitle": "Test Offer Gamma",
      "skuTitle": "Test Offer Gamma SKU 1",
      "skuId": "0001",
      "productType": "SaaS",
      "priceConfiguration": {
        "pricingModel": "Flat rate",
        "purchase": [
          {
            "termDuration": "Monthly",
            "includedMeterQuantities": [
              "20 device",
              "30000 email"
            ],
            "startDate": "2022-01-31T17:49:25.1346812Z",
            "endDate": "2028-08-31T23:59:59Z",
            "marketSetPrices": [
              {
                "markets": [
                  "GB"
                ],
                "currency": "GBP",
                "customPrice": 447.29387
              },
              {
                "markets": [
                  "BG",
                  "FI",
                  "IT",
                  "RO"
                ],
                "currency": "GBP",
                "customPrice": 448.75262
              }
            ]
          }
        ],
        "consumption": [
          {
            "meterType": "device",
            "unitofMeasure": "per 1 device",
            "startDate": "2022-01-01T00:00:00Z",
            "endDate": "2028-08-31T23:59:59Z",
            "marketSetPrices": [
              {
                "markets": [
                  "GB"
                ],
                "currency": "GBP",
                "customPrice": 0.44729
              },
              {
                "markets": [
                  "BG",
                  "FI",
                  "IT",
                  "RO"
                ],
                "currency": "GBP",
                "customPrice": 0.44875
              }
            ]
          },
          {
            "meterType": "email",
            "unitofMeasure": "per 100 emails",
            "startDate": "2022-01-01T00:00:00Z",
            "endDate": "2028-08-31T23:59:59Z",
            "marketSetPrices": [
              {
                "markets": [
                  "GB"
                ],
                "currency": "GBP",
                "customPrice": 0.38765
              },
              {
                "markets": [
                  "BG",
                  "FI",
                  "IT",
                  "RO"
                ],
                "currency": "GBP",
                "customPrice": 0.38892
              }
            ]
          }
        ]
      },
      "startDate": "2022-01-31T17:49:25.1346812Z",
      "endDate": "2028-08-31T23:59:59Z",
      "status": "live",
      "statusDate": "2022-01-31T17:49:25.1346812Z"
    }
  ]
}

위의 예제는 다음과 같습니다.

샘플 ISV 제품에 대한 사용자 지정 가격 책정 페이지를 보여 주는 스크린샷