通过

获取 Microsoft 客户协议模板的下载链接

  • 项目

适用于：合作伙伴中心

不适用于：由世纪互联运营的合作伙伴中心 | Microsoft Cloud for US Government 合作伙伴中心

目前，合作伙伴中心仅在 Microsoft 公有云中支持 AgreementDocument 资源。

本文介绍如何根据客户的国家/地区和语言获取下载Microsoft 客户协议模板的链接。

先决条件

  • 如果使用合作伙伴中心 .NET SDK，则需要版本 1.14 或更高版本。

    重要

    截至 2023 年 6 月，最新的合作伙伴中心 .NET SDK 版本 3.4.0 现已存档。 可以从 GitHub 下载 SDK 版本，以及包含有用信息的自述文件。

    建议合作伙伴继续使用合作伙伴中心 REST API。

  • 合作伙伴中心身份验证中所述的凭据。 此方案仅支持“应用 + 用户”身份验证。

  • Microsoft 客户协议模板应用到的客户所在国家/地区。

  • 应本地化Microsoft 客户协议模板的语言。

重要

  • Microsoft 客户协议特定于国家/地区。 请求下载Microsoft 客户协议模板的链接时，请务必根据客户的位置指定正确的国家/地区。 或受支持的国家/地区列表，请参阅 支持的国家/地区和语言列表。
  • 对于某些国家/地区，Microsoft 客户协议以多种语言提供。 为获得最佳客户体验，请选择最符合客户需求的语言。 有关支持的语言列表，请参阅 支持的国家/地区和语言列表。
  • 此方法仅受Microsoft 客户协议支持。

.NET

若要检索下载Microsoft 客户协议模板的链接，请执行以下操作：

  1. 检索 Microsoft 客户协议的协议元数据。 必须获取 Microsoft 客户协议的 templateId。 有关详细信息，请参阅获取 Microsoft 客户协议的协议元数据。

    // IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

AgreementMetaData microsoftCustomerAgreementDetails = partnerOperations.AgreementDetails.   ByAgreementType(agreementType).Get().Items.Single();

  2. 使用 IAggregatePartner.AgreementTemplates 集合。

  3. 调用 ById 方法并指定Microsoft 客户协议的 templateId。

  4. 提取 Document 属性。

  5. 调用 ByCountry 方法并指定协议模板适用的客户所在国家/地区。 如果未指定该方法，则查询默认为 US 。 有关支持的国家/地区代码的列表，请参阅 支持的国家/地区和语言列表。 此方法 区分大小写。

  6. 调用 ByLanguage 方法并指定协议模板应本地化的语言。 如果未指定该方法，或者指定的国家/地区代码不支持指定的国家/地区代码，则查询默认为 en-US 。 有关支持的语言代码列表，请参阅 支持的国家/地区和语言列表。

  7. 调用 Get 或 GetAsync 方法。

    // IAggregatePartner partnerOperations;

string customerCountry = "US";

string languageForLocalization = "en-US";

var agreementDocument = partnerOperations.   AgreementTemplates.ById   (microsoftCustomerAgreementDetails.   TemplateId).Document.ByCountry   (customerCountry).ByLanguage   (languageForLocalization).Get();

可以在控制台测试应用项目的 GetAgreementDetails 类中找到完整的示例。

REST 请求

若要检索下载Microsoft 客户协议模板的链接，请执行以下操作：

  1. 检索 Microsoft 客户协议的协议元数据。 必须获取 Microsoft 客户协议的 templateId。 有关详细信息，请参阅获取 Microsoft 客户协议的协议元数据。

  2. 创建 REST 请求来提取 AgreementDocument 资源。 有关示例，请参阅 请求语法 示例。 必须指定以下信息：

    • Microsoft 客户协议的 templateId
    • Microsoft 客户协议模板适用的国家/地区
    • 应本地化Microsoft 客户协议模板的语言

请求语法

对此资源使用以下请求语法：

