Získání odkazu ke stažení pro šablonu Smlouva se zákazníkem Microsoftu

Článek
03/05/2024

Platí pro: Partnerské centrum

Nevztahuje se na: Partnerské centrum provozované společností 21Vianet | Partnerské centrum pro Microsoft Cloud pro státní správu USA

Prostředek AgreementDocument v současné době podporuje Partnerské centrum pouze ve veřejném cloudu Microsoftu.

Tento článek popisuje, jak získat odkaz ke stažení šablony Smlouva se zákazníkem Microsoftu na základě země/oblasti a jazyka zákazníka.

Požadavky

Pokud používáte sadu .NET SDK partnerského centra, vyžaduje se verze 1.14 nebo novější.

Důležité

Od června 2023 se teď archivuje nejnovější verze sady .NET SDK partnerského centra 3.4.0. Vydání sady SDK si můžete stáhnout z GitHubu spolu se souborem readme, který obsahuje užitečné informace.

Doporučujeme, aby partneři dál používali rozhraní REST API Partnerského centra.
Přihlašovací údaje popsané v ověřování v Partnerském centru Tento scénář podporuje pouze ověřování aplikací a uživatelů.
Země nebo oblast zákazníka, na kterou se šablona Smlouva se zákazníkem Microsoftu vztahuje.
Jazyk, ve kterém má být šablona Smlouva se zákazníkem Microsoftu lokalizována.

Důležité

Smlouva se zákazníkem Microsoftu je specifická pro zemi nebo oblast. Při vyžádání odkazu ke stažení šablony Smlouva se zákazníkem Microsoftu nezapomeňte zadat správnou zemi nebo oblast na základě umístění zákazníka. nebo seznam podporovaných zemí/oblastí, přečtěte si seznam podporovaných zemí/oblastí a jazyků.
V některých zemích nebo oblastech je Smlouva se zákazníkem Microsoftu k dispozici v několika jazycích. Nejlepší prostředí pro zákazníky dosáhnete, když vyberete jazyk, který nejlépe odpovídá potřebám zákazníka. Seznam podporovaných jazyků najdete v seznamu podporovaných zemí a oblastí a jazyků.
Tato metoda je podporována pouze u Smlouva se zákazníkem Microsoftu.

.NET

Načtení odkazu pro stažení šablony Smlouva se zákazníkem Microsoftu:

Načtěte metadata smlouvy pro Smlouva se zákazníkem Microsoftu. Je nutné získat id šablony Smlouva se zákazníkem Microsoftu. Další informace najdete v tématu Získání metadat smlouvy pro Smlouva se zákazníkem Microsoftu.

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

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

Použijte kolekci IAggregatePartner.AgreementTemplates.
Zavolejte Metodu ById a zadejte templateId Smlouva se zákazníkem Microsoftu.
Načtěte vlastnost Document .
Zavolejte metodu ByCountry a zadejte zemi nebo oblast zákazníka, na kterou se vztahuje šablona smlouvy. Pokud metoda není zadaná, dotaz se ve výchozím nastavení nastaví na USA . Seznam podporovaných kódů zemí nebo oblastí najdete v seznamu podporovaných zemí/oblastí a jazyků. Tato metoda rozlišují malá a velká písmena.
Zavolejte Metodu ByLanguage a zadejte jazyk, ve kterém má být šablona smlouvy lokalizována. Pokud není zadaná metoda zadaná nebo zadaný kód země/oblasti není pro zadanou zemi nebo oblast, ve výchozím nastavení se dotaz nastaví jako en-US . Seznam podporovaných kódů jazyků najdete v seznamu podporovaných zemí a oblastí a jazyků.

Volejte metodu Get nebo GetAsync .

// IAggregatePartner partnerOperations;

string customerCountry = "US";

string languageForLocalization = "en-US";

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

Kompletní ukázku najdete ve třídě GetAgreementDetails z projektu testovací aplikace konzoly.

Požadavek REST

Načtení odkazu pro stažení šablony Smlouva se zákazníkem Microsoftu:

Načtěte metadata smlouvy pro Smlouva se zákazníkem Microsoftu. Je nutné získat id šablony Smlouva se zákazníkem Microsoftu. Další informace najdete v tématu Získání metadat smlouvy pro Smlouva se zákazníkem Microsoftu.
Vytvořte požadavek REST pro načtení prostředku AgreementDocument. Příklad syntaxe požadavku. Musíte zadat následující informace:
- Id šablony Smlouva se zákazníkem Microsoftu
- Země/oblast, na kterou se šablona Smlouva se zákazníkem Microsoftu vztahuje
- Jazyk, ve kterém by se měla lokalizovat šablona Smlouva se zákazníkem Microsoftu

Syntaxe požadavku

Pro tento prostředek použijte následující syntaxi požadavku:

metoda	Identifikátor URI žádosti
GET	{baseURL}/v1/agreementtemplates/{agreement-template-id}/document?language={language}&country={country} HTTP/1.1

Parametry identifikátoru URI

U požadavku můžete použít následující parametry identifikátoru URI:

Name	Type	Požadováno	Popis
agreement-template-id	string	Ano	Jedinečný identifikátor typu smlouvy. Id šablony pro Smlouva se zákazníkem Microsoftu můžete získat načtením metadat smlouvy pro Smlouva se zákazníkem Microsoftu. Další informace najdete v tématu Získání metadat smlouvy pro Smlouva se zákazníkem Microsoftu. U tohoto parametru se rozlišují malá a velká písmena.
country	string	No	Určuje zemi nebo oblast, na kterou se šablona smlouvy vztahuje. Pokud parametr není zadaný, dotaz se ve výchozím nastavení nastaví na USA . Seznam podporovaných kódů zemí nebo oblastí najdete v seznamu podporovaných zemí/oblastí a jazyků.
jazyk	string	No	Označuje jazyk, ve kterém má být šablona smlouvy lokalizována. Pokud parametr není zadaný nebo kód země/oblasti zadaný v zadané zemi nebo oblasti, ve výchozím nastavení se dotaz nastaví jako en-US . Seznam podporovaných kódů zemí nebo oblastí najdete v seznamu podporovaných zemí/oblastí a jazyků.

Záhlaví žádosti

Další informace najdete v tématu Hlavičky REST Partnerského centra.

Text požadavku

Nezaokrouhlovat.

Příklad požadavku

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: ab993325-1605-4cf4-bac4-fb584142a31b

Odpověď REST

Pokud je tato metoda úspěšná, vrátí prostředek AgreementDocument v textu odpovědi.

Prostředek má vlastnost downloadUri , která obsahuje řetězec adresy URL, který lze použít ke stažení šablony smlouvy. Pokaždé, když vytvoříte dotaz, se vrátí jiný odkaz. Platnost tohoto odkazu vyprší po pěti minutách.

Kódy úspěšnosti a chyb odpovědi

Každá odpověď obsahuje stavový kód HTTP, který označuje úspěch nebo selhání a další informace o ladění.

Ke čtení tohoto kódu, typu chyby a dalších parametrů použijte nástroj pro trasování sítě. Úplný seznam najdete v tématu Kódy chyb REST v Partnerském centru.

Příklad odpovědi

HTTP/1.1 200 OK
Content-Length: 620
Content-Type: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: ab993325-1605-4cf4-bac4-fb584142a31b
{
    "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"
}

Seznam podporovaných zemí/oblastí a jazyků