Obter dados de audiência

Artigo
07/08/2024

Use o método a seguir nas APIs de Hardware da Microsoft para obter os públicos-alvo aplicáveis à sua organização. Os públicos-alvo permitem restringir uma publicação a computadores com uma configuração específica. Por exemplo, uma implantação de teste pode ser entregue somente a clientes com uma chave do Registro específica instalada.

https://manage.devcenter.microsoft.com/v2.0/my/hardware/audiences

Antes de usar esses métodos, o produto e o envio já deve existir em sua conta do Centro de Desenvolvimento. Para criar ou gerenciar envios de produtos, consulte os métodos em Gerenciar envios de produtos.

Descrição	Método	URI
Obtenha uma lista de públicos-alvo aplicáveis à sua organização.	GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/audiences`

Pré-requisitos

Se você ainda não tiver feito isso, conclua todos os pré-requisitos para as APIs de Hardware da Microsoft antes de tentar usar qualquer um desses métodos.

Recursos de dados

Os métodos das APIs de Hardware da Microsoft para obter dados de etiqueta de remessa usam os seguintes recursos de dados JSON.

Recurso de público-alvo

Esse recurso representa um público-alvo aplicável à sua organização.

{
  "id": "9f4f44d8-bfec-48c6-a02c-2d9ea220f6e2",
  "name": "My Custom Audience",
  "description": "Matches machines that have the following registry key: HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\FOO-BAR",
  "audienceName": "Sample_Audience_Key"
}

Esse recurso tem os seguintes valores

Valor	Type	Descrição
id	string	A ID do público. Este é o valor que será recebido ou enviado na etiqueta de envio.
name	string	Nome amigável do público
descrição	string	Descrição do público
nome do público	string	Nome do público

Solicitar

Esse método tem a seguinte sintaxe.

Método	URI da solicitação
GET	`https://manage.devcenter.microsoft.com/v2.0/my/hardware/audience`

Cabeçalho da solicitação

Cabeçalho	Tipo	Descrição
Autorização	string	Obrigatória. O token de acesso da ID do Microsoft Entra no formato Token> de portador<.
accept	string	Opcional. Especifica o tipo de conteúdo. O valor permitido é "application/json"

Parâmetros da solicitação

Não forneça parâmetros de solicitação para esse método.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Exemplos de solicitação

O exemplo a seguir demonstra como recuperar informações sobre públicos-alvo aplicáveis à sua organização.

GET https://manage.devcenter.microsoft.com/v2.0/my/hardware/audience HTTP/1.1
Authorization: Bearer <your access token>

Resposta

O exemplo a seguir demonstra o corpo da resposta JSON retornado por uma solicitação bem-sucedida para todos os públicos-alvo aplicáveis à sua organização. Os detalhes sobre os valores no corpo da resposta aparecem na tabela após o exemplo.

{
  "value": [
    {
      "id": "9f4f44d8-bfec-48c6-a02c-2d9ea220f6e2",
      "name": "Test Registry Key",
      "description": "Matches machines that have the following registry key: HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\Test Drivers - use at own risk",
      "audienceName": "Test_Registry_Key"
    },
    {
      "id": "10415bba-3572-421b-a3de-d0d347bace5f",
      "name": "Test Audience 2",
      "description": "Additional Audience",
      "audienceName": "Test_Audeince_2"
    }
  ],
  "links": [
    {
      "href": "https://manage.devcenter..microsoft.com/api/v1/hardware/audiences",
      "rel": "self",
      "method": "GET"
    }
  ]
}