Search - Get Reverse Geocoding Batch

Consente di inviare un batch di query all'API di geocodifica inversa in un'unica richiesta.
L'API Get Reverse Geocoding Batch è una richiesta http POST che invia batch fino a 100 query per 'API di geocodifica inversa usando una singola richiesta.

Inviare una richiesta batch sincrona

L'API sincrona è consigliata per le richieste batch leggere. Quando il servizio riceve una richiesta, risponderà non appena vengono calcolati gli elementi batch e non sarà possibile recuperare i risultati in un secondo momento. L'API sincrona restituirà un errore di timeout (una risposta 408) se la richiesta richiede più di 60 secondi. Il numero di elementi batch è limitato a 100 per questa API.

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version={api-version}

Corpo POST per la richiesta batch

Per inviare la geocodifica inversa query, si userà una richiesta di POST in cui il corpo della richiesta conterrà la matrice batchItems in formato json e l'intestazione Content-Type verrà impostata su application/json. Ecco un corpo di richiesta di esempio contenente 2 query di geocodifica inversa:

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

Un geocodifica inversa oggetto batchItem può accettare uno qualsiasi dei parametri di geocodifica inversa parametri URI.

Il batch deve contenere almeno 1 query.

Modello di risposta batch

La risposta batch contiene un componente summary che indica il totalRequests che faceva parte della richiesta batch originale e successfulRequests ad esempio le query eseguite correttamente. La risposta batch include anche una matrice di batchItems che contiene una risposta per ogni query e ogni query nella richiesta batch. Il batchItems conterrà i risultati nello stesso ordine in cui le query originali sono state inviate nella richiesta batch. Ogni elemento è di uno dei tipi seguenti:

• GeocodingResponse: se la query è stata completata correttamente.

• Error: se la query non è riuscita. La risposta conterrà un code e un message in questo caso.

POST {endpoint}/reverseGeocode:batch?api-version=2026-01-01

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

AadToken

Questi sono i flussi Microsoft Entra OAuth 2.0. Quando abbinata al controllo Azure basato su ruolo può essere utilizzata per controllare l'accesso alle API REST di Mappe di Azure. I controlli di accesso basati su ruoli di Azure sono utilizzati per designare l'accesso a uno o più account o sottorisorse risorse di Mappe di Azure. A qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per le API REST di Mappe di Azure.

Per implementare scenari, è consigliabile visualizzare concetti di autenticazione. In sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

subscription-key

Si tratta di una chiave condivisa di cui viene effettuato il provisioning quando si Creare un account di Mappe di Azure nel portale di Azure o usando PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o l'API REST.

Con questa chiave, qualsiasi applicazione può accedere a tutte le API REST. In altre parole, questa chiave può essere usata come chiave master nell'account in cui vengono rilasciati.

Per le applicazioni esposte pubblicamente, è consigliabile usare l'approccio applicazioni client riservate per accedere alle API REST di Mappe di Azure in modo che la chiave possa essere archiviata in modo sicuro.

Tipo: apiKey
In: header

SAS Token

Si tratta di un token di firma di accesso condiviso creato dall'operazione List SAS nell'risorsa di Mappe di Azure tramite il piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.

Con questo token, qualsiasi applicazione è autorizzata ad accedere ai controlli di accesso in base al ruolo di Azure e al controllo granulare per la scadenza, la frequenza e le aree d'uso per il token specifico. In altre parole, il token di firma di accesso condiviso può essere usato per consentire alle applicazioni di controllare l'accesso in modo più protetto rispetto alla chiave condivisa.

Per le applicazioni esposte pubblicamente, è consigliabile configurare un elenco specifico di origini consentite nella risorsa account mappa per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.

Tipo: apiKey
In: header

Esempio

A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2026-01-01

