Search - Post Search Address Batch

Odwołanie

Usługa:: Maps

Wersja interfejsu API:: 1.0

Służy do wysyłania partii zapytań do interfejsu API adresu wyszukiwania w jednym żądaniu asynchronicznym.
Interfejs API Post Search Address Batch to żądanie POST HTTP, które wysyła partie zapytań do interfejsu API adresu wyszukiwania w jednym synchronicznym wywołaniu interfejsu API. Możesz wywołać interfejs API usługi Batch adresu wyszukiwania, aby uruchomić asynchronicznie (asynchronicznie) lub synchronicznie (synchronizacja). Asynchroniczny interfejs API umożliwia obiektowi wywołującym wykonywanie partii do 10 000 zapytań i synchronizowanie interfejsu API do 100 zapytań.

Przesyłanie synchronicznego żądania usługi Batch

Interfejs API synchroniczny jest zalecany w przypadku lekkich żądań wsadowych. Gdy usługa odbierze żądanie, odpowie natychmiast po obliczeniu elementów wsadowych i nie będzie możliwe późniejsze pobranie wyników. Interfejs API synchroniczny zwróci błąd limitu czasu (odpowiedź 408), jeśli żądanie trwa dłużej niż 60 sekund. Liczba elementów wsadowych jest ograniczona do 100 dla tego interfejsu API.

POST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Przesyłanie asynchronicznego żądania usługi Batch

Interfejs API asynchroniczny jest odpowiedni do przetwarzania dużych ilości stosunkowo złożonych żądań wyszukiwania

Umożliwia pobieranie wyników w osobnym wywołaniu (możliwe jest wiele pobrań).
Asynchroniczny interfejs API jest zoptymalizowany pod kątem niezawodności i nie oczekuje się, że upłynął limit czasu.
Liczba elementów wsadowych jest ograniczona do 10 000 dla tego interfejsu API.

Gdy wysyłasz żądanie przy użyciu żądania asynchronicznego, domyślnie usługa zwraca kod odpowiedzi 202 wraz z adresem URL przekierowania w polu Lokalizacja nagłówka odpowiedzi. Ten adres URL powinien być okresowo sprawdzany do momentu udostępnienia danych odpowiedzi lub informacji o błędzie. Odpowiedzi asynchroniczne są przechowywane dla 14 dni. Adres URL przekierowania zwraca odpowiedź 404, jeśli jest używana po upływie okresu wygaśnięcia.

Należy pamiętać, że asynchroniczne żądanie wsadowe jest długotrwałą operacją. Oto typowa sekwencja operacji:

Klient wysyła żądanie usługi Batch POST adresu wyszukiwania do usługi Azure Maps.

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0&subscription-key={subscription-key}

Serwer odpowie jednym z następujących elementów:

202 Accepted HTTP — żądanie usługi Batch zostało zaakceptowane.

Error HTTP — wystąpił błąd podczas przetwarzania żądania usługi Batch. Może to być 400 Bad Request lub inny kod stanu Error.
Jeśli żądanie wsadowe zostało pomyślnie zaakceptowane, nagłówek Location w odpowiedzi zawiera adres URL umożliwiający pobranie wyników żądania wsadowego. Ten identyfikator URI stanu wygląda następująco:

    GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Klient wysyła żądanie GET na adres URL pobierania uzyskany w kroku 3 w celu pobrania wyników wsadowych.

Treść POST dla żądania wsadowego

Aby wysłać adres wyszukiwania zapytań, użyjesz żądania POST, w którym treść żądania będzie zawierać tablicę batchItems w formacie json, a nagłówek Content-Type zostanie ustawiony na wartość application/json. Oto przykładowa treść żądania zawierająca 5 adres wyszukiwania zapytań:

{
    "batchItems": [
        {"query": "?query=400 Broad St, Seattle, WA 98109&limit=3"},
        {"query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"},
        {"query": "?query=350 5th Ave, New York, NY 10118&limit=1"},
        {"query": "?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000"},
        {"query": "?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1"}
    ]
}