方法 请求 URI
GET {baseURL}/v1/agreementtemplates/{agreement-template-id}/document？language={language}&country={country} HTTP/1.1

URI 参数

可以将以下 URI 参数用于请求：

名称 类型​​ 必需 说明
agreement-template-id string 是 协议类型的唯一标识符。 可以通过检索 Microsoft 客户协议的协议元数据来获取 Microsoft 客户协议的 templateId。 有关详细信息，请参阅获取 Microsoft 客户协议的协议元数据。 此参数 区分大小写。
country string 否 指示协议模板适用的国家/地区。 如果未指定参数，则查询默认为 US 。 有关支持的国家/地区代码的列表，请参阅 支持的国家/地区和语言列表。
language string 否 指示协议模板应本地化的语言。 如果未指定参数或指定的国家/地区不支持的国家/地区代码，则查询默认为 en-US 。 有关支持的国家/地区代码的列表，请参阅 支持的国家/地区和语言列表。

请求标头

有关详细信息，请参阅合作伙伴中心 REST 标头。

请求正文

无。

请求示例

GET https://api.partnercenter.microsoft.com/v1/agreementtemplates/117a77b0-9360-443b-8795-c6dedc750cf9/document?language=en-US&country=US HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd

REST 响应

如果成功，此方法在响应正文中返回 AgreementDocument 资源 。

资源具有 downloadUri 属性，其中包含可用于下载协议模板的 URL 字符串。 每次进行查询时都会返回不同的链接。 此链接在五分钟后过期。

响应的成功和错误代码

每个响应都有一个 HTTP 状态代码，指示成功或失败和其他调试信息。

使用网络跟踪工具读取此代码、错误类型和其他参数。 如需完整列表，请参阅合作伙伴中心 REST 错误代码。

响应示例

HTTP/1.1 200 OK
Content-Length: 620
Content-Type: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
{
    "displayUri":"https://wopihost.int.l2o.microsoft.com/v1/officehost/agreement/files/Preview...",
    "downloadUri":"https://l2oagreementintbn2.blob.core.windows.net/agreementscontainer/Preview...",
    "language":"en-US",
    "country":"US"
}

支持的国家/地区和语言列表

重要

国家/地区代码属性区分大小写。 请务必使用此表中指定的正确大小写：

