Search - Get Search POI Category Tree

Referência

Serviço:: Maps

Versão da API:: 1.0

Use para obter uma lista de categorias e subcategorias de PONTOS de Interesse (POI) com suporte.

A Get Search POI Category Tree API é uma solicitação HTTP GET que fornece uma lista completa de categorias e subcategorias de Pontos de Interesse (POI) com suporte, juntamente com suas traduções e sinônimos. O conteúdo retornado pode ser usado para fornecer resultados mais significativos por meio de outras APIs do Serviço de Pesquisa, como Obter Pesquisa POI.

GET https://atlas.microsoft.com/search/poi/category/tree/json?api-version=1.0

Com parâmetros opcionais:

GET https://atlas.microsoft.com/search/poi/category/tree/json?api-version=1.0&language={language}

Parâmetros de URI

Nome Em Obrigatório Tipo Description

Nome	Em	Obrigatório	Tipo	Description
format	path	True	JsonFormat	Formato desejado da resposta. Há suporte apenas para o formato `json`.
api-version	query	True	string	Número de versão da API de Mapas Azure.
language	query		string	Idioma no qual os resultados da pesquisa devem ser retornados. Deve ser uma das marcas de linguagem IETF com suporte, exceto NGT e NGT-Latn. A marca de idioma não diferencia maiúsculas de minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, o idioma padrão é usado (inglês). Consulte Idiomas com suporte para obter detalhes.

format

path

True

JsonFormat

Formato desejado da resposta. Há suporte apenas para o formato json.

api-version

query

True

string

Número de versão da API de Mapas Azure.

language

query

string

Idioma no qual os resultados da pesquisa devem ser retornados. Deve ser uma das marcas de linguagem IETF com suporte, exceto NGT e NGT-Latn. A marca de idioma não diferencia maiúsculas de minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, o idioma padrão é usado (inglês).

Consulte Idiomas com suporte para obter detalhes.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-id		string	Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança Microsoft Entra ID. Ele representa uma ID exclusiva para a conta Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento Azure Mapas. Para usar Microsoft Entra ID segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes.

Respostas

Nome	Tipo	Description
200 OK	PointOfInterestCategoryTreeResult	OK
Other Status Codes	ErrorResponse	Erro inesperado.

Segurança

AADToken

Esses são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.

Observação

Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual Azure Mapas recurso ao qual o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas .
O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de Microsoft Entra ID.
O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
O uso do SDK da Web Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
Para obter mais informações sobre plataforma de identidade da Microsoft, consulte visão geral plataforma de identidade da Microsoft.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Essa é uma chave compartilhada provisionada quando você cria uma conta Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave master na conta em que elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de aplicativos cliente confidenciais para acessar Azure Mapas APIs REST para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado à expiração, taxa e regiões de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de maneira mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta do Mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Get the POI Category Tree (only partial response shown below)

Solicitação de exemplo

HTTP

GET https://atlas.microsoft.com/search/poi/category/tree/json?api-version=1.0

Resposta de exemplo

Código de status:: 200

{
  "poiCategories": [
    {
      "id": 7320,
      "name": "Sports Center",
      "childCategoryIds": [
        7320002,
        7320003,
        7320005
      ],
      "synonyms": [
        "Gym",
        "Indoors Sports",
        "Sports Centre"
      ]
    },
    {
      "id": 7374,
      "name": "Stadium",
      "childCategoryIds": [
        7374002,
        7374009,
        7374012,
        7374003,
        7374010,
        7374005,
        7374008,
        7374011,
        7374006,
        7374014,
        7374013,
        7374007,
        7374004
      ],
      "synonyms": [
        "Arena",
        "Gymnasium",
        "Sports Ground",
        "Sports Stadium"
      ]
    },
    {
      "id": 7315,
      "name": "Restaurant",
      "childCategoryIds": [
        7315081,
        7315002,
        7315082,
        7315003,
        7315083,
        7315084,
        7315085,
        7315062,
        7315086,
        7315004,
        7315146,
        7315005,
        7315087,
        7315006,
        7315007,
        7315088,
        7315089,
        7315072,
        7315008,
        7315142,
        7315090,
        7315091,
        7315147,
        7315009,
        7315092,
        7315010,
        7315011,
        7315070,
        7315093,
        7315012,
        7315094,
        7315095,
        7315063,
        7315013,
        7315096,
        7315097,
        7315068,
        7315098,
        7315099,
        7315057,
        7315079,
        7315014,
        7315100,
        7315101,
        7315132,
        7315102,
        7315133,
        7315015,
        7315016,
        7315104,
        7315134,
        7315017,
        7315071,
        7315018,
        7315019,
        7315020,
        7315054,
        7315069,
        7315021,
        7315058,
        7315052,
        7315022,
        7315078,
        7315023,
        7315024,
        7315073,
        7315105,
        7315065,
        7315106,
        7315025,
        7315066,
        7315026,
        7315027,
        7315028,
        7315067,
        7315029,
        7315030,
        7315107,
        7315135,
        7315108,
        7315031,
        7315109,
        7315032,
        7315033,
        7315034,
        7315110,
        7315074,
        7315136,
        7315111,
        7315112,
        7315075,
        7315035,
        7315127,
        7315061,
        7315036,
        7315037,
        7315129,
        7315038,
        7315130,
        7315039,
        7315041,
        7315131,
        7315040,
        7315143,
        7315042,
        7315113,
        7315114,
        7315115,
        7315043,
        7315053,
        7315055,
        7315056,
        7315116,
        7315117,
        7315080,
        7315139,
        7315064,
        7315140,
        7315044,
        7315045,
        7315118,
        7315046,
        7315148,
        7315119,
        7315047,
        7315120,
        7315059,
        7315145,
        7315076,
        7315121,
        7315048,
        7315122,
        7315123,
        7315049,
        7315124,
        7315050,
        7315125,
        7315051,
        7315126,
        7315060,
        7315149
      ],
      "synonyms": [
        "Dining",
        "Eatery",
        "Eating House",
        "Eating Place"
      ]
    }
  ]
}

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
JsonFormat	Formato desejado da resposta. Há suporte apenas para o formato `json`.
PointOfInterestCategory	Resultado da categoria POI
PointOfInterestCategoryTreeResult	Esse objeto é retornado de uma chamada de árvore de categoria poi bem-sucedida

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

JsonFormat

Formato desejado da resposta. Há suporte apenas para o formato json.

Nome	Tipo	Description
json	string	O formato de intercâmbio de dados de notação de objeto JavaScript

PointOfInterestCategory

Resultado da categoria POI

Nome	Tipo	Description
childCategoryIds	integer[]	Matriz de IDs de categoria filho
id	integer	ID exclusiva para a categoria. A ID pode ser usada para restringir os resultados da pesquisa a categorias específicas por meio de outras APIs do Serviço de Pesquisa, como Obter Pesquisa POI.
name	string	Nome da categoria
synonyms	string[]	Matriz de nomes alternativos da categoria

PointOfInterestCategoryTreeResult

Esse objeto é retornado de uma chamada de árvore de categoria poi bem-sucedida

Nome	Tipo	Description
poiCategories	PointOfInterestCategory[]	Matriz de categorias

Compartilhar via

Search - Get Search POI Category Tree

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

AADToken

Escopos

subscription-key

SAS Token

Exemplos

Get the POI Category Tree (only partial response shown below)

Solicitação de exemplo

Resposta de exemplo

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JsonFormat

PointOfInterestCategory

PointOfInterestCategoryTreeResult

Recursos adicionais