Search - Get Search POI

  • Odwołanie
Service:
Maps
API Version:
1.0

Użyj polecenia , aby wyszukać punkty orientacyjne według nazwy.

Interfejs Points of Interest (POI) Search API to żądanie HTTP GET , które umożliwia żądanie wyników weryfikacji koncepcji według nazwy. Obsługuje również dodatkowe parametry zapytania, takie jak język i filtrowanie wyników według obszaru zainteresowania opartego na kraju/regionie lub polu ograniczenia. Punkt końcowy zwróci tylko wyniki weryfikacji koncepcji zgodne z ciągiem zapytania. Odpowiedź zawiera szczegóły interfejsu użytkownika, takie jak adres, lokalizacja współrzędnych i kategoria.

GET https://atlas.microsoft.com/search/poi/{format}?api-version=1.0&query={query}
With optional parameters: 
GET https://atlas.microsoft.com/search/poi/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&categorySet={categorySet}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&brandSet={brandSet}&connectorSet={connectorSet}&view={view}&openingHours=nextSevenDays

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
format
 path True

ResponseFormat

Żądany format odpowiedzi. Wartość może być json lub xml.
api-version
 query True

string

Numer wersji interfejsu API Azure Maps.
query
 query True

string

Nazwa interfejsu użytkownika do wyszukiwania (np. "statua wolności", "starbucks"), musi być prawidłowo zakodowana pod adresem URL.
brandSet
 query

string[]

Rozdzielona przecinkami lista nazw marek, których można użyć do ograniczenia wyniku do określonych marek. Kolejność elementów nie ma znaczenia. Po podaniu wielu marek zostaną zwrócone tylko wyniki należące do (co najmniej) jednej z podanych list. Marki, które zawierają "", w swojej nazwie powinny być umieszczane w cudzysłowie.

Przykłady użycia:

brandSet=Foo

brandSet=Foo,Bar

brandSet="A,B,C Przecinek",Bar
btmRight
 query

string

Prawe dolne położenie pola ograniczenia. Np. 37.553,-122.453
categorySet
 query

integer[]

Rozdzielona przecinkami lista identyfikatorów zestawów kategorii, których można użyć do ograniczenia wyniku do określonych kategorii Punktów orientacyjnych. Kolejność identyfikatorów nie ma znaczenia. Maksymalna liczba obsługiwanych categorySet wartości na żądanie wynosi 10. Po podaniu wielu identyfikatorów kategorii zostaną zwrócone tylko elementy POI należące do (co najmniej) jednej z kategorii z podanej listy. Listę obsługiwanych kategorii można odnaleźć przy użyciu interfejsu API kategorii weryfikacji koncepcji. Przykłady użycia:

  • categorySet=7315 (Search Punkty orientacyjne z kategorii Restauracja)

  • categorySet=7315025,7315017 (Search Punkty orientacyjne kategorii włoskiej lub francuskiej restauracji)
connectorSet
 query

ElectricVehicleConnector[]

Rozdzielona przecinkami lista typów łączników, których można użyć do ograniczenia wyniku do stacji pojazdów elektrycznych obsługujących określone typy łączników. Kolejność elementów nie ma znaczenia. Po podaniu wielu typów łączników zostaną zwrócone tylko wyniki należące do (co najmniej) jednej z podanych list.

Dostępne typy łączników to:

  • StandardHouseholdCountrySpecific - Są to standardowe łączniki gospodarstwa domowego dla określonego regionu. Wszystkie są jednofazowe prądu zmiennego oraz standardowe napięcie i standardowy amperaż. Zobacz również: Plug & socket types - World Standards (Podłącz typy gniazd & — światowe standardy).
  • IEC62196Type1 - Łącznik typu 1 zgodnie z definicją w standardzie IEC 62196-2. Nazwany również Yazaki po oryginalnym producencie lub SAE J1772 po standardzie, który po raz pierwszy go opublikował. Najczęściej używane w połączeniu z pojedynczą fazą 120V lub do 240V pojedynczej infrastruktury fazowej.
  • IEC62196Type1CCS - Łącznik kombi oparty na typie 1 zgodnie z definicją w standardzie IEC 62196-3. Łącznik jest oparty na łączniku typu 1, zgodnie z definicją w standardzie IEC 62196-2, z dwoma dodatkowymi kontaktami prądu bezpośredniego (DC), aby umożliwić szybkie ładowanie prądu DC.
  • IEC62196Type2CableAttached - Łącznik typu 2 zgodnie z definicją w standardzie IEC 62196-2. Dostarczone jako kabel i podłączona do punktu ładowania.
  • IEC62196Type2Outlet - Łącznik typu 2 zgodnie z definicją w standardzie IEC 62196-2. Dostarczone jako gniazdo ustawione w punkcie ładowania.
  • IEC62196Type2CCS - Łącznik kombi oparty na typie 2 zgodnie z definicją w standardzie IEC 62196-3. Łącznik jest oparty na łączniku typu 2, zgodnie z definicją w standardzie IEC 62196-2, z dwoma dodatkowymi kontaktami prądu bezpośredniego (DC), aby umożliwić szybkie ładowanie prądu DC.
  • IEC62196Type3 - Łącznik typu 3 zgodnie z definicją w standardzie IEC 62196-2. Również o nazwie Scame po oryginalnym producencie. Najczęściej używane w połączeniu z maksymalnie 240V pojedynczą fazą lub do 420V trzyfazowej infrastruktury.
  • Chademo - Łącznik CHAdeMO nazwany na cześć stowarzyszenia utworzonego przez Tokyo Electric Power Company i partnerów przemysłowych. Z tego powodu jest również znany jako łącznik TEPCO. Obsługuje szybkie ładowanie prądu stałego.
  • IEC60309AC1PhaseBlue - Łącznik niebieski przemysłowy jest łącznikiem zdefiniowanym w standardzie IEC 60309. Czasami jest ona określana za pomocą kombinacji standardu, koloru i faktu, że jest to jednofazowy łącznik. Łącznik ma zwykle konfigurację "P+N+E, 6h".
  • IEC60309DCWhite - Łącznik przemysłowy Biały jest łącznikiem DC zdefiniowanym w standardzie IEC 60309.
  • Tesla - Łącznik Tesli jest regionalnie specyficzny łącznik Tesla Supercharger. Tj. odnosi się on do zastrzeżonego łącznika Tesli, czasami określanego jako Tesla Port, głównie ograniczone do Ameryka Północna lub zmodyfikowanego typu 2 (DC nad typem 2) w Europie.

