取得邊界
適用於：合作夥伴中心
適當的角色：系統管理代理程式
身為 CSP 計劃的合作夥伴，您可以呼叫 GetMargins API，以取得 ISV 發行者延伸至您的私人供應專案邊界清單。
必要條件
認證，如合作夥伴中心驗證所述。 此案例支援使用獨立應用程式和 App+使用者認證進行驗證。
REST 要求
[GET] /v1/margins
要求語法
| 方法 | 要求 URI |
|---|---|
| GET | {baseURL}/v1/margins HTTP/1.1 |
要求標頭
如需詳細資訊，請參閱合作夥伴中心 REST 標頭。
要求本文
無
要求範例
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 標識碼等 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 解決方案的原始價格。 此明細專案包含 priceConfiguration 屬性，而不是上一個範例中的 marginPercentage 屬性，其中包含自定義定價的詳細數據。
此範例中的 pricingModel 會列為「一般費率」模型，這表示您為每個字詞支付一定金額。 如果ISV對每個使用者收取一定金額，則pricingModel會說出「每個使用者」。
「購買」陣列包含每個期間的價格詳細數據。 此範例中的ISV只設定了「每月」期間，但「購買」陣列也可以包含「年度」期間。 在指定字詞的購買組態內，includedMeterQuantities 會指出價格中包含的每個自定義計量金額。 因為ISV發行者可以為不同的客戶市場設定不同的價格點，因此 marketSetPricess 數位包含每個市場和私人供應專案可用的貨幣的自定義價格。 在此範例中，GB（英國）市場客戶的固定費率為 448.75262 GPB，每月包含 20 部裝置和 30,000 封電子郵件。
“consumption” 陣列包含每個自定義計量的超額定價資訊。 如果ISV的產品沒有自定義計量，則此陣列會是空的。 您會發現耗用量陣列包含每個自定義計量的明細專案，這些計量列在 「includedMeterQuantities」 中。 在此範例中，如果您每月耗用超過 20 部裝置，則每月額外支付 0.44729 GBP 每 1 部裝置的費用。 如果您取用超過 30,000 封電子郵件，則每月會支付每 100 封額外電子郵件 0.38765 GBP。
回應
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"
}
]
}
上述範例應該會產生下列結果。
