List of KeyValuePairType elements as generic container to attach additional information to requests. Recognized address units are returned in the Address.
AdditionalData field, where the designator is the key and the unit value is the value of the entry. List of Provider IDs space separated for address source that should be considered additionally in the search.
Currently only provider ID 24 is supported. Provider 24 adds some addresses in Germany for which the map data does not have geometry yet. The addresses therefore only have a display coordinate. If data from an additional address provider is returned, the corresponding Location element is flagged with an additionalData entry additionalAddressProvider identifying the provider. Extrapolation is performed until a predefined maximum distance in house number and a maximum in meters.
If any of the maximum is exceeded the result falls back to the street level match. This is the default value. Fallback is performed until a predefined maximum distance in house number. If the maximum is exceeded, the result falls back to the street level match. Streetlevel : Do not do extrapolation or fallback; instead return a streetlevel match up-hierarchy. Customizes flexibility in the input values for the admin hierarchy defined in LocationFilterType.
The value is a bitmask defining which hierarchies might be swapped without impacting the match level:. Please note this option is for geocoding addresses and needs at least street level input to work as designed.
It will not return expected results when the input is a named place only e. Supported levels are: countrystatecountycitydistrictpostalCodedefault. Only one level is supported per request. Level default returns the area shape corresponding to the match level. Area level used to restrict address results. When reverse geocoding a coordinate, only address results within the enclosing admin area of the specified level are returned. The parameter can be used to restrict results to the country of the input coordinate.
Only country is supported. By default, the preferred admin and street names for forward geocoding in the result are the names from the user input.
Normalized means name normalization for all Geocoder API components. The matched result will be of locationType distanceMarker and provide the offset to the reference Distance Marker.REST API concepts and examples
The reference Distance Marker as well as the next Distance Marker in the sequence if available are returned as related locations to the matched location. The option is supported for the retrieveAddresses mode in the reversegeocode endpoint.
Products Products Location Services. Solve complex location problems from geofencing to custom routing. Geocoding and Search. Fleet Telematics. Live Sense SDK.This guide discusses techniques for setting up web service requests and parsing the responses.
Google Maps Platform web services are an interface for requesting Maps API data from external services and using the data within your Maps applications.
These services are designed to be used in conjunction with a map, as per the License Restrictions in the Google Maps Platform Terms of Service. This guide describes some common practices useful for setting up your web service requests and processing your web service responses. Get more information on authentication credentials. Requests made over HTTP that include sensitive data may be rejected.
You may think that a "valid" URL is self-evident, but that's not quite the case. A URL entered within an address bar in a browser, for example, may contain special characters e. By the same token, any code that generates or accepts UTF-8 input might treat URLs with UTF-8 characters as "valid", but would also need to translate those characters before sending them out to a web server.
This process is called URL-encoding. We need to translate special characters because all URLs need to conform to the syntax specified by the W3 Uniform Resource Identifier specification. The table below summarizes these characters:. When building a valid URL, you must ensure that it contains only those characters shown above. Conforming a URL to use this set of characters generally leads to two issues, one of omission and one of substitution:.
The string? Converting a URL that you receive from user input is sometimes tricky. Additionally, URLs are limited to characters for all web services. For most services, this character limit will seldom be approached. However, note that certain services have several parameters that may result in long URLs. Poorly designed API clients can place more load than necessary on both the Internet and Google's servers.
This section contains some best practices for clients of the APIs. Following these best practices can help you avoid your application being blocked for inadvertent abuse of the APIs. Often it is worthwhile re-trying the request as the followup request may succeed when the original failed.
However, it is important not to simply loop repeatedly making requests to Google's servers. This looping behavior can overload the network between your client and Google causing problems for many parties. A better approach is to retry with increasing delays between attempts. Usually the delay is increased by a multiplicative factor with each attempt, an approach known as Exponential Backoff.
You should also be careful that there isn't retry code higher in the application call chain that leads to repeated requests in quick succession. To avoid this, you should make sure that API requests are not synchronized between clients. For example, consider an application that displays the time in the current time zone. This application will probably set an alarm in the client operating system waking it up at the start of the minute so that the displayed time can be updated.
The application should not make any API calls as part of the processing associated with that alarm. Making API calls in response to a fixed alarm is bad as it results in the API calls being synchronized to the start of the minute, even between different devices, rather than being distributed evenly over time.This section provides a comprehensive reference to the query parameters supported by the Geocoder API.
The Geocoder API service defines one unified request structure for all scenarios. Depending on the usage scenario, different parameter subsets are supported. Please refer to the chapter Examples for supported parameter combinations. Products Products Location Services.
Solve complex location problems from geofencing to custom routing. Geocoding and Search. Fleet Telematics. Live Sense SDK. Cloud environments for location-centric solution development, data exchange and visualization. Fast and accurate tracking and positioning of people and devices, indoors or outdoors. Indoor Positioning. Easy to use, scaleable and flexible tools to get going quickly.
Developer Ecosystems. Access Location Services on your favorite developer platform ecosystem. AWS Marketplace. AWS Serverless. Microsoft Azure.
Documentation Location Services.The World Geocoding Service includes a method that allows character-by-character autocomplete suggestions to be generated for user input in a client application. This capability facilitates the interactive search user experience by reducing the number of characters that need to be typed before a suggested match is obtained.
The idea is that a client application can provide a list of suggestions that is updated with each character entered by a user until the place they are looking for is returned in the list. For example, if a user wants to find Stanford Ave, Bowden, North Dakota, they need to type only stanfoand the address they are looking for is returned as an item in the suggestion list.
Or if they are looking for a Disney park but don't know the proper name or address, they can find it using suggest. Most of the search types that can be made with the findAddressCandidates operation can also be made with suggestions.
Specifically, the following types of searches are supported by the suggest operation:. Additionally, the suggest operation utilizes the same proximity algorithm as the findAddressCandidates operation.
Make sure the request URLs sent to the service are properly encoded and patterned after the examples in this topic. The parameters for suggest are listed in the subsections that follow, categorized by required and optional parameters. The input text entered by a user, which is used by the suggest operation to generate a list of possible matches. You can specify the response format using the f parameter. Defines an origin point that is used to prefer or boost geocoding candidates based on their proximity to the location.
Candidates near the location are prioritized relative to those further away. This is useful in mobile applications where a user wants to search for places in the vicinity of their current GPS location, or in mapping applications where users want to search for places near the center of the map.
The location can be represented with a simple comma-separated syntax x,yor as a JSON point object. If the comma-separated syntax is used, the spatial reference of the coordinates must be WGS84; otherwise, the spatial reference of the point coordinates can be defined in the JSON object. The distance parameter is deprecated and no longer recognized by the geocoding service. A place or address type that can be used to filter suggest results.
The parameter supports input of single category values or multiple comma-separated values. The category parameter must be passed in a request with the text parameter.
See Category filtering for complete details about the category parameter. If more than one value is specified for the parameter, the values must be separated by a comma, with no spaces after the comma. A set of bounding box coordinates that limit the search area for suggestions to a specific region.
This is especially useful for applications in which a user will search for places and addresses within the current map extent. You can specify the spatial reference of the searchExtent coordinates, which is necessary if the map spatial reference is different than that of the geocoding service; otherwise, the spatial reference of the coordinates is assumed to be the same as that of the geocoding service.
The input can either be a comma-separated list of coordinates defining the bounding box or a JSON envelope object. The spatial reference of the bounding box coordinates can be included if an envelope object is used.
The maximum number of suggestions returned by a suggest operation, up to the maximum number allowed by the service. Currently, the World Geocoding Service allows up to 15 suggestions to be returned. If maxSuggestions is not included in the suggest request, the default value is 5.Below you will find descriptions of the parameters shared among these APIs, as well as sample requests and responses.
Overridden if address is provided.
ArcGIS REST API
The coordinates are represented by a comma separated pair of floating point numbers representing longitude and latitude, in that order. We recommend six digits after the decimal point for increased accuracy.
Double Array This parameter is used with includePostedSpeedLimit to increase accuracy of getting the correct speed limit. Those details are returned within the PlaceName parameter. Default is false. Read more about setting the dataset. Developer Guide Release Notes. Geocoding Reverse geocoding Batch geocoding Batch reverse geocoding Below you will find descriptions of the parameters shared among these APIs, as well as sample requests and responses.
Wildcard search is not supported for city field. The stringSearch field should be used for wildcard searches. FIPS is the default format. The name of the city. The country code using the format set by countryAbbrevType. ENUS - U. Allows searching of [ZIP] [city,] [state][; street address] or [splc] all on one line. Contains geographic coordinates used in reverse geocoding.
When looking up coordinates, this sets a maximum radius, in miles, in which to find the closest matching road. For users licensed for speed limit data, this parameter will include the posted speed limit in the response.
Speed limits may differ based on direction. The time UTC assumed if none specified at the location which will be used to determine whether daylight savings time will be applied on the output time zone.
Set to true to return any TrimblePlaceIds and Place names associated with the geocoded location. For users licensed for multiple regional datasets.The response to a successful request always contains a default set of elements. However, the service offers flexibility in this respect, allowing you to fine-tune the response by elminating information you do not require or adding information that is not among the default elements.
You can manage the information in the response through attribute switch parameters :. For example, to add matchCode and parsedRequestadd the following to the request:. The following example removes mapView so that the response contains only address and mapReference :.
Subscribe to RSS
To add additionalData to the previous example and to ensure that the response contains addressmapReference and additionalDatause:. If all attributes except mapView are required, use the value all and remove unnecessary attributes. The following example causes the whole attribute set except mapView to be included in the response:.
The table below documents the supported attribute switch parameters and their values. This information is also available under Geocode Resource. Enumeration [ countrystatecountycitydistrictsubdistrictstreethouseNumberpostalCodeaddressLinesadditionalData ].
Abbreviated forms: [ ctrstactycitdissdistrhnrpstalnadd ]. For retrieving Time Zone information the parameter adminInfo has to be added, e.
The related. Default in reverse geocoding response: addressmapViewadditionalDatamapReferenceadminIds. Default in forward geocoding response: addressmapViewadditionalData. Abbreviated forms: [ psmqmtmcpr ]. Products Products Location Services. Solve complex location problems from geofencing to custom routing. Geocoding and Search. Fleet Telematics. Live Sense SDK. Cloud environments for location-centric solution development, data exchange and visualization.
Build, Exchange, Create. HERE platform.A mail notification is sent on completion of the Batch job. The mail address it not used for any other purposes. Option to ignore unknown input columns. Note: This option disables spell checking. For example, if the input column "city" is misspelled as "citty" this column will be ignored. If combined with includeInputFields all ignored fields are also included in the output. Option to include all input fields in the output. In case of naming conflicts with other output columns, input fields are prefixed by "in:".
Examples: searchText in:city in:postalCode in:country. Option to include invalid input lines in the output file. Invalid input lines are for example lines with a wrong number of fields. This option works for invalid lines in a similar way as outputcombined for Geocoder empty results. The following parameters can be used to define default parameters for each Geocoding request in the input.
Specify the political view. Available territories will be seen through the point of view of this country. If this parameter is not specified the neutral international view is made available, where territories may have unresolved claims. Products Products Location Services. Solve complex location problems from geofencing to custom routing. Geocoding and Search. Fleet Telematics. Live Sense SDK. Cloud environments for location-centric solution development, data exchange and visualization.