Przykłady użycia:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
countrySet
 query

string[]

Rozdzielony przecinkami ciąg kodów kraju/regionu, np. FR,ES. Spowoduje to ograniczenie wyszukiwania do określonych krajów/regionów
extendedPostalCodesFor
 query

PointOfInterestExtendedPostalCodes[]

Indeksy, dla których powinny zostać uwzględnione rozszerzone kody pocztowe w wynikach.

Dostępne indeksy to:

PoI = punkty orientacyjne

Wartość powinna mieć wartość POI lub None , aby wyłączyć rozszerzone kody pocztowe.

Domyślnie są uwzględniane rozszerzone kody pocztowe.

Przykłady użycia:

extendedPostalCodesFor=POI

extendedPostalCodesFor=None

Rozszerzony kod pocztowy jest zwracany jako właściwość extendedPostalCode adresu. Dostępność jest zależna od regionu.
language
 query

string

Język, w którym powinny być zwracane wyniki wyszukiwania. Powinien być jednym z obsługiwanych tagów języka IETF, bez uwzględniania wielkości liter. Jeśli dane w określonym języku nie są dostępne dla określonego pola, używany jest język domyślny.

Aby uzyskać szczegółowe informacje, zapoznaj się z tematem Obsługiwane języki .
lat
 query

number

double

Szerokość geograficzna, w której wyniki powinny być stronnicze. Np. 37.337
limit
 query

integer

Maksymalna liczba odpowiedzi, które zostaną zwrócone. Ustawienie domyślne: 10, minimum: 1 i maksimum: 100
lon
 query

number

double

Długość geograficzna, w której wyniki powinny być stronnicze. Np. -121.89
ofs
 query

integer

Przesunięcie początkowe zwróconych wyników w pełnym zestawie wyników. Ustawienie domyślne: 0
openingHours
 query

OperatingHoursRange

Godziny operacji dla interfejsu poi (punkty orientacyjne). Dostępność godzin pracy będzie się różnić w zależności od dostępnych danych. Jeśli nie zostanie przekazana, nie zostaną zwrócone żadne informacje o godzinach otwarcia. Obsługiwana wartość: nextSevenDays
radius
 query

integer

Promień w metrach dla wyników, które mają być ograniczone do zdefiniowanego obszaru
topLeft
 query

string

Lewa górna pozycja pola ograniczenia. Np. 37.553,-122.453
typeahead
 query

boolean

Boolean. Jeśli flaga typeahead jest ustawiona, zapytanie zostanie zinterpretowane jako częściowe dane wejściowe, a wyszukiwanie przejdzie w tryb predykcyjny
view
 query

LocalizedMapView

Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie poprawnych map dla określonego kraju/regionu dla regionów spornych geopolitycznie. Różne kraje/regiony mają różne widoki takich regionów, a parametr View umożliwia aplikacji zgodność z widokiem wymaganym przez kraj/region, który aplikacja będzie obsługiwać. Domyślnie parametr Widok jest ustawiony na "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru View dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z tymi dotyczącymi mapowania, kraju/regionu, w którym są dostępne mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem Azure Maps. Przykład: view=IN.

Aby uzyskać szczegółowe informacje, zapoznaj się z tematem Obsługiwane widoki i zobacz dostępne widoki.

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

SearchAddressResult

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 poziomu płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
  • Użycie zestawu AZURE MAPS Web SDK umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków użycia.
  • Aby uzyskać więcej informacji na temat Platforma tożsamości Microsoft, zobacz omówienie Platforma tożsamości Microsoft.

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

Scopes

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

subscription-key

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

Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do wszystkich interfejsów API REST. Innymi słowy, ten klucz może służyć 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 Azure Maps interfejsów API REST, aby klucz mógł być bezpiecznie przechowywany.

Type: apiKey
In: query

SAS Token

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

Dzięki temu tokenowi każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure oraz szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej bezpieczny 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 SAS.

Type: apiKey
In: header

Przykłady

Search for juice bars within 5 miles of Seattle Downtown and limit the response to 5 results

Sample Request

GET https://atlas.microsoft.com/search/poi/json?api-version=1.0&query=juice bars&limit=5&lat=47.606038&lon=-122.333345&radius=8046&openingHours=nextSevenDays

Sample Response

