Interface PlaceDetailsRequest

interface PlaceDetailsRequest {
    params: {
        fields?: string[];
        language?: Language;
        place_id: string;
        region?: string;
        sessiontoken?: string;
    } & RequestParams;
}

Hierarchy

  • Partial<AxiosRequestConfig>
    • PlaceDetailsRequest

Properties

params

Properties

params

params: {
    fields?: string[];
    language?: Language;
    place_id: string;
    region?: string;
    sessiontoken?: string;
} & RequestParams

Type declaration

  • Optionalfields?: string[]

    One or more fields, specifying the types of place data to return, separated by a comma.

    **Warning: If you do not specify at least one field with a request, or if you omit the fields parameter from a request, ALL possible fields will be returned, and you will be billed accordingly. This applies only to Place Details requests.

  • Optionallanguage?: Language

    The language code, indicating in which language the results should be returned, if possible. Note that some fields may not be available in the requested language. Note that we often update supported languages so this list may not be exhaustive.

  • place_id: string

    A textual identifier that uniquely identifies a place, returned from a Place Search.

  • Optionalregion?: string

    The region code, specified as a ccTLD (country code top-level domain) two-character value. Most ccTLD codes are identical to ISO 3166-1 codes, with some exceptions. This parameter will only influence, not fully restrict, results. If more relevant results exist outside of the specified region, they may be included. When this parameter is used, the country name is omitted from the resulting formatted_address for results in the specified region.

  • Optionalsessiontoken?: string

    A random string which identifies an autocomplete session for billing purposes. Use this for Place Details requests that are called following an autocomplete request in the same user session

Settings

Member Visibility

On This Page

Properties