Search - Get Search POI Category Tree

Odwołanie

Usługa:: Maps

Wersja interfejsu API:: 1.0

Użyj polecenia , aby uzyskać listę obsługiwanych kategorii punktów orientacyjnych (POI) i podkategorii.

Interfejs Get Search POI Category Tree API to żądanie HTTP GET , które zawiera pełną listę obsługiwanych kategorii punktów orientacyjnych (POI) i podkategorii wraz z ich tłumaczeniami i synonimami. Zwrócona zawartość może służyć do zapewniania bardziej znaczących wyników za pośrednictwem innych interfejsów API usługi Search, takich jak Uzyskiwanie Search poI.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis

Nazwa	W	Wymagane	Typ	Opis
format	path	True	JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko `json` format.
api-version	query	True	string	Numer wersji interfejsu API Azure Maps.
language	query		string	Język, w którym powinny być zwracane wyniki wyszukiwania. Powinien być jednym z obsługiwanych tagów języka IETF, z wyjątkiem NGT i NGT-Latn. Tag języka jest niewrażliwy na wielkość liter. Gdy dane w określonym języku nie są dostępne dla określonego pola, używany jest język domyślny (angielski). Aby uzyskać szczegółowe informacje, zobacz Obsługiwane języki .

format

path

True

JsonFormat

Żądany format odpowiedzi. Obsługiwany jest tylko json format.

api-version

query

True

string

Numer wersji interfejsu API Azure Maps.

language

query

string

Język, w którym powinny być zwracane wyniki wyszukiwania. Powinien być jednym z obsługiwanych tagów języka IETF, z wyjątkiem NGT i NGT-Latn. Tag języka jest niewrażliwy na wielkość liter. Gdy dane w określonym języku nie są dostępne dla określonego pola, używany jest język domyślny (angielski).

Aby uzyskać szczegółowe informacje, zobacz Obsługiwane języki .

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-id		string	Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń Tożsamość Microsoft Entra. Reprezentuje unikatowy identyfikator konta Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby użyć zabezpieczeń Tożsamość Microsoft Entra w usłudze Azure Maps, zobacz następujące artykuły, aby uzyskać wskazówki.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PointOfInterestCategoryTreeResult	OK
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy protokołu OAuth 2.0 Microsoft Entra. W połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do Azure Maps interfejsów API REST.

Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Uwaga

Ta definicja zabezpieczeń wymaga użycia nagłówkax-ms-client-id, aby wskazać, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami .
Element Authorization URL jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje Tożsamość Microsoft Entra.
Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.
Użycie Azure Maps zestawu Web SDK umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.
Aby uzyskać więcej informacji na temat Platforma tożsamości Microsoft, zobacz omówienie Platforma tożsamości Microsoft.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Jest to klucz wspólny aprowizowany podczas tworzenia konta Azure Maps w Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Przy użyciu tego klucza każda aplikacja może uzyskać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może być używany jako klucz główny na koncie, w którym są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu do interfejsów API REST Azure Maps w celu bezpiecznego przechowywania klucza.

Typ: apiKey
W: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.

Przy użyciu tego tokenu każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token sygnatury dostępu współdzielonego może służyć do umożliwienia aplikacjom kontrolowania dostępu w bardziej bezpieczny sposób niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SYGNATURy dostępu współdzielonego.

Typ: apiKey
W: header

Przykłady

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

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
      ]
    }
  ]
}

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko `json` format.
PointOfInterestCategory	Wynik kategorii poi
PointOfInterestCategoryTreeResult	Ten obiekt jest zwracany z pomyślnego wywołania drzewa kategorii poI

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

JsonFormat

Żądany format odpowiedzi. Obsługiwany jest tylko json format.

Nazwa	Typ	Opis
json	string	Format wymiany danych notacji obiektów JavaScript

PointOfInterestCategory

Wynik kategorii poi

Nazwa	Typ	Opis
childCategoryIds	integer[]	Tablica identyfikatorów kategorii podrzędnych
id	integer	Unikatowy identyfikator kategorii. Identyfikator może służyć do ograniczania wyników wyszukiwania do określonych kategorii za pośrednictwem innych interfejsów API usługi Search, takich jak Uzyskiwanie Search poI.
name	string	Nazwa kategorii
synonyms	string[]	Tablica alternatywnych nazw kategorii

PointOfInterestCategoryTreeResult

Ten obiekt jest zwracany z pomyślnego wywołania drzewa kategorii poI

Nazwa	Typ	Opis
poiCategories	PointOfInterestCategory[]	Tablica kategorii

Udostępnij za pośrednictwem

Search - Get Search POI Category Tree

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Zabezpieczenia

AADToken

Zakresy

subscription-key

SAS Token

Przykłady

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

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JsonFormat

PointOfInterestCategory

PointOfInterestCategoryTreeResult

Dodatkowe zasoby