Search - Get Search POI Category Tree

Referenz

Service:: Maps

API Version:: 1.0

Verwenden Sie, um eine Liste der unterstützten POI-Kategorien (Points of Interest) und Unterkategorien abzurufen.

Die Get Search POI Category Tree API ist eine HTTP-Anforderung GET , die eine vollständige Liste der unterstützten POI-Kategorien (Points of Interest) und Unterkategorien zusammen mit ihren Übersetzungen und Synonymen bereitstellt. Der zurückgegebene Inhalt kann verwendet werden, um aussagekräftigere Ergebnisse über andere Search-Dienst-APIs wie abrufen Search POI bereitzustellen.

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

With optional parameters:

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

URI-Parameter

Name In Erforderlich Typ Beschreibung

Name	In	Erforderlich	Typ	Beschreibung
format	path	True	JsonFormat	Gewünschtes Format der Antwort. Nur das `json`-Format wird unterstützt.
api-version	query	True	string	Versionsnummer der Azure Maps API.
language	query		string	Sprache, in der Suchergebnisse zurückgegeben werden sollen. Sollte eines der unterstützten IETF-Sprachtags sein, mit Ausnahme von NGT und NGT-Latn. Beim Sprachtag wird die Groß-/Kleinschreibung nicht beachtet. Wenn Daten in der angegebenen Sprache für ein bestimmtes Feld nicht verfügbar sind, wird die Standardsprache (Englisch) verwendet. Weitere Informationen finden Sie unter Unterstützte Sprachen .

format

path

True

JsonFormat

Gewünschtes Format der Antwort. Nur das json-Format wird unterstützt.

api-version

query

True

string

Versionsnummer der Azure Maps API.

language

query

string

Sprache, in der Suchergebnisse zurückgegeben werden sollen. Sollte eines der unterstützten IETF-Sprachtags sein, mit Ausnahme von NGT und NGT-Latn. Beim Sprachtag wird die Groß-/Kleinschreibung nicht beachtet. Wenn Daten in der angegebenen Sprache für ein bestimmtes Feld nicht verfügbar sind, wird die Standardsprache (Englisch) verwendet.

Weitere Informationen finden Sie unter Unterstützte Sprachen .

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto für die Verwendung in Verbindung mit dem Microsoft Entra ID Sicherheitsmodell vorgesehen ist. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der konto-API auf Azure Maps Verwaltungsebene abgerufen werden. Anleitungen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln.

Antworten

Name	Typ	Beschreibung
200 OK	PointOfInterestCategoryTreeResult	OK
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

Hinweis

Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id Headers, um anzugeben, auf welche Azure Maps Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.
Der Authorization URL ist spezifisch für die öffentliche Azure-Cloud-instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID Konfigurationen.
Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.
Weitere Informationen zu Microsoft Identity Platform finden Sie unter Microsoft Identity Platform Übersicht.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Dies ist ein gemeinsam genutzter Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal erstellen oder PowerShell, CLI, Azure SDKs oder REST-API verwenden.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als master Schlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

Für öffentlich zugängliche Anwendungen wird empfohlen, den Ansatz vertraulicher Clientanwendungen zu verwenden, um auf Azure Maps REST-APIs zuzugreifen, damit Ihr Schlüssel sicher gespeichert werden kann.

Type: apiKey
In: query

SAS Token

Hierbei handelt es sich um ein Shared Access Signature Token, das aus dem Sas-Listenvorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Type: apiKey
In: header

Beispiele

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

Sample Request

HTTP

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

Sample Response

Status code:: 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"
      ]
    }
  ]
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
JsonFormat	Gewünschtes Format der Antwort. Nur das `json`-Format wird unterstützt.
PointOfInterestCategory	POI-Kategorieergebnis
PointOfInterestCategoryTreeResult	Dieses Objekt wird von einem erfolgreichen AUFRUF der POI-Kategoriestruktur zurückgegeben.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

JsonFormat

Gewünschtes Format der Antwort. Nur das json-Format wird unterstützt.

Name	Typ	Beschreibung
json	string	Das Datenaustauschformat der JavaScript-Objektnotation

PointOfInterestCategory

POI-Kategorieergebnis

Name	Typ	Beschreibung
childCategoryIds	integer[]	Array von untergeordneten Kategorie-IDs
id	integer	Eindeutige ID für die Kategorie. Die ID kann verwendet werden, um Suchergebnisse über andere Search-Dienst-APIs wie abrufen Search POI auf bestimmte Kategorien zu beschränken.
name	string	Name der Kategorie
synonyms	string[]	Array alternativer Namen der Kategorie

PointOfInterestCategoryTreeResult

Dieses Objekt wird von einem erfolgreichen AUFRUF der POI-Kategoriestruktur zurückgegeben.

Name	Typ	Beschreibung
poiCategories	PointOfInterestCategory[]	Kategorienarray

Share via

Search - Get Search POI Category Tree

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

AADToken

Scopes

subscription-key

SAS Token

Beispiele

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

Sample Request

Sample Response

Definitionen

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JsonFormat

PointOfInterestCategory

PointOfInterestCategoryTreeResult

Zusätzliche Ressourcen