{
  "batchItems": [
    {
      "coordinates": [
        -122.138681,
        47.630358
      ],
      "resultTypes": [
        "Address",
        "PopulatedPlace"
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "coordinates": [
        47.630358,
        -122.138681
      ],
      "optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
    }
  ]
}

{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {
            "type": "Address",
            "confidence": "Medium",
            "matchCodes": [
              "Good"
            ],
            "address": {
              "locality": "Redmond",
              "adminDistricts": [
                {
                  "name": "Washington",
                  "shortName": "WA"
                },
                {
                  "name": "King County",
                  "shortName": "King Co."
                }
              ],
              "countryRegion": {
                "ISO": "US",
                "name": "United States"
              },
              "postalCode": "98052",
              "formattedAddress": "2267 152nd Ave NE, Redmond, Washington 98052, United States",
              "streetName": "152nd Ave NE",
              "streetNumber": "2267",
              "addressLine": "2267 152nd Ave NE"
            },
            "geocodePoints": [
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.128275,
                    47.639429
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Display",
                  "Route"
                ]
              },
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.127028,
                    47.638545
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Route"
                ]
              }
            ]
          },
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.128275,
              47.639429
            ]
          },
          "bbox": [
            -122.1359181505759,
            47.63556628242932,
            -122.1206318494241,
            47.643291717570676
          ]
        }
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "error": {
        "code": "Bad Request",
        "message": "The provided coordinates (-122.138681,47.630358) in coordinates field are invalid or out of range"
      },
      "optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
    }
  ]
}

Definizioni

Address

L'indirizzo di una posizione suggerita da geocodifica o autocompletamento, suddivisa in campi strutturati. La scarsità è normale: sono popolati solo i campi che l'entità risolta fornisce in mente. Ad esempio, streetName e streetNumber appaiono solo per indirizzi a livello strada, e intersection appaiono solo per i risultati degli incroci stradali.

AddressAdminDistrictsItem

Una suddivisione amministrativa che contiene un indirizzo. Ad esempio, uno stato, una provincia o una contea. Restituito come una voce nella matrice principale Address.adminDistricts , dove le voci sono ordinate dal più grossolano al più fine.

AddressCountryRegion

Il paese o la regione che contiene l'indirizzo, identificato dal nome visualizzato e dal codice paese ISO 3166-1 Alpha-2. Entrambi i campi possono essere omessi in una determinata risposta.

Azure.Core.Foundations.Error

Oggetto error.

Azure.Core.Foundations.ErrorResponse

Risposta contenente i dettagli dell'errore.

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche sull'errore. Secondo le linee guida Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.

CalculationMethodEnum

Metodo usato per calcolare il punto di geocodifica.

ConfidenceEnum

Il livello di attendibilità che il risultato della posizione geocodificata è una corrispondenza. Usa questo valore insieme ai codici di corrispondenza per ottenere informazioni più complete sulla corrispondenza.

La fiducia di una posizione geocodificata si basa su molti fattori, inclusa l'importanza relativa della posizione geocodificata e la posizione dell'utente, se specificata.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

FeatureCollectionEnum

Il GeoJSON tipo di oggetto utilizzato alla radice delle risposte riuscite delle operazioni di geocodifica diretta, geocodifica inversa e autocompletamento (incluse le loro varianti batch). L'unico valore è FeatureCollection, come definito nell'RFC 7946. Get Polygon è l'unica eccezione: la sua radice di risposta è un GeoJSON Feature, vedi FeatureTypeEnum.

FeaturesItem

Una singola voce nell'array features di un GeocodingResponse, conforme alla forma dell'oggetto GeoJSON Feature . Rappresenta una posizione geocodificata: dati strutturati su properties, una coordinata rappresentativa su geometry, e una scatola delimitatrice opzionale su bbox.

FeaturesItemProperties

Il properties payload di una caratteristica in un GeocodingResponse. Contiene gli indicatori di tipo di entità e di qualità di corrispondenza per la posizione geocodificata, i suoi componenti di indirizzo analizzati e uno o più punti di geocodice che collegano la posizione a coordinate specifiche.

FeatureTypeEnum