Adres wyszukiwania zapytanie w partii to tylko częściowy adres URL bez protokołu, podstawowego adresu URL, ścieżki, wersji interfejsu API i klucza subskrypcji. Może zaakceptować dowolny z obsługiwanych adresu wyszukiwaniaparametrów identyfikatora URI. Wartości ciągów w adresie wyszukiwania kwerendy muszą zostać prawidłowo uniknięte (np. "znak powinien zostać uniknięci z znakiem \ ), a także powinien być prawidłowo zakodowany pod adresem URL.

Asynchroniczny interfejs API umożliwia wywołaniu wsadowe do 10 000 zapytań i synchronizowanie interfejsu API do 100 zapytań, a partia powinna zawierać co najmniej 1 zapytań.

Pobieranie wyników asynchronicznych wsadowych

Aby pobrać wyniki asynchronicznego pobierania wsadowego, należy wysłać żądanie GET do punktu końcowego pobierania wsadowego. Ten pobierania adresu URL można uzyskać z nagłówka Location pomyślnego żądania wsadowego POST i wygląda następująco:

https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Oto typowa sekwencja operacji pobierania wyników wsadowych:

Klient wysyła żądanie GET przy użyciu adresu URL pobierania .
Serwer odpowie jednym z następujących elementów:

202 Accepted HTTP — żądanie usługi Batch zostało zaakceptowane, ale nadal jest przetwarzane. Spróbuj ponownie za jakiś czas.

200 OK HTTP — pomyślnie przetworzone żądanie usługi Batch. Treść odpowiedzi zawiera wszystkie wyniki wsadowe.

Model odpowiedzi wsadowej

Zwrócona zawartość danych jest podobna dla żądań asynchronicznych i synchronizacji. Podczas pobierania wyników asynchronicznego żądania wsadowego, jeśli partia zakończyła przetwarzanie, treść odpowiedzi zawiera odpowiedź wsadową. Ta odpowiedź wsadowa zawiera składnik summary wskazujący totalRequests, które były częścią oryginalnego żądania wsadowego i successfulRequeststj. zapytania, które zostały wykonane pomyślnie. Odpowiedź wsadowa zawiera również tablicę batchItems zawierającą odpowiedź dla każdego zapytania w żądaniu wsadowym. batchItems będzie zawierać wyniki w dokładnie takiej samej kolejności, w jaki oryginalne zapytania zostały wysłane w żądaniu wsadowym. Każdy element w batchItems zawiera pola statusCode i response. Każdy response w batchItems jest jednym z następujących typów:

SearchAddressResult — jeśli zapytanie zostało ukończone pomyślnie.
Error — jeśli zapytanie nie powiodło się. Odpowiedź będzie zawierać code i message w tym przypadku.

Oto przykładowa odpowiedź wsadowa z 2 pomyślnymi i 1 zakończyła się niepowodzeniem wyniku:

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "one microsoft way redmond wa 98052"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.63989,
                            "lon": -122.12509
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "pike pl seattle wa 98101"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.60963,
                            "lon": -122.34215
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
format	path	True	JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko format `json`.
api-version	query	True	string	Numer wersji interfejsu API usługi Azure Maps.

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ń Microsoft Entra ID. Reprezentuje unikatowy identyfikator konta usługi Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania usługi Azure Maps. Aby użyć zabezpieczeń identyfikatora Entra firmy Microsoft w usłudze Azure Maps, zobacz następujące artykuły , aby uzyskać wskazówki.

Treść żądania

Nazwa	Typ	Opis
batchItems	BatchRequestItem[]	Lista zapytań do przetworzenia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SearchAddressBatchProcessResult	OK
202 Accepted		Obsługiwane tylko w przypadku żądania asynchronicznego. Zaakceptowane żądanie: żądanie zostało zaakceptowane do przetworzenia. Użyj adresu URL w nagłówku lokalizacji, aby ponowić próbę lub uzyskać dostęp do wyników. Nagłówki Location: string
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd.

Nazwa

Typ

Opis

200 OK

SearchAddressBatchProcessResult

202 Accepted

Obsługiwane tylko w przypadku żądania asynchronicznego. Zaakceptowane żądanie: żądanie zostało zaakceptowane do przetworzenia. Użyj adresu URL w nagłówku lokalizacji, aby ponowić próbę lub uzyskać dostęp do wyników.

Nagłówki

Location: string

Other Status Codes

ErrorResponse

Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

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

Aby zaimplementować scenariusze, zalecamy wyświetlenie koncepcji uwierzytelniania . Podsumowując, ta definicja zabezpieczeń zawiera 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łówka x-ms-client-id w celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania Maps.
Authorization URL jest specyficzna dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje identyfikatorów Entra firmy Microsoft.
Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana na podstawie płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
Użycie zestawu Web SDK usługi Azure Maps umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków użycia.
Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Microsoft identity platform overview.

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 tworzenie konta usługi Azure Maps w witrynie Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do całego interfejsu 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 poufnych aplikacji klienckich podejście do uzyskiwania dostępu do interfejsów API REST usługi Azure Maps, aby klucz mógł być bezpiecznie przechowywany.

Typ: apiKey
W: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji List SAS na zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny 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 i 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 zabezpieczony niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie Mapowanie konta w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.

Typ: apiKey
W: header

Przykłady

An Address Geocoding Batch API call containing 5 Address Geocoding API queries

Przykładowe żądanie

HTTP

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0

{
  "batchItems": [
    {
      "query": "?query=400 Broad St, Seattle, WA 98109&limit=3"
    },
    {
      "query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"
    },
    {
      "query": "?query=350 5th Ave, New York, NY 10118&limit=1"
    }
  ]
}

Przykładowa odpowiedź

Kod stanu:: 200

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "400 broad st seattle wa 98109",
          "queryType": "NON_NEAR",
          "queryTime": 127,
          "numResults": 3,
          "offset": 0,
          "totalResults": 9,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/20843845",
            "score": 11.966,
            "address": {
              "streetNumber": "400",
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union, Lower Queen Anne",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "400 Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62039,
              "lon": -122.34928
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62129,
                "lon": -122.35061
              },
              "btmRightPoint": {
                "lat": 47.61949,
                "lon": -122.34795
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.61982,
                  "lon": -122.34886
                }
              }
            ]
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388442",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109",
              "extendedPostalCode": "981094612",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62001,
              "lon": -122.34843
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61965,
                "lon": -122.34761
              },
              "btmRightPoint": {
                "lat": 47.62066,
                "lon": -122.349
              }
            }
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388680",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, Belltown",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109,98121",
              "extendedPostalCode": "981094991,981211117,981211237,981213206",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.61691,
              "lon": -122.35251
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61502,
                "lon": -122.35041
              },
              "btmRightPoint": {
                "lat": 47.61857,
                "lon": -122.35484
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "one microsoft way redmond wa 98052",
          "queryType": "NON_NEAR",
          "queryTime": 169,
          "numResults": 2,
          "offset": 0,
          "totalResults": 3292,
          "fuzzyLevel": 2
        },
        "results": [
          {
            "type": "Street",
            "id": "US/STR/p0/1692663",
            "score": 10.225,
            "address": {
              "streetName": "Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980526399,980528300",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63989,
              "lon": -122.12509
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63748,
                "lon": -122.12309
              },
              "btmRightPoint": {
                "lat": 47.64223,
                "lon": -122.13061
              }
            }
          },
          {
            "type": "Cross Street",
            "id": "US/XSTR/p1/4779971",
            "score": 8.506,
            "address": {
              "streetName": "Microsoft Way & 157th Avenue Northeast, Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way & 157th Avenue Northeast, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63962,
              "lon": -122.13061
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.64052,
                "lon": -122.13194
              },
              "btmRightPoint": {
                "lat": 47.63872,
                "lon": -122.12928
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "350 5th ave new york ny 10118",
          "queryType": "NON_NEAR",
          "queryTime": 233,
          "numResults": 1,
          "offset": 0,
          "totalResults": 8032,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/48052000",
            "score": 14.334,
            "address": {
              "streetNumber": "350",
              "streetName": "5th Avenue",
              "municipalitySubdivision": "New York, Midtown South",
              "municipality": "New York, Manhattan",
              "countrySecondarySubdivision": "New York",
              "countryTertiarySubdivision": "Manhattan",
              "countrySubdivisionCode": "NY",
              "postalCode": "10118",
              "extendedPostalCode": "1011800",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "350 5th Avenue, NYC, NY 10118",
              "countrySubdivisionName": "New York"
            },
            "position": {
              "lat": 40.74817,
              "lon": -73.985
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 40.74907,
                "lon": -73.98619
              },
              "btmRightPoint": {
                "lat": 40.74727,
                "lon": -73.98381
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 40.74808,
                  "lon": -73.98482
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

Kod stanu:: 202

Operation-Location: URL to download the results of the long-running batch request.

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.
BatchRequest	Ten typ reprezentuje treść żądania dla usługi Batch.
BatchRequestItem	Obiekt żądania usługi Batch
BoundingBox	Port widoków, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu panelu widoków.
BoundingBoxCompassNotation	Pole ograniczenia lokalizacji.
Brand	Marka skojarzona z interfejsem POI
Classification	Klasyfikacja zwracanego interfejsu użytkownika
ClassificationName	Nazwa klasyfikacji
DataSources	Sekcja opcjonalna. Identyfikatory odwołań do użycia z interfejsem API Get Search Polygon API.
Entity	Źródło typu jednostki pola ograniczenia. W przypadku odwrotnego geokodowania jest to zawsze równe pozycji.
EntryPoint	Punkt wejścia zwracanego interfejsu użytkownika.
EntryPointType	Typ punktu wejścia. Wartość może być głównym lub pomocniczym.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
GeographicEntityType	Typ jednostki Geografia. Prezentuj tylko wtedy, gdy zażądano parametru entityType i jest dostępny.
Geometry	Informacje o kształcie geometrycznym wyniku. Występuje tylko wtedy, gdy typ == Geography.
JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko format `json`.
LatLongPairAbbreviated	Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".
MatchType	Typy dopasowania dla operacji wyszukiwania odwrotnego adresu.
OperatingHours	Godziny otwarcia poi (punkty orientacyjne).
OperatingHoursTime	Reprezentuje datę i godzinę
OperatingHoursTimeRange	Zakres czasu otwarcia na dzień
PointOfInterest	Szczegółowe informacje o zwracanym interfejsie użytkownika, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje.
PointOfInterestCategorySet	Kategoria poi
QueryType	Zwracany typ zapytania: W POBLIŻU lub NON_NEAR.
Response	Wynik zapytania. SearchAddressResult jeśli zapytanie zostało ukończone pomyślnie, BłądResponse w przeciwnym razie.
SearchAddressBatchItem	Element zwrócony z wywołania usługi Batch adresu wyszukiwania.
SearchAddressBatchProcessResult	Ten obiekt jest zwracany z pomyślnego wywołania usługi Batch adresu wyszukiwania.
SearchAddressResultItem	Wynik obiektu odpowiedzi interfejsu API wyszukiwania.
SearchAddressResultType	Jeden z: Punkt Zainteresowania (PZ) Ulica Geografia Adres punktu Zakres adresów Cross Street
SearchSummary	Obiekt podsumowania odpowiedzi interfejsu API wyszukiwania.
Summary	Podsumowanie wyników żądania wsadowego

Address

Objekt

Adres wyniku

Nazwa	Typ	Opis
boundingBox	BoundingBoxCompassNotation	Pole ograniczenia lokalizacji.
buildingNumber	string	Numer budynku na ulicy. PRZESTARZAŁE, zamiast tego użyj streetNumber.
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` prefiksowany przez `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 prezentowany w skróconej formie. Obsługiwane tylko w przypadku Stanów Zjednoczonych, Kanady i Wielkiej Brytanii.
countryTertiarySubdivision	string	Nazwany obszar
crossStreet	string	Nazwa ulicy, która jest przekraczana.
extendedPostalCode	string	Rozszerzony kod pocztowy (dostępność zależy 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 reprezentujący nazwę obszaru geograficznego lub lokalności, który grupuje wiele obiektów adresowalnych na potrzeby adresowania, bez jednostki administracyjnej. To pole służy do kompilowania właściwości `freeformAddress`. `localName` reprezentuje gminę pocztową. W zależności od lokalizacji `localName` jest powszechnie znaną nazwą miasta lub miasta. W przypadku 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 wartość `municipality` może różnić się od powszechnie znanej nazwy miasta lub miasta. W przypadku powszechnie znanej nazwy miasta lub miasta zaleca się, aby wartość `localName` była używana zamiast wartości `municipality`.
municipalitySubdivision	string	Sub/Super City
neighbourhood	string	Sąsiedztwo to geograficznie zlokalizowany obszar 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

Objekt

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".

BatchRequest

Objekt

Ten typ reprezentuje treść żądania dla usługi Batch.

Nazwa	Typ	Opis
batchItems	BatchRequestItem[]	Lista zapytań do przetworzenia.

BatchRequestItem

Objekt

Obiekt żądania usługi Batch

Nazwa	Typ	Opis
query	string	Ten parametr zawiera ciąg zapytania używany do wykonywania operacji geokodowania bez struktury. Ciąg zapytania zostanie przekazany dosłowny do interfejsu API wyszukiwania na potrzeby przetwarzania.

BoundingBox

Objekt

Port widoków, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu panelu widoków.

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

Objekt

Pole ograniczenia lokalizacji.

Nazwa	Typ	Opis
entity	Entity	Źródło typu jednostki pola ograniczenia. W przypadku odwrotnego geokodowania jest to zawsze równe pozycji.
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

Objekt

Marka skojarzona z interfejsem POI

Nazwa	Typ	Opis
name	string	Nazwa marki

Classification

Objekt

Klasyfikacja zwracanego interfejsu użytkownika

Nazwa	Typ	Opis
code	string	Właściwość kodu
names	ClassificationName[]	Tablica nazw

ClassificationName

Objekt

Nazwa klasyfikacji

Nazwa	Typ	Opis
name	string	Właściwość Nazwa
nameLocale	string	Nazwa właściwości Ustawień regionalnych

DataSources

Objekt

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

Nazwa	Typ	Opis
geometry	Geometry	Informacje o kształcie geometrycznym wyniku. Występuje tylko wtedy, gdy typ == Geography.

Entity

Wyliczanie

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

Wartość	Opis
position	Pozycja jednostki

EntryPoint

Objekt

Punkt wejścia zwracanego interfejsu użytkownika.

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łównym lub pomocniczym.

EntryPointType

Wyliczanie

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

Wartość	Opis
main
minor

ErrorAdditionalInfo

Objekt

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

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

ErrorDetail

Objekt

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

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

GeographicEntityType

Wyliczanie

Typ jednostki Geografia. Prezentuj tylko wtedy, gdy zażądano parametru entityType i jest dostępny.

Wartość	Opis
Country	nazwa kraju/regionu
CountrySecondarySubdivision	Powiat
CountrySubdivision	Stan lub prowincja
CountryTertiarySubdivision	Nazwany obszar
Municipality	Miasto/ Miasto
MunicipalitySubdivision	Sub/Super City
Neighbourhood	Sąsiedztwo
PostalCodeArea	Kod pocztowy/kod pocztowy

Geometry

Objekt

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

Nazwa	Typ	Opis
id	string	Przekaż go jako geometryId do interfejsu API get search polygon, aby pobrać informacje geometryczne dla tego wyniku.

JsonFormat

Wyliczanie

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

Wartość	Opis
json	format wymiany danych notacji obiektów JavaScript

LatLongPairAbbreviated

Objekt

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

Nazwa	Typ	Opis
lat	number (double)	Właściwość Szerokość geograficzna
lon	number (double)	Właściwość Długość geograficzna

MatchType

Wyliczanie

Typy dopasowania dla operacji wyszukiwania odwrotnego adresu.

Wartość	Opis
AddressPoint
HouseNumberRange
Street

OperatingHours

Objekt

Godziny otwarcia poi (punkty orientacyjne).

Nazwa	Typ	Opis
mode	string	Wartość użyta w żądaniu: brak lub "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	Lista zakresów czasu dla następnych 7 dni

OperatingHoursTime

Objekt

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 poi; możliwe wartości to 0–59.

OperatingHoursTimeRange

Objekt

Zakres czasu otwarcia na dzień

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, gdy dany poI jest otwierany, lub początek zakresu, jeśli został otwarty przed zakresem.

PointOfInterest

Objekt

Szczegółowe informacje o zwracanym interfejsie użytkownika, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje.

Nazwa	Typ	Opis
brands	Brand[]	Tablica marek. Nazwa marki zwracanej przez interfejs użytkownika.
categories	string[]	Tablica kategorii
categorySet	PointOfInterestCategorySet[]	Lista najbardziej określonych kategorii poi
classifications	Classification[]	Tablica klasyfikacji
name	string	Nazwa właściwości POI
openingHours	OperatingHours	Godziny otwarcia poi (punkty orientacyjne).
phone	string	Właściwość numeru telefonu
url	string	Właściwość adresu URL witryny sieci Web

PointOfInterestCategorySet

Objekt

Kategoria poi

Nazwa	Typ	Opis
id	integer	Identyfikator kategorii

QueryType

Wyliczanie

Zwracany typ zapytania: W POBLIŻU lub NON_NEAR.

Wartość	Opis
NEARBY	Wyszukiwanie zostało wykonane wokół określonej szerokości geograficznej i długości geograficznej ze zdefiniowanym promieniem
NON_NEAR	Wyszukiwanie zostało wykonane globalnie, bez stronniczo do określonej szerokości geograficznej i długości geograficznej i bez zdefiniowanego promienia

Response

Objekt

Wynik zapytania. SearchAddressResult jeśli zapytanie zostało ukończone pomyślnie, BłądResponse w przeciwnym razie.

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.
results	SearchAddressResultItem[]	Lista wyników interfejsu API wyszukiwania.
summary	SearchSummary	Obiekt podsumowania odpowiedzi interfejsu API wyszukiwania

SearchAddressBatchItem

Objekt

Element zwrócony z wywołania usługi Batch adresu wyszukiwania.

Nazwa	Typ	Opis
response	Response	Wynik zapytania. SearchAddressResult jeśli zapytanie zostało ukończone pomyślnie, BłądResponse w przeciwnym razie.
statusCode	integer	Kod stanu żądania HTTP.

SearchAddressBatchProcessResult

Objekt

Ten obiekt jest zwracany z pomyślnego wywołania usługi Batch adresu wyszukiwania.

Nazwa	Typ	Opis
batchItems	SearchAddressBatchItem[]	Tablica zawierająca wyniki wsadowe.
summary	Summary	Podsumowanie wyników żądania wsadowego

SearchAddressResultItem

Objekt

Wynik obiektu odpowiedzi interfejsu API wyszukiwania.

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 do użycia z interfejsem API Get Search Polygon API.
detourTime	integer	Czas objazdu w sekundach. Zwracane tylko dla wywołań interfejsu API wyszukiwania wzdłuż trasy.
dist	number (double)	Odległość linii prostej między wynikiem a lokalizacją geobiazy w metrach.
entityType	GeographicEntityType	Typ jednostki Geografia. Prezentuj tylko wtedy, gdy zażądano parametru entityType i jest dostępny.
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: AdresPoint HouseNumberRange Ulica
poi	PointOfInterest	Szczegółowe informacje o zwracanym interfejsie użytkownika, 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 (double)	Wartość w zestawie wyników wskazująca względny wynik dopasowania między wynikami. Za pomocą tej opcji można określić, że wynik x jest dwa razy bardziej prawdopodobny w wyniku y, jeśli wartość x to 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: Punkt Zainteresowania (PZ) Ulica Geografia Adres punktu Zakres adresów Cross Street
viewport	BoundingBox	Port widoków, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu panelu widoków.

SearchAddressResultType

Wyliczanie

Jeden z:

Punkt Zainteresowania (PZ)
Ulica
Geografia
Adres punktu
Zakres adresów
Cross Street

Wartość	Opis
Address Range
Cross Street
Geography
POI
Point Address
Street

SearchSummary

Objekt

Obiekt podsumowania odpowiedzi interfejsu API wyszukiwania.

Nazwa	Typ	Opis
fuzzyLevel	integer	Maksymalny poziom rozmyte wymagany do dostarczenia 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 na ustawienie parametrów 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 rozwiązywaniu zapytania w milisekundach.
queryType	QueryType	Zwracany typ zapytania: W POBLIŻU lub NON_NEAR.
totalResults	integer	Całkowita liczba znalezionych wyników.

Summary

Objekt

Podsumowanie wyników żądania wsadowego

Nazwa	Typ	Opis
successfulRequests	integer	Liczba pomyślnych żądań w partii
totalRequests	integer	Łączna liczba żądań w partii

Udostępnij za pośrednictwem

Search - Post Search Address Batch

Przesyłanie synchronicznego żądania usługi Batch

Przesyłanie asynchronicznego żądania usługi Batch

Treść POST dla żądania wsadowego

Pobieranie wyników asynchronicznych wsadowych

Model odpowiedzi wsadowej

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

AADToken

Zakresy

subscription-key

SAS Token

Przykłady

An Address Geocoding Batch API call containing 5 Address Geocoding API queries

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Address

AddressRanges

BatchRequest

BatchRequestItem

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

JsonFormat

LatLongPairAbbreviated

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

Response

SearchAddressBatchItem

SearchAddressBatchProcessResult

SearchAddressResultItem

SearchAddressResultType

SearchSummary

Summary

Dodatkowe zasoby