国家/地区 国家/地区代码 支持的语言代码（s）
奥兰群岛 AX en-US
阿富汗 AF en-US
阿尔巴尼亚 AL en-US
阿尔及利亚 DZ en-US、fr-FR、en-US
美属萨摩亚 AS en-US
安道尔 AD en-US
安哥拉 AO en-US、pt-PT
安圭拉 AI en-US
南极洲 AQ en-US
安提瓜和巴布达 AG en-US
阿根廷 AR en-US、es-ES
亚美尼亚 AM en-US
阿鲁巴 AW en-US
澳大利亚 AU en-US
奥地利 AT en-US， de-DE
阿塞拜疆 AZ en-US
巴哈马 BS en-US
巴林 BH en-US、 ar-SA
孟加拉 BD en-US
巴巴多斯 BB en-US
白俄罗斯 BY en-US、ru-RU
比利时 BE en-US、nl-NL
伯利兹 BZ en-US、es-ES
贝宁 BJ en-US
百慕大群岛 BM en-US
不丹 BT en-US
玻利维亚 BO en-US、es-ES
博内尔 BQ en-US
波斯尼亚和黑塞哥维那 BA en-US
博茨瓦纳 BW en-US
布韦岛 BV en-US
巴西 BR en-US、pt-BR
英属印度洋领地 IO en-US
英属维尔京群岛 VG en-US
文莱 BN en-US
保加利亚 BG en-US， bg-BG
布基纳法索 BF en-US
布隆迪 BI en-US
科特迪瓦 CI en-US、fr-FR
佛得角 CV en-US、pt-PT
柬埔寨 KH en-US
喀麦隆 CM en-US、fr-FR
加拿大 CA en-US、fr-FR
开曼群岛 KY en-US、en-US
中非共和国 CF en-US
乍得 TD en-US
智利 CL en-US、es-ES
圣诞岛 CX en-US
科科斯(基林)群岛 CC en-US
哥伦比亚 CO en-US、es-ES
科摩罗 KM en-US
刚果（金） CD en-US
刚果 CG en-US
库克群岛 CK en-US
哥斯达黎加 CR en-US、es-ES
克罗地亚 HR en-US、hr-HR
库拉索岛 CW en-US
塞浦路斯 CY en-US
捷克 CZ en-US、cs-CZ
丹麦 DK en-US、da-DK
吉布提 DJ en-US
多米尼克 DM en-US
多米尼加共和国 DO en-US、es-ES
厄瓜多尔 EC en-US
埃及 EG en-US、 ar-SA
萨尔瓦多 SV en-US、es-ES
赤道几内亚 GQ en-US
厄立特里亚 ER en-US
爱沙尼亚 EE en-US、et-企业版
eSwatini SZ en-US
埃塞俄比亚 ET en-US
福克兰群岛 FK en-US
法罗群岛 FO en-US
斐济 FJ en-US
芬兰 FI en-US、fi-FI
法国 FR en-US、fr-FR
法属圭亚那 GF en-US、fr-FR
法属波利尼西亚 PF en-US
法属南部领地 TF en-US
加蓬 GA en-US
冈比亚 GM en-US
格鲁吉亚 GE en-US
德国 DE en-US， de-DE
加纳 GH en-US
直布罗陀 GI en-US
希腊 GR en-US、el-GR
格陵兰 GL en-US
格林纳达 GD en-US
瓜德罗普岛 GP en-US
关岛 GU en-US
危地马拉 GT en-US、es-ES
根西岛 GG en-US
几内亚 GN en-US
几内亚比绍 GW en-US
圭亚那 GY en-US
海地 HT en-US
赫德岛和麦克唐纳群岛 HM en-US
洪都拉斯 HN en-US、es-ES
香港特别行政区 HK en-US， zh-HK
匈牙利 HU en-US， hu-HU
冰岛 IS en-US
印度 IN en-US、hi-IN
印度尼西亚 ID en-US、id-ID
伊拉克 IQ en-US、 ar-SA
爱尔兰 IE en-US
马恩岛 IM en-US
以色列 IL en-US， he-IL
意大利 IT en-US， it-IT
牙买加 JM en-US
扬马延岛 XJ en-US
日本 JP en-US、ja-JP
泽西岛 JE en-US
约旦 JO en-US、 ar-SA
哈萨克斯坦 KZ en-US、kk-KZ
肯尼亚 KE en-US
基里巴斯 KI en-US
韩国 KR en-US、ko-KR
科索沃 XK en-US
科威特 KW en-US、 ar-SA
吉尔吉斯斯坦 KG en-US、ru-RU
老挝 LA en-US
拉脱维亚 LV en-US、lv-LV
黎巴嫩 LB en-US、 ar-SA
莱索托 LS en-US
利比里亚 LR en-US
利比亚 LY en-US、 ar-SA
列支敦士登 LI en-US， de-DE
立陶宛 LT en-US、lt-LT
卢森堡 LU en-US、fr-FR
澳门特别行政区 MO en-US， zh-HK
马达加斯加 MG en-US
马拉维 MW en-US
马来西亚 MY en-US、ms-MY
马尔代夫 MV en-US
马里 ML en-US
马耳他 MT en-US
马绍尔群岛 MH en-US
马提尼克 MQ en-US
毛利塔尼亚 MR en-US
毛里求斯 MU en-US、 ar-SA
马约特 YT en-US
墨西哥 MX en-US、es-ES
密克罗尼西亚 FM en-US
摩尔多瓦 MD en-US、ro-RO
摩纳哥 MC en-US、fr-FR
蒙古 MN en-US
黑山 ME en-US
蒙特塞拉特 MS en-US
摩洛哥 MA en-US、fr-FR、en-US
莫桑比克 MZ en-US
缅甸 MM en-US
纳米比亚 NA en-US
瑙鲁 NR en-US
尼泊尔 NP en-US
荷兰 NL en-US、nl-NL
新喀里多尼亚 NC en-US
新西兰 NZ en-US
尼加拉瓜 NI en-US、es-ES
尼日尔 NE en-US
尼日利亚 NG en-US
纽埃 NU en-US
诺福克岛 NF en-US
北马里亚纳群岛 MP en-US
北马其顿 MK en-US
挪威 NO en-US、nb-NO
阿曼 OM en-US、 ar-SA
巴基斯坦 PK en-US
帕劳 PW en-US
巴勒斯坦民族权力机构 PS en-US
巴拿马 PA en-US、es-ES
巴布亚新几内亚 PG en-US
巴拉圭 PY en-US、es-ES
秘鲁 PE en-US、es-ES
菲律宾 PH en-US
皮特凯恩群岛 PN en-US
波兰 PL en-US，pl-PL
葡萄牙 PT en-US、pt-PT
波多黎各 PR en-US、en-US
卡塔尔 QA en-US、 ar-SA
留尼汪 RE en-US
罗马尼亚 RO en-US、ro-RO
俄罗斯 RU en-US、ru-RU
卢旺达 RW en-US、fr-FR
圣多美和普林西比 ST en-US、fr-FR
萨巴 XS en-US
圣巴塞莱米 BL en-US
圣基茨和尼维斯 KN en-US
圣卢西亚 LC en-US、en-US
法属圣马丁 MF en-US、en-US
圣皮埃尔和密克隆岛 PM en-US
圣文森特和格林纳丁斯 VC en-US
萨摩亚 WS en-US
圣马力诺 SM en-US
沙特阿拉伯 SA en-US
塞内加尔 SN en-US、fr-FR
塞尔维亚 RS en-US、sr-Latn-RS、en-US
塞舌尔 SC en-US
塞拉利昂 SL en-US
新加坡 SG en-US、zh-SG
圣尤斯特歇斯 XE en-US
荷属圣马丁 SX en-US、en-US
斯洛伐克 SK en-US， sk-SK
斯洛文尼亚 SI en-US、sl-SI
所罗门群岛 SB en-US
索马里 SO en-US
南非 ZA en-US
南乔治亚岛和南桑威奇群岛 GS en-US
南苏丹 SS en-US
西班牙 ES en-US、es-ES、en-US、en-US
斯里兰卡 LK en-US
圣赫勒拿-阿森松-特里斯坦达库尼亚 SH en-US
苏里南 SR en-US
斯瓦尔巴岛 SJ en-US
瑞典 SE en-US、sv-标准版
瑞士 CH en-US、fr-FR、en-US、en-US
台湾 TW en-US， zh-HK
塔吉克斯坦 TJ en-US
坦桑尼亚 TZ en-US
泰国 TH en-US，th-TH
东帝汶 TL en-US
多哥 TG en-US
托克劳 TK en-US
汤加 TO en-US
特立尼达和多巴哥 TT en-US
突尼斯 TN en-US、fr-FR、en-US
土耳其 TR en-US、tr-TR
土库曼斯坦 TM en-US
特克斯和凯科斯群岛 TC en-US
图瓦卢 电视 en-US
美国本土外小岛屿 UM en-US
美国维尔京群岛 VI en-US
乌干达 UG en-US
乌克兰 UA en-US， uk-UA
阿拉伯联合酋长国 AE en-US、 ar-SA
英国 GB en-US
美国 US en-US
乌拉圭 UY en-US、es-ES
乌兹别克斯坦 UZ en-US、ru-RU
瓦努阿图 VU en-US
梵蒂冈 VA en-US
委内瑞拉 VE en-US、es-ES
越南 VN en-US、vi-VN
瓦利斯和富图纳 WF en-US
也门 YE en-US、 ar-SA
赞比亚 ZM en-US
津巴布韦 ZW en-US