Il GeoJSON tipo di oggetto per Feature gli oggetti. Etichetta ogni voce all'interno dell'array features di una FeatureCollection risposta (geocodifica, geocodifica inversa, autocompletamento) e appare alla radice della Get Polygon risposta. L'unico valore è Feature, come definito nell'RFC 7946.

GeocodePointsItem

Un punto di geocodifica per una posizione: una coordinata più metadati che descrivono come il punto è stato calcolato (calculationMethod) e a cosa è più adatto (usageTypes). Una singola caratteristica di solito restituisce separati Display e Route punti, così che i chiamanti possano scegliere quella più adatta al compito.

GeocodingBatchResponse

Il corpo di risposta riuscito restituì da Get Geocoding Batch. Contiene un summary numero di query inviate riuscite più un batchItems array contenente una voce di risposta per ogni query nella richiesta, nello stesso ordine dell'array delle richieste batchItems .

GeocodingBatchResponseItem

Una singola voce all'interno GeocodingBatchResponse.batchItemsdi , che porta il risultato di una delle query dalla voce corrispondente GeocodingBatchRequestBody.batchItems . Le query riuscite emergono qui geocodificate features nella stessa forma di GeocodingResponse; query fallite emergono informazioni diagnostiche tramite error invece. Esattamente uno di features o error è popolata per ogni voce.

GeocodingBatchResponseSummary

Contiene i conteggi aggregati per una Get Geocoding Batch risposta: la dimensione del lotto inviato e quante delle sue query sono state elaborate con successo. Usato come tipo di GeocodingBatchResponse.summary.

GeoJsonObjectType

Specifica il tipo di GeoJSON. Deve essere uno dei nove tipi di oggetto GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPoint

Tipo geometry GeoJSON Point valido. Per informazioni dettagliate, vedere RFC 7946.

Intersection

I dettagli dell'intersezione per un indirizzo si risolvono come un incrocio stradale — l'angolo dove si incontrano due o più strade con nome. Popolata solo quando l'entità risolta è un RoadIntersection; il genitore Address.intersection viene altrimenti omesso.

MatchCodesEnum

Un valore di codice di corrispondenza che indica come il servizio di geocodifica ha prodotto un determinato risultato di località. Il matchCodes campo su una caratteristica è un array di questi valori; combinali con confidence e type per valutare la qualità della corrispondenza.

ResultTypeEnum

Un tipo di entità restituito dall'operazione Get Reverse Geocoding Batch . Fornito come uno o più valori nel campo per batch per limitare resultTypes la risposta di quell'elemento a tipi specifici di posizione; quando il campo viene omesso, tutti i tipi di entità sono ammissibili. Quando entità di più di un tipo corrispondono a una coordinata, viene restituita solo la più specifica. Elencati dal più specifico al meno specifico: Address, Neighborhood, PopulatedPlace, Postcode1, AdminDivision1, AdminDivision2, . CountryRegion

ReverseGeocodingBatchRequestBody

L'organo richiedente per l'operazione Get Reverse Geocoding Batch . Trasporta una o più query individuali di geocodifica inversa — tra 1 e 100, inclusi — che il servizio elabora come singola chiamata e restituisce come un array parallelo batchItems su GeocodingBatchResponse.

ReverseGeocodingBatchRequestItem

Una query di geocodifica inversa all'interno di un ReverseGeocodingBatchRequestBody.batchItems array. Ogni elemento è una richiesta indipendente di geocodifica inversa equivalente a una singola chiamata a Get Reverse Geocoding, espressa come campi piuttosto che come parametri di query URL. Specificare la posizione da retro-geocodificare tramite coordinates; opzionalmente restringere i tipi di entità tramite resultTypes e la vista geopolitica tramite view.

UsageTypeEnum

L'uso previsto per un punto di geocodifica. Un punto di geocodice restituito dal servizio contiene uno o più tipi di utilizzo che indicano come un'applicazione client dovrebbe consumare il punto: ad esempio, visualizzare la posizione su una mappa rispetto al passaggio di un veicolo verso di essa.