Obter análises de subscrições agrupadas por datas ou termos

Artigo
03/08/2023

Aplica-se a: Centro de Parceiros | Centro de Parceiros operado pela 21Vianet | Centro de Parceiros para Microsoft Cloud for US Government

Como obter informações de análise de subscrições para os seus clientes agrupados por datas ou termos.

Pré-requisitos

Credenciais conforme descrito na autenticação do Centro de Parceiros. Este cenário suporta a autenticação apenas com credenciais de utilizador.

Pedido REST

Sintaxe do pedido

Método	URI do pedido
GET	{baseURL}/partner/v1/analytics/subscriptions?groupby={groupby_queries}

Parâmetros URI

Utilize os seguintes parâmetros de caminho necessários para identificar a sua organização e agrupar os resultados.

Nome	Tipo	Necessário	Descrição
groupby_queries	pares de cadeias e dateTime	Sim	Os termos e datas para filtrar o resultado.

Sintaxe GroupBy

O grupo por parâmetro tem de ser composto como uma série de valores de campo separados por vírgulas.

Um exemplo não codificado tem o seguinte aspeto:

?groupby=termField1,dateField1,termField2

A tabela seguinte mostra uma lista dos campos suportados para agrupar por.

Campo	Tipo	Description
customerTenantId	string	Uma cadeia formatada por GUID que identifica o inquilino do cliente.
customerName	string	O nome do cliente.
customerMarket	string	O país/região em que o cliente faz negócios.
ID	string	Uma cadeia formatada por GUID que identifica a subscrição.
status	string	O estado da subscrição. Os valores suportados são: "ATIVO", "SUSPENSO" ou "DESAPROVISIONADO".
productName	string	O nome do produto.
subscriptionType	string	O tipo de subscrição. Nota: este campo é sensível às maiúsculas e minúsculas. Os valores suportados são: "Office", "Azure", "Microsoft365", "Dynamics", "EMS".
autoRenewEnabled	Booleano	Um valor que indica se a subscrição é renovada automaticamente.
partnerId	string	O PartnerID. Para um revendedor direto, este parâmetro será o PartnerID do parceiro. Para um revendedor indireto, este parâmetro será o PartnerID do revendedor indireto.
friendlyName	string	O nome da subscrição.
partnerName	string	Nome do parceiro para o qual a subscrição foi comprada
providerName	string	Quando a transação de subscrição é para o revendedor indireto, o nome do fornecedor é o fornecedor indireto que comprou a subscrição.
creationDate	cadeia no formato de data/hora UTC	A data em que a subscrição foi criada.
effectiveStartDate	cadeia no formato de data/hora UTC	A data de início da subscrição.
commitmentEndDate	cadeia no formato de data/hora UTC	A data em que a subscrição termina.
currentStateEndDate	cadeia no formato de data/hora UTC	A data em que o estado atual da subscrição será alterado.
trialToPaidConversionDate	cadeia no formato de data/hora UTC	A data em que a subscrição converte da versão de avaliação para paga. O valor predefinido é nulo.
trialStartDate	cadeia no formato de data/hora UTC	A data em que o período de avaliação da subscrição foi iniciado. O valor predefinido é nulo.
lastUsageDate	cadeia no formato de data/hora UTC	A data em que a subscrição foi utilizada pela última vez. O valor predefinido é nulo.
deprovisionedDate	cadeia no formato de data/hora UTC	A data em que a subscrição foi desaprovisionada. O valor predefinido é nulo.
lastRenewalDate	cadeia no formato de data/hora UTC	A data em que a subscrição foi renovada pela última vez. O valor predefinido é nulo.

Filtrar campos

A tabela seguinte lista os campos de filtro opcionais e as respetivas descrições:

Campo	Tipo	Description
top	int	O número de linhas de dados a devolver no pedido. Se o valor não for especificado, o valor máximo e o valor predefinido são 10000. Se existirem mais linhas na consulta, o corpo da resposta inclui uma ligação seguinte que pode utilizar para pedir a página seguinte de dados.
ignorar	int	O número de linhas a ignorar na consulta. Utilize este parâmetro para percorrer grandes conjuntos de dados. Por exemplo, top=10000 e skip=0 obtém as primeiras 10 000 linhas de dados, top=10000 e skip=10000 obtém as próximas 10 000 linhas de dados.
filter	string	Uma ou mais instruções que filtram as linhas na resposta. Cada instrução de filtro contém um nome de campo do corpo da resposta e um valor associado ao `eq`operador , `ne`ou para determinados campos `contains` . As instruções podem ser combinadas com `and` ou `or`. Os valores das cadeias de carateres têm de estar entre plicas no parâmetro de filtro. Consulte a secção seguinte para obter uma lista de campos que podem ser filtrados e os operadores suportados com esses campos.
aggregationLevel	string	Especifica o intervalo de tempo para o qual obter dados agregados. Pode ser uma das seguintes cadeias: dia, semana ou mês. Se o valor não for especificado, a predefinição é dateRange. Nota: este parâmetro aplica-se apenas quando um campo de data é transmitido como parte do parâmetro groupBy.
groupBy	string	Uma instrução que aplica a agregação de dados apenas aos campos especificados.

Cabeçalhos do pedido

Para obter mais informações, veja Cabeçalhos REST do Centro de Parceiros.

Corpo do pedido

Nenhum.

Exemplo de pedido

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions?groupBy=subscriptionType
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
Content-Type: application/json
Content-Length: 0

Resposta do REST

Se for bem-sucedido, o corpo da resposta contém uma coleção de recursos de Subscrição agrupados pelos termos e datas especificados.

Códigos de erro e êxito da resposta

Cada resposta inclui um código de estado HTTP que indica êxito ou falha e informações adicionais de depuração. Utilize uma ferramenta de rastreio de rede para ler este código, tipo de erro e parâmetros adicionais. Para obter a lista completa, veja Códigos de Erro.

Exemplo de resposta

HTTP/1.1 200 OK
Content-Length: 177
Content-Type: application/json; charset=utf-8
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: aaaa0000-bb11-2222-33cc-444444dddddd
{
  "Value": [
    {
      "subscriptionType": "Azure",
      "subscriptionCount": "63",
      "licenseCount": "0"
    },
    {
      "subscriptionType": "Dynamics",
      "subscriptionCount": "62",
      "licenseCount": "405"
    },
    {
      "subscriptionType": "EMS",
      "subscriptionCount": "39",
      "licenseCount": "193"
    },
    {
      "subscriptionType": "M365",
      "subscriptionCount": "2",
      "licenseCount": "5"
    },
    {
      "subscriptionType": "Office",
      "subscriptionCount": "906",
      "licenseCount": "7485"
    },
    {
      "subscriptionType": "UNKNOWN",
      "subscriptionCount": "104",
      "licenseCount": "439"
    },
    {
      "subscriptionType": "Windows",
      "subscriptionCount": "2",
      "licenseCount": "2"
    }
  ],
  "@nextLink": null,
  "TotalCount": 7
}

Ver também

Análise do Centro de Parceiros – Recursos

Partilhar via