Status code:
200 
{
  "summary": {
    "query": "juice bars",
    "queryType": "NON_NEAR",
    "queryTime": 36,
    "numResults": 5,
    "offset": 0,
    "totalResults": 12,
    "fuzzyLevel": 1,
    "geoBias": {
      "lat": 47.606038,
      "lon": -122.333345
    }
  },
  "results": [
    {
      "type": "POI",
      "id": "US/POI/p0/9223158",
      "score": 5.664,
      "dist": 667.2710170950347,
      "info": "search:ta:840539001755244-US",
      "poi": {
        "name": "Pressed Juicery",
        "phone": "+(1)-(206)-6240804",
        "brands": [
          {
            "name": "Pressed Juicery"
          }
        ],
        "categorySet": [
          {
            "id": 7315149
          }
        ],
        "url": "www.pressedjuicery.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "yogurt/juice bar"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "400",
        "streetName": "Pine St",
        "municipalitySubdivision": "Seattle, Central Business District",
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "postalCode": "98101",
        "extendedPostalCode": "981011628",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "400 Pine St, Seattle, WA 98101",
        "localName": "Seattle",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.61138,
        "lon": -122.3374
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.61228,
          "lon": -122.33873
        },
        "btmRightPoint": {
          "lat": 47.61048,
          "lon": -122.33607
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.61134,
            "lon": -122.33737
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p0/9222534",
      "score": 5.663,
      "dist": 1101.6849025777728,
      "info": "search:ta:840539001760125-US",
      "poi": {
        "name": "Pressed Juicery",
        "phone": "+(1)-(206)-4533785",
        "brands": [
          {
            "name": "Pressed Juicery"
          }
        ],
        "categorySet": [
          {
            "id": 7315149
          }
        ],
        "url": "www.pressedjuicery.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "yogurt/juice bar"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "315",
        "streetName": "E Pine St",
        "municipalitySubdivision": "Seattle, Broadway",
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "postalCode": "98122",
        "extendedPostalCode": "9812200",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "315 E Pine St, Seattle, WA 98122",
        "localName": "Seattle",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.61518,
        "lon": -122.32768
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.61608,
          "lon": -122.32901
        },
        "btmRightPoint": {
          "lat": 47.61428,
          "lon": -122.32635
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.61523,
            "lon": -122.32768
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p1/9133689",
      "score": 5.659,
      "dist": 2649.8700791555398,
      "info": "search:ta:840539001339220-US",
      "poi": {
        "name": "Pressed Juicery",
        "phone": "+(1)-(206)-2820651",
        "brands": [
          {
            "name": "Pressed Juicery"
          }
        ],
        "categorySet": [
          {
            "id": 7315149
          }
        ],
        "url": "www.pressedjuicery.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "yogurt/juice bar"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "604",
        "streetName": "1st Ave N",
        "municipalitySubdivision": "Seattle, Lower Queen Anne",
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "postalCode": "98109",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "604 1st Ave N, Seattle, WA 98109",
        "localName": "Seattle",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.6247,
        "lon": -122.35533
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.6256,
          "lon": -122.35666
        },
        "btmRightPoint": {
          "lat": 47.6238,
          "lon": -122.354
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6247,
            "lon": -122.3554
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p1/9131285",
      "score": 5.646,
      "dist": 5097.757019046541,
      "info": "search:ta:840539001743255-US",
      "poi": {
        "name": "Custom Smoothie & Sports Nutrition",
        "phone": "+(1)-(206)-5475522",
        "categorySet": [
          {
            "id": 7315149
          }
        ],
        "url": "www.customsmoothie.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "yogurt/juice bar"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "462",
        "streetName": "N 34th St",
        "municipalitySubdivision": "Seattle, Fremont",
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "postalCode": "98103",
        "extendedPostalCode": "981038600",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "462 N 34th St, Seattle, WA 98103",
        "localName": "Seattle",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.65016,
        "lon": -122.35182
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.65106,
          "lon": -122.35315
        },
        "btmRightPoint": {
          "lat": 47.64926,
          "lon": -122.35049
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.64991,
            "lon": -122.3519
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p0/9228250",
      "score": 5.637,
      "dist": 6235.798481758295,
      "info": "search:ta:840531000416784-US",
      "poi": {
        "name": "Jamba Juice",
        "phone": "+(1)-(206)-6322060",
        "brands": [
          {
            "name": "Jamba Juice"
          }
        ],
        "categorySet": [
          {
            "id": 7315149
          }
        ],
        "url": "www.jambajuice.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "yogurt/juice bar"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "4555",
        "streetName": "Stone Way N",
        "municipalitySubdivision": "Wallingford, Seattle",
        "municipality": "Seattle",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle",
        "countrySubdivisionCode": "WA",
        "postalCode": "98103",
        "extendedPostalCode": "981036600",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "4555 Stone Way N, Seattle, WA 98103",
        "localName": "Seattle",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.66179,
        "lon": -122.34233
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.66269,
          "lon": -122.34367
        },
        "btmRightPoint": {
          "lat": 47.66089,
          "lon": -122.34099
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.66188,
            "lon": -122.34211
          }
        }
      ]
    }
  ]
}

Definicje

Nazwa Opis
Address

Adres wyniku
AddressRanges

Opisuje zakres adresów po obu stronach ulicy dla wyniku wyszukiwania. Uwzględniane są współrzędne dla lokalizacji początkowych i końcowych zakresu adresów.
BoundingBox

Widokport, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu portu widoku.
BoundingBoxCompassNotation

Pole ograniczenia lokalizacji.
Brand

Marka skojarzona z interfejsem POI
Classification

Klasyfikacja zwracanego interfejsu poi
ClassificationName

Nazwa klasyfikacji
DataSources

Sekcja opcjonalna. Identyfikatory odwołań do użycia z interfejsem API Get Search Polygon.
ElectricVehicleConnector

Rozdzielona przecinkami lista typów łączników, których można użyć do ograniczenia wyniku do stacji pojazdów elektrycznych obsługujących określone typy łączników. Kolejność elementów nie ma znaczenia. Po podaniu wielu typów łączników zostaną zwrócone tylko wyniki należące do (co najmniej) jednej z podanych list.

Dostępne typy łączników to:

  • StandardHouseholdCountrySpecific - Są to standardowe łączniki gospodarstw domowych dla określonego regionu. Wszystkie są one pojedynczą fazą AC i standardowym napięciem i standardowym amperażem. Zobacz też: Podłączanie typów gniazd & — światowe standardy.
  • IEC62196Type1 - Typ 1 łącznik zdefiniowany w standardzie IEC 62196-2. Nazwany również Yazaki po oryginalnym producencie lub SAE J1772 po standardzie, który po raz pierwszy go opublikował. Najczęściej używane w połączeniu z pojedynczą fazą 120V lub maksymalnie 240V infrastruktury jednofazowej.
  • IEC62196Type1CCS - Łącznik kombi oparty na typie 1, zgodnie z definicją w standardzie IEC 62196-3. Łącznik jest oparty na łączniku typu 1, zgodnie z definicją w standardzie IEC 62196-2, z dwoma dodatkowymi kontaktami prądu bezpośredniego (DC), aby umożliwić szybkie ładowanie DC.
  • IEC62196Type2CableAttached - Łącznik typu 2 zdefiniowany w standardzie IEC 62196-2. Dostarczone jako kabel i podłączona do punktu ładowania.
  • IEC62196Type2Outlet - Łącznik typu 2 zdefiniowany w standardzie IEC 62196-2. Dostarczone jako gniazdo ustawione w punkcie ładowania.
  • IEC62196Type2CCS - Łącznik kombi oparty na typie 2, zgodnie z definicją w standardzie IEC 62196-3. Łącznik jest oparty na łączniku typu 2, zgodnie z definicją w standardzie IEC 62196-2, z dwoma dodatkowymi kontaktami prądu bezpośredniego (DC), aby umożliwić szybkie ładowanie DC.
  • IEC62196Type3 - Łącznik typu 3 zdefiniowany w standardzie IEC 62196-2. Również o nazwie Scame po oryginalnym producencie. Najczęściej używane w połączeniu z maksymalnie 240V pojedynczą fazą lub maksymalnie 420V infrastruktury trójfazowej.
  • Chademo - Łącznik CHAdeMO o nazwie od stowarzyszenia utworzonego przez Tokyo Electric Power Company i partnerów przemysłowych. Z tego powodu jest również znany jako łącznik TEPCO. Obsługuje szybkie ładowanie dc.
  • IEC60309AC1PhaseBlue - Łącznik Przemysłowy Niebieski jest łącznikiem zdefiniowanym w standardzie IEC 60309. Czasami jest określany przez połączenie standardu, koloru i faktu, że jest to łącznik z jedną fazą. Łącznik zwykle ma konfigurację "P+N+E, 6h".
  • IEC60309DCWhite - Łącznik przemysłowy Biały jest łącznikiem DC zdefiniowanym w standardzie IEC 60309.
  • Tesla - Łącznik Tesli jest regionalnie specyficzny łącznik Tesla Supercharger. Oznacza to, że odnosi się do zastrzeżonego łącznika Tesli, czasami określanego jako Tesla Port, głównie ograniczone do Ameryka Północna lub zmodyfikowanego typu 2 (DC nad typem 2) w Europie.

Przykłady użycia:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Entity

Źródło typu jednostki pola ograniczenia. W przypadku odwrotnego geokodowania jest to zawsze równe położenie.
EntryPoint

Punkt wejścia zwracanego interfejsu poI.
EntryPointType

Typ punktu wejścia. Wartość może być główna lub pomocnicza.
ErrorAdditionalInfo

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

Szczegóły błędu.
ErrorResponse

Odpowiedź na błąd
GeographicEntityType

Typ jednostki Geografia. Występuje tylko wtedy, gdy żądano właściwości entityType i jest dostępna.
Geometry

Informacje o kształcie geometrycznym wyniku. Występuje tylko wtedy, gdy typ == Geografia.
LatLongPairAbbreviated

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".
LocalizedMapView

Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie poprawnych map dla określonego kraju/regionu dla regionów spornych geopolitycznie. Różne kraje/regiony mają różne widoki takich regionów, a parametr View umożliwia aplikacji zgodność z widokiem wymaganym przez kraj/region, który aplikacja będzie obsługiwać. Domyślnie parametr Widok jest ustawiony na "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru View dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z tymi dotyczącymi mapowania, kraju/regionu, w którym są dostępne mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem Azure Maps. Przykład: view=IN.

Aby uzyskać szczegółowe informacje, zapoznaj się z tematem Obsługiwane widoki i zobacz dostępne widoki.
MatchType

Typy dopasowania dla operacji wyszukiwania odwrotnego adresu.
OperatingHours

Godziny otwarcia punktu zakupu (punkty orientacyjne).
OperatingHoursRange

Godziny operacji dla interfejsu poi (punkty orientacyjne). Dostępność godzin pracy będzie się różnić w zależności od dostępnych danych. Jeśli nie zostanie przekazana, nie zostaną zwrócone żadne informacje o godzinach otwarcia. Obsługiwana wartość: nextSevenDays
OperatingHoursTime

Reprezentuje datę i godzinę
OperatingHoursTimeRange

Otwarty zakres czasu dla dnia
PointOfInterest

Szczegóły zwróconego interfejsu poI, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje.
PointOfInterestCategorySet

Kategoria poi
PointOfInterestExtendedPostalCodes

Indeksy, dla których należy uwzględnić rozszerzone kody pocztowe w wynikach.

Dostępne indeksy to:

POI = punkty orientacyjne

Wartość powinna być poI lub Brak , aby wyłączyć rozszerzone kody pocztowe.

Domyślnie są uwzględniane rozszerzone kody pocztowe.

Przykłady użycia:

extendedPostalCodesFor=POI

extendedPostalCodesFor=None

Rozszerzony kod pocztowy jest zwracany jako właściwość extendedPostalCode adresu. Dostępność jest zależna od regionu.
QueryType

Zwracany typ zapytania: W POBLIŻU lub NON_NEAR.
ResponseFormat

Żądany format odpowiedzi. Wartość może być json lub xml.
SearchAddressResult

Ten obiekt jest zwracany z pomyślnych wywołań Search.
SearchAddressResultItem

Obiekt wyniku odpowiedzi interfejsu API Search.
SearchAddressResultType

Jeden z:

  • UM
  • Ulica
  • Lokalizacja geograficzna
  • Adres punktu
  • Zakres adresów
  • Cross Street
SearchSummary

Obiekt podsumowania odpowiedzi interfejsu API Search.

Address

Adres wyniku

Nazwa Typ Opis
boundingBox

BoundingBoxCompassNotation

Pole ograniczenia lokalizacji.
buildingNumber

string

Numer budynku na ulicy. PRZESTARZAŁE użyj streetNumber zamiast tego.
country

string

nazwa kraju/regionu
countryCode

string

Kraj (Uwaga: jest to dwuliterowy kod, a nie nazwa kraju/regionu).
countryCodeISO3

string

Kod kraju ISO alfa-3
countrySecondarySubdivision

string

Powiat
countrySubdivision

string

Stan lub prowincja
countrySubdivisionCode

string

countrySubdivisionCode prefiks ( countryCode countryCode-countrySubdivisionCode ) i łącznik tworzy kod ISO 3166-2. Przykłady: TX dla Teksasu, SCT dla Szkocji i ON dla Ontario.
countrySubdivisionName

string

Pełna nazwa pierwszego poziomu hierarchii administracyjnej kraju/regionu. To pole jest wyświetlane tylko w przypadku, gdy countrySubdivision jest prezentowana w skróconej formie. Obsługiwane tylko dla Stanów Zjednoczonych, Kanady i Wielkiej Brytanii.
countryTertiarySubdivision

string

Nazwany obszar
crossStreet

string

Nazwa ulicy, która jest skrzyżowana.
extendedPostalCode

string

Rozszerzony kod pocztowy (dostępność jest zależna od regionu).
freeformAddress

string

Wiersz adresu sformatowany zgodnie z regułami formatowania kraju/regionu wynikowego pochodzenia lub w przypadku kraju/regionu pełna nazwa kraju/regionu.
localName

string

Składnik adresu, który reprezentuje nazwę obszaru geograficznego lub lokalizacji, który grupuje wiele obiektów adresowalnych do celów adresowania, bez jednostki administracyjnej. To pole służy do kompilowania freeformAddress właściwości. localName reprezentuje gminę pocztową. W zależności od lokalizacji localName jest powszechnie znaną nazwą miasta lub miasta. Dla powszechnie znanej nazwy miasta lub miasta należy użyć localName zamiast municipality.
municipality

string

Miasto /Miasto
Uwaga: municipality reprezentuje gminę mieszkalną. W zależności od lokalizacji municipality wartość może się różnić od powszechnie znanej nazwy miasta lub miasta. W przypadku powszechnie znanej nazwy miasta lub miasta sugerowane jest, aby localName wartość była używana zamiast municipality wartości.
municipalitySubdivision

string

Sub / Super City
neighbourhood

string

Dzielnica jest geograficznie zlokalizowanym obszarem w mieście lub mieście z charakterystycznymi cechami i interakcjami społecznymi między mieszkańcami.
postalCode

string

Kod pocztowy/kod pocztowy
routeNumbers

string[]

Kody używane do jednoznacznej identyfikacji ulicy
street

string

Nazwa ulicy. PRZESTARZAŁE zamiast tego użyj streetName.
streetName

string

Nazwa ulicy.
streetNameAndNumber

string

Nazwa ulicy i numer.
streetNumber

string

Numer budynku na ulicy.

AddressRanges

Opisuje zakres adresów po obu stronach ulicy dla wyniku wyszukiwania. Uwzględniane są współrzędne dla lokalizacji początkowych i końcowych zakresu adresów.

Nazwa Typ Opis
from

LatLongPairAbbreviated

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".
rangeLeft

string

Zakres adresów po lewej stronie ulicy.
rangeRight

string

Zakres adresów po prawej stronie ulicy.
to

LatLongPairAbbreviated

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".

BoundingBox

Widokport, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu portu widoku.

Nazwa Typ Opis
btmRightPoint

LatLongPairAbbreviated

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".
topLeftPoint

LatLongPairAbbreviated

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".

BoundingBoxCompassNotation

Pole ograniczenia lokalizacji.

Nazwa Typ Opis
entity

Entity

Źródło typu jednostki pola ograniczenia. W przypadku odwrotnego geokodowania jest to zawsze równe położenie.
northEast

string

Szerokość geograficzna północno-wschodnia,współrzędna geograficzna pola ograniczenia jako rozdzielane przecinkami zmiennoprzecinkowe
southWest

string

Szerokość geograficzna południowo-zachodnia,współrzędna geograficzna pola ograniczenia jako rozdzielane przecinkami zmiennoprzecinkowe

Brand

Marka skojarzona z interfejsem POI

Nazwa Typ Opis
name

string

Nazwa marki

Classification

Klasyfikacja zwracanego interfejsu poi

Nazwa Typ Opis
code

string

Właściwość Code
names

ClassificationName[]

Tablica nazw

ClassificationName

Nazwa klasyfikacji

Nazwa Typ Opis
name

string

Name — Właściwość
nameLocale

string

Nazwa właściwości Ustawienia regionalne

DataSources

Sekcja opcjonalna. Identyfikatory odwołań do użycia z interfejsem API Get Search Polygon.

Nazwa Typ Opis
geometry

Geometry

Informacje o kształcie geometrycznym wyniku. Występuje tylko wtedy, gdy typ == Geografia.

ElectricVehicleConnector

Rozdzielona przecinkami lista typów łączników, których można użyć do ograniczenia wyniku do stacji pojazdów elektrycznych obsługujących określone typy łączników. Kolejność elementów nie ma znaczenia. Po podaniu wielu typów łączników zostaną zwrócone tylko wyniki należące do (co najmniej) jednej z podanych list.

Dostępne typy łączników to:

  • StandardHouseholdCountrySpecific - Są to standardowe łączniki gospodarstw domowych dla określonego regionu. Wszystkie są one pojedynczą fazą AC i standardowym napięciem i standardowym amperażem. Zobacz też: Podłączanie typów gniazd & — światowe standardy.
  • IEC62196Type1 - Typ 1 łącznik zdefiniowany w standardzie IEC 62196-2. Nazwany również Yazaki po oryginalnym producencie lub SAE J1772 po standardzie, który po raz pierwszy go opublikował. Najczęściej używane w połączeniu z pojedynczą fazą 120V lub maksymalnie 240V infrastruktury jednofazowej.
  • IEC62196Type1CCS - Łącznik kombi oparty na typie 1, zgodnie z definicją w standardzie IEC 62196-3. Łącznik jest oparty na łączniku typu 1, zgodnie z definicją w standardzie IEC 62196-2, z dwoma dodatkowymi kontaktami prądu bezpośredniego (DC), aby umożliwić szybkie ładowanie DC.
  • IEC62196Type2CableAttached - Łącznik typu 2 zdefiniowany w standardzie IEC 62196-2. Dostarczone jako kabel i podłączona do punktu ładowania.
  • IEC62196Type2Outlet - Łącznik typu 2 zdefiniowany w standardzie IEC 62196-2. Dostarczone jako gniazdo ustawione w punkcie ładowania.
  • IEC62196Type2CCS - Łącznik kombi oparty na typie 2, zgodnie z definicją w standardzie IEC 62196-3. Łącznik jest oparty na łączniku typu 2, zgodnie z definicją w standardzie IEC 62196-2, z dwoma dodatkowymi kontaktami prądu bezpośredniego (DC), aby umożliwić szybkie ładowanie DC.
  • IEC62196Type3 - Łącznik typu 3 zdefiniowany w standardzie IEC 62196-2. Również o nazwie Scame po oryginalnym producencie. Najczęściej używane w połączeniu z maksymalnie 240V pojedynczą fazą lub maksymalnie 420V infrastruktury trójfazowej.
  • Chademo - Łącznik CHAdeMO o nazwie od stowarzyszenia utworzonego przez Tokyo Electric Power Company i partnerów przemysłowych. Z tego powodu jest również znany jako łącznik TEPCO. Obsługuje szybkie ładowanie dc.
  • IEC60309AC1PhaseBlue - Łącznik Przemysłowy Niebieski jest łącznikiem zdefiniowanym w standardzie IEC 60309. Czasami jest określany przez połączenie standardu, koloru i faktu, że jest to łącznik z jedną fazą. Łącznik zwykle ma konfigurację "P+N+E, 6h".
  • IEC60309DCWhite - Łącznik przemysłowy Biały jest łącznikiem DC zdefiniowanym w standardzie IEC 60309.
  • Tesla - Łącznik Tesli jest regionalnie specyficzny łącznik Tesla Supercharger. Oznacza to, że odnosi się do zastrzeżonego łącznika Tesli, czasami określanego jako Tesla Port, głównie ograniczone do Ameryka Północna lub zmodyfikowanego typu 2 (DC nad typem 2) w Europie.

Przykłady użycia:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

Nazwa Typ Opis
Chademo

string

Łącznik CHAdeMO o nazwie od stowarzyszenia utworzonego przez Tokyo Electric Power Company i partnerów przemysłowych. Z tego powodu jest również znany jako łącznik TEPCO. Obsługuje szybkie ładowanie dc.
IEC60309AC1PhaseBlue

string

Łącznik Industrial Blue jest łącznikiem zdefiniowanym w standardzie IEC 60309. Czasami jest określany przez połączenie standardu, koloru i faktu, że jest to łącznik z jedną fazą. Łącznik zwykle ma konfigurację "P+N+E, 6h".
IEC60309DCWhite

string

Łącznik Przemysłowy Biały jest łącznikiem DC zdefiniowanym w standardzie IEC 60309.
IEC62196Type1

string

Typ 1 łącznik zdefiniowany w standardzie IEC 62196-2. Nazwany również Yazaki po oryginalnym producencie lub SAE J1772 po standardzie, który po raz pierwszy go opublikował. Najczęściej używane w połączeniu z pojedynczą fazą 120V lub maksymalnie 240V infrastruktury jednofazowej.
IEC62196Type1CCS

string

Łącznik kombi oparty na typie 1, zgodnie z definicją w standardzie IEC 62196-3. Łącznik jest oparty na łączniku typu 1, zgodnie z definicją w standardzie IEC 62196-2, z dwoma dodatkowymi kontaktami prądu bezpośredniego (DC), aby umożliwić szybkie ładowanie DC.
IEC62196Type2CCS

string

Łącznik kombi oparty na typie 2, zgodnie z definicją w standardzie IEC 62196-3. Łącznik jest oparty na łączniku typu 2, zgodnie z definicją w standardzie IEC 62196-2, z dwoma dodatkowymi kontaktami prądu bezpośredniego (DC), aby umożliwić szybkie ładowanie DC.
IEC62196Type2CableAttached

string

Łącznik typu 2 zdefiniowany w standardzie IEC 62196-2. Dostarczone jako kabel i podłączona do punktu ładowania
IEC62196Type2Outlet

string

Łącznik typu 2 zdefiniowany w standardzie IEC 62196-2. Dostarczone jako gniazdo ustawione w punkcie ładowania.
IEC62196Type3

string

Typ 3 łącznika zdefiniowany w standardzie IEC 62196-2. Również o nazwie Scame po oryginalnym producencie. Najczęściej używane w połączeniu z maksymalnie 240V pojedynczą fazą lub maksymalnie 420V infrastruktury trójfazowej.
StandardHouseholdCountrySpecific

string

Są to standardowe łączniki gospodarstwa domowego dla określonego regionu. Wszystkie są one pojedynczą fazą AC i standardowym napięciem i standardowym amperażem.

Zobacz również: Podłączanie typów gniazd & — światowe standardy
Tesla

string

Łącznik Tesli jest regionalnym łącznikiem Tesla Supercharger. Oznacza to, że odnosi się do zastrzeżonego łącznika Tesli, czasami określanego jako Tesla Port, głównie ograniczone do Ameryka Północna lub zmodyfikowanego typu 2 (DC nad typem 2) w Europie.

Entity

Źródło typu jednostki pola ograniczenia. W przypadku odwrotnego geokodowania jest to zawsze równe położenie.

Nazwa Typ Opis
position

string

Pozycja jednostki

EntryPoint

Punkt wejścia zwracanego interfejsu poI.

Nazwa Typ Opis
position

LatLongPairAbbreviated

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".
type

EntryPointType

Typ punktu wejścia. Wartość może być główna lub pomocnicza.

EntryPointType

Typ punktu wejścia. Wartość może być główna lub pomocnicza.

Nazwa Typ Opis
main

string

minor

string

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.

GeographicEntityType

Typ jednostki Geografia. Występuje tylko wtedy, gdy żądano właściwości entityType i jest dostępna.

Nazwa Typ Opis
Country

string

nazwa kraju/regionu
CountrySecondarySubdivision

string

Powiat
CountrySubdivision

string

Stan lub prowincja
CountryTertiarySubdivision

string

Nazwany obszar
Municipality

string

Miasto /Miasto
MunicipalitySubdivision

string

Sub / Super City
Neighbourhood

string

Sąsiedztwa
PostalCodeArea

string

Kod pocztowy/kod pocztowy

Geometry

Informacje o kształcie geometrycznym wyniku. Występuje tylko wtedy, gdy typ == Geografia.

Nazwa Typ Opis
id

string

Przekaż ten identyfikator geometryId do interfejsu API get Search Polygon, aby pobrać informacje o geometrii dla tego wyniku.

LatLongPairAbbreviated

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".

Nazwa Typ Opis
lat

number

Właściwość Szerokość geograficzna
lon

number

Właściwość Długość geograficzna

LocalizedMapView

Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie poprawnych map dla określonego kraju/regionu dla regionów spornych geopolitycznie. Różne kraje/regiony mają różne widoki takich regionów, a parametr View umożliwia aplikacji zgodność z widokiem wymaganym przez kraj/region, który aplikacja będzie obsługiwać. Domyślnie parametr Widok jest ustawiony na "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru View dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z tymi dotyczącymi mapowania, kraju/regionu, w którym są dostępne mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem Azure Maps. Przykład: view=IN.

Aby uzyskać szczegółowe informacje, zapoznaj się z tematem Obsługiwane widoki i zobacz dostępne widoki.

Nazwa Typ Opis
AE

string

Zjednoczone Emiraty Arabskie (widok arabski)
AR

string

Argentyna (widok argentyński)
Auto

string

Zwróć dane mapy na podstawie adresu IP żądania.
BH

string

Bahrajn (widok arabski)
IN

string

Indie (Widok indyjski)
IQ

string

Irak (widok arabski)
JO

string

Jordania (widok arabski)
KW

string

Kuwejt (widok arabski)
LB

string

Liban (widok arabski)
MA

string

Maroko (widok marokański)
OM

string

Oman (widok arabski)
PK

string

Pakistan (Widok pakistanu)
PS

string

Autonomia Palestyńska (widok arabski)
QA

string

Katar (widok arabski)
SA

string

Arabia Saudyjska (widok arabski)
SY

string

Syria (widok arabski)
Unified

string

Ujednolicony widok (inne)
YE

string

Jemen (widok arabski)

MatchType

Typy dopasowania dla operacji wyszukiwania odwrotnego adresu.

Nazwa Typ Opis
AddressPoint

string

HouseNumberRange

string

Street

string

OperatingHours

Godziny otwarcia punktu zakupu (punkty orientacyjne).

Nazwa Typ Opis
mode

string

Wartość używana w żądaniu: none lub "nextSevenDays"
timeRanges

OperatingHoursTimeRange[]

Lista zakresów czasu dla następnych 7 dni

OperatingHoursRange

Godziny operacji dla interfejsu poi (punkty orientacyjne). Dostępność godzin pracy będzie się różnić w zależności od dostępnych danych. Jeśli nie zostanie przekazana, nie zostaną zwrócone żadne informacje o godzinach otwarcia. Obsługiwana wartość: nextSevenDays

Nazwa Typ Opis
nextSevenDays

string

Pokazuje godziny operacji w następnym tygodniu, począwszy od bieżącego dnia w czasie lokalnym interfejsu użytkownika.

OperatingHoursTime

Reprezentuje datę i godzinę

Nazwa Typ Opis
date

string

Reprezentuje bieżącą datę kalendarza w strefie czasowej poi, np. "2019-02-07".
hour

integer

Godziny są w formacie 24 godziny w czasie lokalnym poi; możliwe wartości to 0–23.
minute

integer

Minuty są w czasie lokalnym interfejsu użytkownika; możliwe wartości to 0–59.

OperatingHoursTimeRange

Otwarty zakres czasu dla dnia

Nazwa Typ Opis
endTime

OperatingHoursTime

Punkt w ciągu najbliższych 7 dni, gdy dany poi jest zamykany, lub początek zakresu, jeśli został zamknięty przed zakresem.
startTime

OperatingHoursTime

Punkt w ciągu najbliższych 7 dni od otwarcia danego punktu zakupu lub początku zakresu, jeśli został otwarty przed zakresem.

PointOfInterest

Szczegóły zwróconego interfejsu poI, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje.

Nazwa Typ Opis
brands

Brand[]

Tablica marek. Nazwa marki dla zwracanego interfejsu POI.
categories

string[]

Tablica kategorii
categorySet

PointOfInterestCategorySet[]

Lista najbardziej specyficznych kategorii poI
classifications

Classification[]

Tablica klasyfikacji
name

string

Nazwa właściwości POI
openingHours

OperatingHours

Godziny otwarcia punktu zakupu (punkty orientacyjne).
phone

string

Właściwość numeru telefonu
url

string

Właściwość adresu URL witryny internetowej

PointOfInterestCategorySet

Kategoria poi

Nazwa Typ Opis
id

integer

Identyfikator kategorii

PointOfInterestExtendedPostalCodes

Indeksy, dla których należy uwzględnić rozszerzone kody pocztowe w wynikach.

Dostępne indeksy to:

POI = punkty orientacyjne

Wartość powinna być poI lub Brak , aby wyłączyć rozszerzone kody pocztowe.

Domyślnie są uwzględniane rozszerzone kody pocztowe.

Przykłady użycia:

extendedPostalCodesFor=POI

extendedPostalCodesFor=None

Rozszerzony kod pocztowy jest zwracany jako właściwość extendedPostalCode adresu. Dostępność jest zależna od regionu.

Nazwa Typ Opis
None

string

POI

string

QueryType

Zwracany typ zapytania: W POBLIŻU lub NON_NEAR.

Nazwa Typ Opis
NEARBY

string

Search wykonano wokół określonej szerokości i długości geograficznej ze zdefiniowanym promieniem
NON_NEAR

string

Search wykonano globalnie bez uprzedzeń do określonej szerokości geograficznej i długości geograficznej oraz bez zdefiniowanego promienia

ResponseFormat

Żądany format odpowiedzi. Wartość może być json lub xml.

Nazwa Typ Opis
json

string

Format wymiany danych notacji obiektów JavaScript
xml

string

Rozszerzalny język znaczników

SearchAddressResult

Ten obiekt jest zwracany z pomyślnych wywołań Search.

Nazwa Typ Opis
results

SearchAddressResultItem[]

Lista wyników interfejsu API Search.
summary

SearchSummary

Obiekt podsumowania odpowiedzi interfejsu API Search

SearchAddressResultItem

Obiekt wyniku odpowiedzi interfejsu API Search.

Nazwa Typ Opis
address

Address

Adres wyniku
addressRanges

AddressRanges

Opisuje zakres adresów po obu stronach ulicy dla wyniku wyszukiwania. Uwzględniane są współrzędne dla lokalizacji początkowych i końcowych zakresu adresów.
dataSources

DataSources

Sekcja opcjonalna. Identyfikator geometrii odwołania do użycia z interfejsem API Get Search Polygon.
detourTime

integer

Czas objazdu w sekundach. Zwrócono tylko wywołania interfejsu API Search Wzdłuż trasy.
dist

number

Odległość linii prostej między lokalizacją wyniku a geobiasami w metrach.
entityType

GeographicEntityType

Typ jednostki Geografia. Występuje tylko wtedy, gdy żądano właściwości entityType i jest dostępna.
entryPoints

EntryPoint[]

Tablica punktów wejścia. Opisują one typy wejść dostępnych w lokalizacji. Typ może być "główny" dla głównych wejść, takich jak drzwi wejściowe, lub hol, i "drobne", dla drzwi bocznych i tylnych.
id

string

Właściwość Id
info

string

Informacje o oryginalnym źródle danych wyniku. Służy do obsługi żądań pomocy technicznej.
matchType

MatchType

Informacje o typie dopasowania.

Jeden z:

  • Punkt adresowy
  • HouseNumberRange
  • Ulica
poi

PointOfInterest

Szczegóły zwróconego interfejsu poI, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje.
position

LatLongPairAbbreviated

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".
score

number

Wartość w zestawie wyników wskazująca względny wynik dopasowania między wynikami. Można to użyć, aby określić, że wynik x jest dwa razy bardziej prawdopodobny w wyniku y, jeśli wartość x wynosi 2x wartość y. Wartości różnią się między zapytaniami i są przeznaczone tylko jako wartość względna dla jednego zestawu wyników.
type

SearchAddressResultType

Jeden z:

  • UM
  • Ulica
  • Lokalizacja geograficzna
  • Adres punktu
  • Zakres adresów
  • Cross Street
viewport

BoundingBox

Widokport, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu portu widoku.

SearchAddressResultType

Jeden z:

  • UM
  • Ulica
  • Lokalizacja geograficzna
  • Adres punktu
  • Zakres adresów
  • Cross Street
Nazwa Typ Opis
Address Range

string

Cross Street

string

Geography

string

POI

string

Point Address

string

Street

string

SearchSummary

Obiekt podsumowania odpowiedzi interfejsu API Search.

Nazwa Typ Opis
fuzzyLevel

integer

Maksymalny poziom rozmyty wymagany do udostępnienia wyników.
geoBias

LatLongPairAbbreviated

Wskazanie, kiedy wewnętrzna wyszukiwarka zastosowała stronniczość geoprzestrzenną, aby poprawić klasyfikację wyników. W niektórych metodach może to mieć wpływ, ustawiając parametry lat i lon, jeśli są dostępne. W innych przypadkach jest to wyłącznie wewnętrzne.
limit

integer

Maksymalna liczba odpowiedzi, które zostaną zwrócone
numResults

integer

Liczba wyników w odpowiedzi.
offset

integer

Przesunięcie początkowe zwróconych wyników w pełnym zestawie wyników.
query

string

Parametr zapytania, który został użyty do wygenerowania tych wyników wyszukiwania.
queryTime

integer

Czas spędzony na rozpoznawaniu zapytania w milisekundach.
queryType

QueryType

Zwracany typ zapytania: W POBLIŻU lub NON_NEAR.
totalResults

integer

Łączna liczba znalezionych wyników.