Obter uma lista de categorias de oferta por mercadoGet a list of offer categories by market

Aplica-se a:Applies to:

  • Partner CenterPartner Center
  • Partner Center operado pela 21VianetPartner Center operated by 21Vianet
  • Partner Center do Microsoft Cloud GermanyPartner Center for Microsoft Cloud Germany
  • Partner Center do Microsoft Cloud for US GovernmentPartner Center for Microsoft Cloud for US Government

Este artigo descreve como obter uma coleção que contém todas as categorias de oferta em um determinado país/região e localidade.This article describes how to get a collection that contains all the offer categories in a given country/region and locale.

Pré-requisitosPrerequisites

  • Credenciais, conforme descrito em Autenticação do Partner Center.Credentials as described in Partner Center authentication. Esse cenário dá suporte à autenticação com aplicativos autônomos e aplicativos + credenciais de usuário.This scenario supports authentication with both standalone App and App+User credentials.

C#C#

Para obter uma lista de categorias de oferta em um determinado país/região e localidade:To get a list of offer categories in a given country/region and locale:

  1. Use sua coleção IAggregatePartner. Operations para chamar o método with () em um determinado contexto.Use your IAggregatePartner.Operations collection to call the With() method on a given context.

  2. Inspecione a propriedade OfferCategories do objeto resultante.Inspect the OfferCategories property of the resulting object.

// IAggregatePartner partnerOperations;

ResourceCollection<OfferCategory> offerCategoryResults = partnerOperations.With(RequestContextFactory.Instance.Create()).OfferCategories.ByCountry("US").Get();

Para obter um exemplo, consulte o seguinte:For an example, see the following:

Solicitação RESTREST request

Sintaxe da solicitaçãoRequest syntax

MétodoMethod URI da solicitaçãoRequest URI
GETGET {baseURL}/v1/offercategories? Country = {país-ID} http/1.1{baseURL}/v1/offercategories?country={country-id} HTTP/1.1

Parâmetro do URIURI parameter

Esta tabela lista os parâmetros de consulta necessários para obter as categorias de oferta.This table lists the required query parameters to get the offer categories.

NomeName TipoType ObrigatórioRequired DescriçãoDescription
identificação de paíscountry-id cadeia de caracteresstring SY O ID do país/região.The country/region ID.

Cabeçalhos de solicitaçãoRequest headers

Uma ID de localidade formatada como uma cadeia de caracteres é necessária.A locale-id formatted as a string is required.

Para obter mais informações, confira Cabeçalhos REST do Partner Center.For more information, see Partner Center REST headers.

Corpo da solicitaçãoRequest body

Nenhum.None.

Exemplo de solicitaçãoRequest example

GET https://api.partnercenter.microsoft.com/v1/offercategories?country=<country-id> HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 4fb54bd5-a4c3-4fac-955f-9b6e3436d606
MS-CorrelationId: 47882653-eaed-4a2e-a552-1070a3fa1089
X-Locale: <locale-id>
Connection: Keep-Alive

Resposta RESTREST response

Se for bem-sucedido, esse método retornará uma coleção de recursos OfferCategory no corpo da resposta.If successful, this method returns a collection of OfferCategory resources in the response body.

Códigos de êxito e de erro de respostaResponse success and error codes

Cada resposta vem com um código de status HTTP que indica êxito ou falha e informações de depuração adicionais.Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use uma ferramenta de rastreamento de rede para ler esse código, o tipo de erro e os parâmetros adicionais.Use a network trace tool to read this code, error type, and additional parameters. Para obter uma lista completa, consulte códigos de erro.For a full list, see Error Codes.

Exemplo de respostaResponse example

HTTP/1.1 200 OK
Content-Length: 1184
Content-Type: application/json
MS-CorrelationId: 47882653-eaed-4a2e-a552-1070a3fa1089
MS-RequestId: 4fb54bd5-a4c3-4fac-955f-9b6e3436d606
Date: Thu, 26 Nov 2015 00:07:10 GMT

{
    "totalCount": 4,
    "items": [{
        "id": "Enterprise_Key",
        "name": "Enterprise",
        "rank": 20,
        "locale": "en-us",
        "country": "US",
        "attributes": {
            "objectType": "OfferCategory"
        }
    },
    {
        "id": "SmallBusiness_Key",
        "name": "SmallBusiness",
        "rank": 30,
        "locale": "en-us",
        "country": "US",
        "attributes": {
            "objectType": "OfferCategory"
        }
    },
    {
        "id": "Government_Key",
        "name": "Government",
        "rank": 40,
        "locale": "en-us",
        "country": "US",
        "attributes": {
            "objectType": "OfferCategory"
        }
    },
    {
        "id": "Internal_Key",
        "name": "Internal",
        "rank": 100,
        "locale": "en-us",
        "country": "US",
        "attributes": {
            "objectType": "OfferCategory"
        }
    }],
    "attributes": {
        "objectType": "Collection"
    }
}