Microsoft 顧客契約テンプレートのダウンロード リンクを取得する
適用対象: パートナー センター
適用対象外: 21Vianet が運営するパートナー センター | Microsoft Cloud for US Government のパートナー センター
AgreementDocument リソースは現在、Microsoft パブリック クラウドでのみパートナー センターでサポートされています。
この記事では、顧客の国/地域と言語に基づいて、Microsoft 顧客契約 テンプレートをダウンロードするためのリンクを取得する方法について説明します。
前提条件
パートナー センター .NET SDK を使用している場合は、バージョン 1.14 以降が必要です。
重要
2023 年 6 月の時点で、最新のパートナー センター .NET SDK リリース 3.4.0 がアーカイブされるようになりました。 SDK リリースは、有用な情報が記載された readme ファイルと一緒に GitHub からダウンロードできます。
パートナーの皆様には、パートナー センター REST API を引き続き使用することをお勧めします。
パートナー センターの認証に関するページで説明している資格情報。 このシナリオでは、アプリとユーザー認証のみがサポートされます。
Microsoft 顧客契約 テンプレートが適用される顧客の国/地域。
Microsoft 顧客契約 テンプレートをローカライズする言語。
重要
- Microsoft 顧客契約は国/地域固有です。 Microsoft 顧客契約 テンプレートをダウンロードするためのリンクを要求する場合は、必ず顧客の場所に基づいて適切な国/地域を指定してください。 または、サポートされている国/地域の一覧、サポートされている国/地域と言語の一覧を参照してください。
- 一部の国/地域では、Microsoft 顧客契約は複数の言語で利用できます。 カスタマー エクスペリエンスを最大限に高めるには、顧客のニーズに最も適した言語を選択します。 サポートされている言語の一覧については、サポートされている国/地域と言語の一覧を参照してください。
- このメソッドは、Microsoft 顧客契約でのみサポートされます。
.NET
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 顧客契約の契約メタデータを取得する」を参照してください。
AgreementDocument リソースをフェッチする REST 要求を作成します。 例については、要求構文の例を参照してください。 次の情報を指定する必要があります。
- Microsoft 顧客契約の templateId
- Microsoft 顧客契約 テンプレートが適用される国/地域
- Microsoft 顧客契約 テンプレートをローカライズする言語
要求の構文
このリソースには、次の要求構文を使用します。
| メソッド | 要求 URI |
|---|---|
| GET | {baseURL}/v1/agreementtemplates/{agreement-template-id}/document?language={language}>country={country} HTTP/1.1 |
URI パラメーター
要求では、次の URI パラメーターを使用できます。
| 名前 | タイプ | Required | 説明 |
|---|---|---|---|
| agreement-template-id | string | はい | 契約の種類の一意識別子。 Microsoft 顧客契約の契約メタデータを取得することで、Microsoft 顧客契約の templateId を取得できます。 詳細については、「Microsoft 顧客契約の契約メタデータを取得する」を参照してください。 このパラメーターでは、大文字と小文字が 区別されます。 |
| country | string | いいえ | 契約テンプレートが適用される国/地域を示します。 パラメーターが指定されていない場合、クエリの既定値 は US になります。 サポートされている国/地域コードの一覧については、サポートされている国/地域と言語の一覧を参照してください。 |
| 言語 | string | いいえ | 契約テンプレートをローカライズする言語を示します。 パラメーターが指定されていない場合、または指定された国/地域に対して 指定された国/地域コードがサポートされていない場合、クエリの既定値は 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 文字列が含まれています。 クエリを実行するたびに、異なるリンクが返されます。 このリンクは 5 分後に期限切れになります。
応答の成功とエラーのコード
各応答には、成功または失敗とその他のデバッグ情報を示す 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"
}
サポートされている国/地域と言語の一覧
重要
国/地域コード のプロパティでは、大文字と小文字が区別されます。 次の表で指定されている正しい大文字と小文字を必ず使用してください。
| 国/地域 | 国番号 | サポートされている言語コード |
|---|---|---|
| オーランド諸島 | AX | ja-JP |
| アフガニスタン | AF | ja-JP |
| アルバニア | AL | ja-JP |
| アルジェリア | DZ | en-US、fr-FR、en-US |
| 米領サモア | AS | ja-JP |
| アンドラ | AD | ja-JP |
| アンゴラ | AO | en-US、pt-PT |
| アンギラ | AI | ja-JP |
| 南極 | AQ | ja-JP |
| アンティグア・バーブーダ | AG | ja-JP |
| アルゼンチン | AR | en-US、es-ES |
| アルメニア | AM | ja-JP |
| アルバ | AW | ja-JP |
| オーストラリア | AU | ja-JP |
| オーストリア | AT | en-US、de-DE |
| アゼルバイジャン | AZ | ja-JP |
| バハマ | BS | ja-JP |
| バーレーン | BH | en-US、ar-SA |
| バングラデシュ | BD | ja-JP |
| バルバドス | BB | ja-JP |
| ベラルーシ | BY | en-US、ru-RU |
| ベルギー | BE | en-US、nl-NL |
| ベリーズ | BZ | en-US、es-ES |
| ベナン | BJ | ja-JP |
| バミューダ | BM | ja-JP |
| ブータン | BT | ja-JP |
| ボリビア | BO | en-US、es-ES |
| ボネール島 | BQ | ja-JP |
| ボスニア・ヘルツェゴビナ | BA | ja-JP |
| ボツワナ | BW | ja-JP |
| ブーベ島 | BV | ja-JP |
| ブラジル | BR | en-US、pt-BR |
| 英領インド洋地域 | IO | ja-JP |
| 英領ヴァージン諸島 | VG | ja-JP |
| ブルネイ | BN | ja-JP |
| ブルガリア | BG | en-US、bg-BG |
| ブルキナファソ | BF | ja-JP |
| ブルンジ | BI | ja-JP |
| コートジボワール | CI | en-US、fr-FR |
| カーボベルデ | CV | en-US、pt-PT |
| カンボジア | KH | ja-JP |
| カメルーン | CM | en-US、fr-FR |
| カナダ | CA | en-US、fr-FR |
| ケイマン諸島 | KY | en-US、en-US |
| 中央アフリカ共和国 | CF | ja-JP |
| チャド | TD | ja-JP |
| チリ | CL | en-US、es-ES |
| クリスマス島 | CX | ja-JP |
| ココス (キーリング) 諸島 | Cc | ja-JP |
| コロンビア | CO | en-US、es-ES |
| コモロ | KM | ja-JP |
| コンゴ民主共和国 | CD | ja-JP |
| コンゴ共和国 | CG | ja-JP |
| クック諸島 | CK | ja-JP |
| コスタリカ | CR | en-US、es-ES |
| クロアチア | HR | en-US、hr-HR |
| キュラソー | CW | ja-JP |
| キプロス | CY | ja-JP |
| チェコ | CZ | en-US、cs-CZ |
| デンマーク | DK | en-US、da-DK |
| ジブチ | DJ | ja-JP |
| ドミニカ国 | DM | ja-JP |
| ドミニカ共和国 | 推奨 | en-US、es-ES |
| エクアドル | EC | ja-JP |
| エジプト | EG | en-US、ar-SA |
| エルサルバドル | SV | en-US、es-ES |
| 赤道ギニア | GQ | ja-JP |
| エリトリア | ER | ja-JP |
| エストニア | EE | en-US、et-Enterprise Edition |
| スワジランド | SZ | ja-JP |
| エチオピア | ET | ja-JP |
| フォークランド諸島 | FK | ja-JP |
| フェロー諸島 | FO | ja-JP |
| フィジー | FJ | ja-JP |
| フィンランド | FI | en-US、fi-FI |
| フランス | FR | en-US、fr-FR |
| 仏領ギアナ | GF | en-US、fr-FR |
| 仏領ポリネシア | PF | ja-JP |
| フランス領南方・南極地域 | TF | ja-JP |
| ガボン | GA | ja-JP |
| ガンビア | GM | ja-JP |
| ジョージア | GE | ja-JP |
| ドイツ | DE | en-US、de-DE |
| ガーナ | GH | ja-JP |
| ジブラルタル | GI | ja-JP |
| ギリシャ | GR | en-US、el-GR |
| グリーンランド | GL | ja-JP |
| グレナダ | GD | ja-JP |
| グアドループ | GP | ja-JP |
| グアム | GU | ja-JP |
| グアテマラ | GT | en-US、es-ES |
| ガーンジー | GG | ja-JP |
| ギニア | GN | ja-JP |
| ギニアビサウ | GW | ja-JP |
| ガイアナ | GY | ja-JP |
| ハイチ | HT | ja-JP |
| ハード島とマクドナルド諸島 | HM | ja-JP |
| ホンジュラス | HN | en-US、es-ES |
| 中華人民共和国香港特別行政区 | HK | en-US、zh-HK |
| ハンガリー | HU | en-US、hu-HU |
| アイスランド | IS | ja-JP |
| インド | IN | en-US、hi-IN |
| インドネシア | ID | en-US、id-ID |
| イラク | IQ | en-US、ar-SA |
| アイルランド | IE | ja-JP |
| マン島 | IM | ja-JP |
| イスラエル | IL | en-US、he-IL |
| イタリア | IT | en-US,it-IT |
| ジャマイカ | JM | ja-JP |
| ヤンマイエン島 | XJ | ja-JP |
| 日本 | JP | en-US、ja-JP |
| ジャージー | JE | ja-JP |
| ヨルダン | JO | en-US、ar-SA |
| カザフスタン | KZ | en-US,kk-KZ |
| ケニア | KE | ja-JP |
| キリバス | KI | ja-JP |
| 韓国 | KR | en-US、ko-KR |
| コソボ | XK | ja-JP |
| クウェート | KW | en-US、ar-SA |
| キルギスタン | KG | en-US、ru-RU |
| ラオス | LA | ja-JP |
| ラトビア | LV | en-US、lv-LV |
| レバノン | LB | en-US、ar-SA |
| レソト | LS | ja-JP |
| リベリア | LR | ja-JP |
| リビア | 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 | ja-JP |
| マラウイ | MW | ja-JP |
| マレーシア | MY | en-US、ms-MY |
| モルディブ | MV | ja-JP |
| マリ | ML | ja-JP |
| マルタ | MT | ja-JP |
| マーシャル諸島 | MH | ja-JP |
| マルティニーク | MQ | ja-JP |
| モーリタニア | MR | ja-JP |
| モーリシャス | MU | en-US、ar-SA |
| マヨット | YT | ja-JP |
| メキシコ | MX | en-US、es-ES |
| ミクロネシア | FM | ja-JP |
| モルドバ | MD | en-US、ro-RO |
| モナコ | MC | en-US、fr-FR |
| モンゴル | MN | ja-JP |
| モンテネグロ | ME | ja-JP |
| モントセラト | MS | ja-JP |
| モロッコ | MA | en-US、fr-FR、en-US |
| モザンビーク | MZ | ja-JP |
| ミャンマー | MM | ja-JP |
| ナミビア | NA | ja-JP |
| ナウル | NR | ja-JP |
| ネパール | NP | ja-JP |
| オランダ | NL | en-US、nl-NL |
| ニューカレドニア | NC | ja-JP |
| ニュージーランド | NZ | ja-JP |
| ニカラグア | NI | en-US、es-ES |
| ニジェール | NE | ja-JP |
| ナイジェリア | NG | ja-JP |
| ニウエ | NU | ja-JP |
| ノーフォーク島 | NF | ja-JP |
| 北マリアナ諸島 | MP | ja-JP |
| 北マケドニア | MK | ja-JP |
| ノルウェー | 使用不可 | en-US、nb-NO |
| オマーン | OM | en-US、ar-SA |
| パキスタン | PK | ja-JP |
| パラオ | PW | ja-JP |
| パレスチナ自治政府 | PS | ja-JP |
| パナマ | PA | en-US、es-ES |
| パプアニューギニア | PG | ja-JP |
| パラグアイ | PY | en-US、es-ES |
| ペルー | PE | en-US、es-ES |
| フィリピン | PH | ja-JP |
| ピトケアン諸島 | PN | ja-JP |
| ポーランド | PL | en-US、pl-PL |
| ポルトガル | PT | en-US、pt-PT |
| プエルトリコ | PR | en-US、en-US |
| カタール | QA | en-US、ar-SA |
| レユニオン | RE | ja-JP |
| ルーマニア | RO | en-US、ro-RO |
| ロシア | RU | en-US、ru-RU |
| ルワンダ | RW | en-US、fr-FR |
| サントメ・プリンシペ | ST | en-US、fr-FR |
| サバ島 | XS | ja-JP |
| サン・バルテルミー | BL | ja-JP |
| セントクリストファー・ネーヴィス | KN | ja-JP |
| セントルシア | LC | en-US、en-US |
| サン・マルタン | MF | en-US、en-US |
| サンピエール島・ミクロン島 | PM | ja-JP |
| セントビンセント及びグレナディーン諸島 | VC | ja-JP |
| サモア | WS | ja-JP |
| サンマリノ | SM | ja-JP |
| サウジアラビア | SA | ja-JP |
| セネガル | SN | en-US、fr-FR |
| セルビア | RS | en-US、sr-Latn-RS、en-US |
| セーシェル | SC | ja-JP |
| シエラレオネ | SL | ja-JP |
| シンガポール | SG | en-US、zh-SG |
| シント・ユースタティウス島 | XE | ja-JP |
| シント・マールテン | SX | en-US、en-US |
| スロバキア | SK | en-US、sk-SK |
| スロベニア | SI | en-US、sl-SI |
| ソロモン諸島 | SB | ja-JP |
| ソマリア | SO | ja-JP |
| 南アフリカ | ZA | ja-JP |
| サウスジョージア・サウスサンドウィッチ諸島 | GS | ja-JP |
| 南スーダン | SS | ja-JP |
| スペイン | ES | en-US、es-ES、en-US、en-US |
| スリランカ | LK | ja-JP |
| セントヘレナ、アセンションおよびトリスタンダクーニャ | SH | ja-JP |
| スリナム | SR | ja-JP |
| スバールバル諸島 | SJ | ja-JP |
| スウェーデン | SE | en-US、sv-Standard Edition |
| スイス | CH | en-US、fr-FR、en-US、en-US |
| 台湾 | TW | en-US、zh-HK |
| タジキスタン | TJ | ja-JP |
| タンザニア | TZ | ja-JP |
| タイ | TH | en-US、th-TH |
| ティモール・レステ | TL | ja-JP |
| トーゴ | TG | ja-JP |
| トケラウ | TK | ja-JP |
| トンガ | TO | ja-JP |
| トリニダード・トバゴ | TT | ja-JP |
| チュニジア | TN | en-US、fr-FR、en-US |
| トルコ | TR | en-US、tr-TR |
| トルクメニスタン | TM | ja-JP |
| タークス・カイコス諸島 | TC | ja-JP |
| ツバル | TV | ja-JP |
| 米国領有小離島 | UM | ja-JP |
| 米領バージン諸島 | VI | ja-JP |
| ウガンダ | UG | ja-JP |
| ウクライナ | UA | en-US、uk-UA |
| アラブ首長国連邦 | AE | en-US、ar-SA |
| 英国 | GB | ja-JP |
| 米国 | US | ja-JP |
| ウルグアイ | UY | en-US、es-ES |
| ウズベキスタン | UZ | en-US、ru-RU |
| バヌアツ | VU | ja-JP |
| バチカン | VA | ja-JP |
| ベネズエラ | VE | en-US、es-ES |
| ベトナム | VN | en-US、vi-VN |
| ウォリス・フツナ | WF | ja-JP |
| イエメン | YE | en-US、ar-SA |
| ザンビア | ZM | ja-JP |
| ジンバブエ | ZW | ja-JP |