Skip to main content

Place autocomplete

The Place Autocomplete activity can match on full words as well as substrings. Applications can therefore send queries as the user types, to provide on-the-fly place predictions.

The returned predictions are designed to be presented to the user to aid them in selecting the desired place. You can send a Place Details request for more information about any of the places which are returned.

Properties​

Input​

  • Input - The text string on which to search. The Place Autocomplete service will return candidate matches based on this string and order results based on their perceived relevance.

    Data Type: System.String Example

Example: “Prestige Trade”

  • Location: The latitude/longitude around which to retrieve place information. This must be specified as latitude,longitude.

    Data Type: System.String

Example: “-33.8670522,151.1957362”

  • Components: A grouping of places to which you would like to restrict your results. Currently, you can use components to filter by up to 5 countries. Countries must be passed as a two character, ISO 3166-1 Alpha-2 compatible country code. For example: components=country:fr would restrict your results to places within France. Multiple countries must be passed as multiple country: XX filters, with the pipe character (|) as a separator. For example: components=country:us|country:pr|country:vi|country:gu|country:mp would restrict your results to places within the United States and its unincorporated organized territories.

    Data Type: System.String

Example: “country:fr”

  • Language: The language code, indicating in which language the results should be returned, if possible. See the list of supported languages and their codes.

    Data Type: System.String

Example: “zh” for Chinese

  • Offset: The position, in the input term, of the last character that the service uses to match predictions.

    Data Type: System.String

Example: if the input is 'Google' and the offset is 3, the service will match on 'Goo'. The string determined by the offset is matched against the first word in the input term only. For example, if the input term is 'Google abc' and the offset is 3, the service will attempt to match against 'Goo abc'. If no offset is supplied, the service will use the whole term. The offset should generally be set to the position of the text caret.

  • Origin: The origin point from which to calculate straight-line distance to the destination (returned as distance_meters). If this value is omitted, straight-line distance will not be returned. Must be specified as latitude,longitude.

    Data Type: System.String

Example: “-33.8670522,151.1957362”

  • Session Token: A random string which identifies an autocomplete session for billing purposes. If this parameter is omitted from an autocomplete request, the request is billed independently. See the pricing sheet for details.

    Data Type: System.String

  • Radius: Defines the distance (in meters) within which to return place results. The maximum allowed radius is 50 000 meters. Note that radius must not be included if rankby=distance.

    Data Type: System.String

Example: “500”

  • Strict Bounds: Returns only those places that are strictly within the region defined by location and radius. This is a restriction, rather than a bias, meaning that results outside this region will not be returned even if they match the user input.

    Data Type: System.String

Example: “true” – if set to true, returns only places within region strictly

  • Types: The types of place results to return. See Place Types below. If no type is specified, all types will be returned.

    Data Type: System.String

Example: “establishment”

Output​

  • JSON: The output in the form of a JSON string.

    Data Type: System.String

  • Predictions: The list of predictions.

    Data Type: UiPathTeam.GoogleMaps.Model.PlaceAutocomplete.PlaceAutocompleteResponse

Common​

  • DisplayName - The display name of the activity.

Misc​

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level. Fore more info follow the link.