适用于：合作伙伴中心
不适用于：由世纪互联运营的合作伙伴中心 |美国政府Microsoft云合作伙伴中心
AgreementDocument 资源目前仅在Microsoft公有云中受合作伙伴中心支持。
本文介绍如何根据客户的国家/地区和语言获取下载Microsoft客户协议模板的链接。
先决条件
如果使用合作伙伴中心 .NET SDK，则需要版本 1.14 或更高版本。
重要
截至 2023 年 6 月，最新的合作伙伴中心 .NET SDK 版本 3.4.0 现已存档。 可以从 GitHub 下载 SDK 版本，以及包含有用信息的自述文件。
建议合作伙伴继续使用合作伙伴中心 REST API。
合作伙伴中心身份验证中所述的凭据。 此方案仅支持 App+User 身份验证。
Microsoft客户协议模板适用的客户所在国家/地区。
本地化 Microsoft 客户协议模板应使用的语言。
重要
- Microsoft客户协议特定于国家/地区。 请求下载Microsoft客户协议模板的链接时，请务必根据客户的位置指定正确的国家/地区。 或受支持国家/地区列表，请参阅 受支持的国家/地区和语言列表。
- 对于某些国家/地区，Microsoft客户协议以多种语言提供。 为获得最佳客户体验，请选择最符合客户需求的语言。 有关支持的语言列表，请参阅 受支持的国家/地区和语言列表。
- 此方法仅在微软客户协议下支持。
。网
若要检索下载Microsoft客户协议模板的链接，请执行以下作：
检索Microsoft客户协议的协议元数据。 必须获取 Microsoft 客户协议的 templateId。 有关详细信息，请参阅 获取Microsoft客户协议的协议元数据。
// IAggregatePartner partnerOperations; string agreementType = "MicrosoftCustomerAgreement"; AgreementMetaData microsoftCustomerAgreementDetails = partnerOperations.AgreementDetails. ByAgreementType(agreementType).Get().Items.Single();使用 IAggregatePartner.AgreementTemplates 集合。
调用 ById 方法，并指定 Microsoft 客户协议的 templateId。
提取 Document 属性。
调用 ByCountry 方法，并指定协议模板适用的客户所在国家/地区。 如果未指定该方法，则查询默认为 US。 有关支持的国家/地区代码的列表，请参阅 支持的国家/地区和语言列表。 此方法区分大小写。
调用 ByLanguage 方法，并指定协议模板应本地化的语言。 如果未指定方法，或者指定的国家/地区代码不被支持，那么查询默认为 en-US。 有关支持的语言代码列表，请参阅 受支持的国家/地区和语言列表。
调用 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客户协议模板的链接，请执行以下作：
检索Microsoft客户协议的协议元数据。 必须获取 Microsoft 客户协议的 templateId。 有关详细信息，请参阅 获取Microsoft客户协议的协议元数据。
创建 REST 请求来提取 AgreementDocument 资源。 有关示例，请参阅 请求语法 示例。 必须指定以下信息：
- Microsoft 客户协议的 templateId
- Microsoft客户协议模板适用的国家/地区
- 本地化 Microsoft 客户协议模板应使用的语言
请求语法
对此资源使用以下请求语法：
| 方法 | 请求 URI |
|---|---|
| 获取 | {baseURL}/v1/agreementtemplates/{agreement-template-id}/document?language={language}&country={country} HTTP/1.1 |
URI 参数
可以将以下 URI 参数用于请求：
| 名字 | 类型 | 必需 | 说明 |
|---|---|---|---|
| 协议模板 ID | 字符串 | 是的 | 协议类型的唯一标识符。 可以通过检索Microsoft客户协议的协议元数据来获取 Microsoft 客户协议的 templateId。 有关详细信息，请参阅 获取Microsoft客户协议的协议元数据。 此参数区分大小写。 |
| 国家/地区 | 字符串 | 否 | 指示协议模板适用的国家/地区。 如果未指定参数，则查询默认为 美国。 有关支持的国家/地区代码的列表，请参阅 支持的国家/地区和语言列表。 |
| 语言 | 字符串 | 否 | 指示协议模板应本地化的语言。 如果未指定参数，或指定的国家/地区不支持已指定的国家/地区代码，查询将默认为 en-US。 有关支持的国家/地区代码列表，请参阅 支持的国家/地区和语言列表。 |
请求标头
如需了解更多信息，请参阅 合作伙伴中心 REST 标头。
请求主体
没有。
请求示例
GET https://api.partnercenter.microsoft.com/v1/agreementtemplates/aaaabbbb-0000-cccc-1111-dddd2222eeee/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"
}
支持的国家/地区和语言列表
重要
国家/地区代码属性区分大小写。 请务必使用此表中指定的正确大小写格式：
| 国家/地区 | 国家/地区代码 | 支持的语言代码 |
|---|---|---|
| 奥兰群岛 | 斧头 | zh-CN |
| 阿富汗 | 自动对焦 | zh-CN |
| 阿尔巴尼亚 | 铝 | zh-CN |
| 阿尔及利亚 | DZ | en-US、fr-FR、en-US |
| 美属萨摩亚 | 如 | zh-CN |
| 安道尔 | 广告 | zh-CN |
| 安哥拉 | 坳 | en-US，pt-PT |
| 安圭拉 | 人工智能 | zh-CN |
| 南极洲 | AQ系列 | zh-CN |
| 安提瓜和巴布达 | 银 | zh-CN |
| 阿根廷 | AR（增强现实） | en-US，es-ES |
| 亚美尼亚 | 是 | zh-CN |
| 阿鲁巴岛 | AW | zh-CN |
| 澳大利亚 | 澳大利亚 | zh-CN |
| 奥地利 | 在 | en-US，de-DE |
| 阿塞拜疆 | 可用区 | zh-CN |
| 巴哈马 | 理学学士 | zh-CN |
| 巴林 | BH | en-US，ar-SA |
| 孟加拉国 | 屋宇 署 | zh-CN |
| 巴巴多斯 | BB系列 | zh-CN |
| 白俄罗斯 | 由 | en-US，ru-RU |
| 比利时 | 是 | en-US，nl-NL |
| 伯利兹 | BZ | en-US，es-ES |
| 贝宁 | 北京 | zh-CN |
| 百慕大 | BM 系列 | zh-CN |
| 不丹 | 英国电信 | zh-CN |
| 玻利维亚 | 博 | en-US，es-ES |
| 博内尔 | BQ | zh-CN |
| 波斯尼亚和黑塞哥维那 | 八 | zh-CN |
| 博茨瓦纳 | BW | zh-CN |
| 布维特岛 | BV （必维） | zh-CN |
| 巴西 | 巴西 | en-US，pt-BR |
| 英国印度洋领地 | IO | zh-CN |
| 英属维尔京群岛 | VG系列 | zh-CN |
| 文莱 | 亿 | zh-CN |
| 保加利亚 | BG系列 | en-US，bg-BG |
| 布基纳法索 | 高炉 | zh-CN |
| 蒲隆地 | 商业智能 | zh-CN |
| 科特迪瓦 | 词 | en-US，fr-FR |
| 卡波维德 | 简历 | en-US，pt-PT |
| 柬埔寨 | KH | zh-CN |
| 喀麦隆 | 厘米 | en-US，fr-FR |
| 加拿大 | CA | en-US，fr-FR |
| 开曼群岛 | 肯塔基州 | en-US，en-US |
| 中非共和国 | CF 系列 | zh-CN |
| 乍得 | TD的 | zh-CN |
| 智利 | CL | en-US，es-ES |
| 圣诞岛 | 客户体验 | zh-CN |
| 可可（基隆）群岛 | 抄送 | zh-CN |
| 哥伦比亚 | 一氧化碳 | en-US，es-ES |
| 科摩罗 | 公里 | zh-CN |
| 刚果（金） | 光盘 (CD) | zh-CN |
| 刚果 | CG系列 | zh-CN |
| 库克群岛 | 肌酸激酶 | zh-CN |
| 哥斯达黎加 | 铬 | en-US，es-ES |
| 克罗地亚 | 人力资源 | en-US，hr-HR |
| 库拉索 | CW电视网, 连续波 | zh-CN |
| 塞浦路斯 | CY | zh-CN |
| 捷克 | 捷克 | en-US，cs-CZ |
| 丹麦 | DK 系列 | en-US，da-DK |
| 吉布提 | DJ 餐厅 | zh-CN |
| 多米尼加 | 分米 | zh-CN |
| 多米尼加共和国 | 做 | en-US，es-ES |
| 厄瓜多尔 | 电子商务 | zh-CN |
| 埃及 | EG 系列 | en-US，ar-SA |
| 萨尔瓦多 | SV | en-US，es-ES |
| 赤道几内亚 | 《GQ》 | zh-CN |
| 厄立特里亚 | 的 | zh-CN |
| 爱沙尼亚 | EE 系列 | en-US，et-EE |
| 埃斯瓦蒂尼 | 深圳 | zh-CN |
| 埃塞俄比亚 | ET | zh-CN |
| 福克兰群岛 | FK | zh-CN |
| 法罗群岛 | 佛 | zh-CN |
| 斐济 | FJ | zh-CN |
| 芬兰 | FI 餐厅 | en-US，fi-FI |
| 法国 | FR （简体中文） | en-US，fr-FR |
| 法属圭亚那 | 女友 | en-US，fr-FR |
| 法属波利尼西亚 | PF 系列 | zh-CN |
| 法属南部领地 | TF 系列 | zh-CN |
| 加蓬 | 乔治亚州 | zh-CN |
| 冈比亚 | 通用汽车 | zh-CN |
| 格鲁吉亚 | 通用 电气 | zh-CN |
| 德国 | 德 | en-US，de-DE |
| 加纳 | 生长激素 | zh-CN |
| 直布罗陀 | GI （地理标志） | zh-CN |
| 希腊 | GR 系列 | en-US，el-GR |
| 格陵兰 | GL | zh-CN |
| 格林纳达 | GD 系列 | zh-CN |
| 瓜德罗普 | 全科医生 | zh-CN |
| 关岛 | 古 | zh-CN |
| 危地马拉 | 燃气轮机 | en-US，es-ES |
| 格恩西岛 | GG系列 | zh-CN |
| 几内亚 | GN | zh-CN |
| 几内亚比绍 | 毛球 | zh-CN |
| 圭亚那 | GY | zh-CN |
| 海地 | HT 系列 | zh-CN |
| 赫德岛和麦当劳群岛 | HM | zh-CN |
| 洪都拉斯 | HN 系列 | en-US，es-ES |
| 香港特别行政区 | 香港 | en-US，zh-HK |
| 匈牙利 | 胡 | en-US，hu-HU |
| 冰岛 | 伊斯兰国 | zh-CN |
| 印度 | 在 | en-US，hi-IN |
| 印度尼西亚 | 身份证件 | en-US，id-ID |
| 伊拉克 | 智商 | en-US，ar-SA |
| 爱尔兰 | Internet Explorer (IE) | zh-CN |
| 曼岛 | 即时通讯 | zh-CN |
| 以色列 | 伊利诺伊州 | en-US，he-IL |
| 意大利 | 信息技术 | en-US，it-IT |
| 牙买加 | JM 系列 | zh-CN |
| 扬马延岛 | XJ | zh-CN |
| 日本 | 日本 | en-US，ja-JP |
| 泽西 | 流行性乙型脑炎 | zh-CN |
| 约旦 | 乔 | en-US，ar-SA |
| 哈萨克斯坦 | KZ | en-US，kk-KZ |
| 肯尼亚 | 科 | zh-CN |
| 基里巴斯 | KI | zh-CN |
| 韩国 | 韩元 | en-US，ko-KR |
| 科索沃 | XK | zh-CN |
| 科威特 | 千瓦 | en-US，ar-SA |
| 吉尔吉斯斯坦 | 公斤 | en-US，ru-RU |
| 老挝 | 洛杉矶 | zh-CN |
| 拉托维亚 | 路易威登 | en-US，lv-LV |
| 黎巴嫩 | 磅 | en-US，ar-SA |
| 莱索托 | LS 系列 | zh-CN |
| 利比里亚 | LR的 | zh-CN |
| 利比亚 | 的 | en-US，ar-SA |
| 列支敦士登 | 李 | en-US，de-DE |
| 立陶宛 | LT 系列 | en-US，lt-LT |
| 卢森堡 | 路 | en-US，fr-FR |
| 澳门特别行政区 | 莫 | en-US，zh-HK |
| 马达加斯加 | 毫克 | zh-CN |
| 马拉维 | 兆瓦 | zh-CN |
| 马来西亚 | 我 | en-US，ms-MY |
| 马尔代夫 | MV | zh-CN |
| 马里 | 机器学习 | zh-CN |
| 马耳他 | MT | zh-CN |
| 马绍尔群岛 | MH 系列 | zh-CN |
| 马提尼克 | MQ | zh-CN |
| 毛里塔尼亚 | 先生 | zh-CN |
| 毛里求斯 | 木 | en-US，ar-SA |
| 马约特 | 优兔 | zh-CN |
| 墨西哥 | 墨西哥 | en-US，es-ES |
| 密克罗尼西亚 | 调频 | zh-CN |
| 摩尔多瓦 | MD 系列 | en-US，ro-RO |
| 摩纳哥 | 司仪 | en-US，fr-FR |
| 蒙古 | 锰 | zh-CN |
| 黑山 | 我 | zh-CN |
| 蒙特塞拉特 | 女士 | zh-CN |
| 摩洛哥 | 马萨诸塞州 | en-US、fr-FR、en-US |
| 莫桑比克 | MZ | zh-CN |
| 缅甸 | 毫米 | zh-CN |
| 纳米比亚 | 暂无 | zh-CN |
| 瑙鲁 | 未报告 | zh-CN |
| 尼泊尔 | NP的 | zh-CN |
| 荷兰 | 吧 | en-US，nl-NL |
| 新喀里多尼亚 | 数控 | zh-CN |
| 新西兰 | 新西兰 | zh-CN |
| 尼加拉瓜 | 镍 | en-US，es-ES |
| 尼日尔 | 东北 | zh-CN |
| 尼日利亚 | 议员 | zh-CN |
| 纽埃 | 纽 | zh-CN |
| 诺福克岛 | NF 系列 | zh-CN |
| 北马里亚纳群岛 | MP | zh-CN |
| 北马其顿 | MK | zh-CN |
| 挪威 | 不 | en-US，nb-NO |
| 阿曼 | 噢 | en-US，ar-SA |
| 巴基斯坦 | PK | zh-CN |
| 帕劳 | 战俘 | zh-CN |
| 巴勒斯坦民族权力机构 | 附言 | zh-CN |
| 巴拿马 | 公共广播系统 | en-US，es-ES |
| 巴布亚新几内亚 | PG | zh-CN |
| 巴拉圭 | PY （英语） | en-US，es-ES |
| 秘鲁 | 体育 | en-US，es-ES |
| 菲律宾 | pH值 | zh-CN |
| 皮特凯恩群岛 | PN | zh-CN |
| 波兰 | 波兰 | en-US，pl-PL |
| 葡萄牙 | 铂 | en-US，pt-PT |
| 波多黎各 | 公关 | en-US，en-US |
| 卡塔尔 | 质量保证 | en-US，ar-SA |
| 留尼汪 | Re: | zh-CN |
| 罗马尼亚 | 反渗透 | en-US，ro-RO |
| 俄罗斯 | 俄罗斯 | en-US，ru-RU |
| 卢旺达 | 乌尔曼 | en-US，fr-FR |
| 圣托梅和普林西比 | 圣 | en-US，fr-FR |
| 萨巴 | XS 系列 | zh-CN |
| Saint-Barthélemy | BL 系列 | zh-CN |
| 圣基茨和尼维斯 | KN 系列 | zh-CN |
| 圣卢西亚 | 立法会 | en-US，en-US |
| 圣马丁 | MF 系列 | en-US，en-US |
| 圣皮埃尔和米奎隆 | 下午 | zh-CN |
| 圣文森特和格林纳丁斯 | VC （虚拟货币） | zh-CN |
| 萨摩亚 | WS 系列 | zh-CN |
| 圣马力诺 | SM 系列 | zh-CN |
| 沙特阿拉伯 | SA | zh-CN |
| 塞内加尔 | 锡 | en-US，fr-FR |
| 塞尔维亚 | RS 系列 | en-US、sr-Latn-RS、en-US |
| 塞舌尔 | SC | zh-CN |
| 塞拉利昂 | SL | zh-CN |
| 新加坡 | 新加坡 | en-US，zh-SG |
| 圣尤斯特歇斯 | 氙气 | zh-CN |
| 荷属圣马丁 | SX 系列 | en-US，en-US |
| 斯洛伐克 | SK | en-US，sk-SK |
| 斯洛文尼亚 | 四 | en-US，sl-SI |
| 所罗门群岛 | 某人 | zh-CN |
| 索马里 | 所以 | zh-CN |
| 南非 | 南非 | zh-CN |
| 南乔治亚岛和南桑威奇群岛 | GS系列 | zh-CN |
| 南苏丹 | SS | zh-CN |
| 西班牙 | ES （英语） | en-US、es-ES、en-US、en-US |
| 斯里兰卡 | 力劲 | zh-CN |
| 圣赫勒拿、阿森松与特里斯坦达库尼亚 | 上海 | zh-CN |
| 苏里南 | 锶 | zh-CN |
| 斯瓦尔巴岛 | SJ | zh-CN |
| 瑞典 | 硒 | en-US，sv-SE |
| 瑞士 | 中文 | en-US、fr-FR、en-US、en-US |
| 台湾 | 台湾 | en-US，zh-HK |
| 塔吉克斯坦 | TJ | zh-CN |
| 坦桑尼亚 | TZ | zh-CN |
| 泰国 | TH 系列 | en-US，th-TH |
| Timor-Leste | 三叶草 | zh-CN |
| 多哥 | TG | zh-CN |
| 托克劳 | TK | zh-CN |
| 汤加 | 自 | zh-CN |
| 特立尼达和多巴哥 | TT | zh-CN |
| 突尼斯 | TN （田纳西州） | en-US、fr-FR、en-US |
| 土耳其 | TR 系列 | en-US，tr-TR |
| 土库曼斯坦 | TM | zh-CN |
| 土耳其和凯科斯群岛 | TC 系列 | zh-CN |
| 图瓦卢 | 电视 | zh-CN |
| 美国边远岛屿 | UM （简体中文） | zh-CN |
| 美属维尔京群岛 | 六 | zh-CN |
| 乌干达 | UG | zh-CN |
| 乌克兰 | UA | en-US，uk-UA |
| 阿拉伯联合酋长国 | AE | en-US，ar-SA |
| 英国 | 国标 | zh-CN |
| 美国 | 美国 | zh-CN |
| 乌拉圭 | UY | en-US，es-ES |
| 乌兹别克斯坦 | UZ | en-US，ru-RU |
| 瓦努阿图 | VU | zh-CN |
| 梵蒂冈城 | VA （弗吉尼亚州） | zh-CN |
| 委内瑞拉 | VE 系列 | en-US，es-ES |
| 越南 | VN （越南） | en-US，vi-VN |
| 瓦利斯和富图纳 | WF 系列 | zh-CN |
| 也门 | 你们 | en-US，ar-SA |
| 赞比亚 | ZM 系列 | zh-CN |
| 津巴布韦 | ZW | zh-CN |