locationservice_get_place: Finds a place by its unique ID

View source: R/locationservice_operations.R

locationservice_get_placeR Documentation

Finds a place by its unique ID

Description

Finds a place by its unique ID. A PlaceId is returned by other search operations.

See https://www.paws-r-sdk.com/docs/locationservice_get_place/ for full documentation.

Usage

locationservice_get_place(IndexName, PlaceId, Language = NULL, Key = NULL)

Arguments

IndexName

[required] The name of the place index resource that you want to use for the search.

PlaceId

[required] The identifier of the place to find.

Language

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as A\Theta\eta\nu\alpha.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

Key

The optional API key to authorize the request.


paws.application.integration documentation built on Sept. 12, 2024, 6:11 a.m.