interface FindPlaceFromTextRequest {
    params: {
        fields?: string[];
        input: string;
        inputtype: PlaceInputType;
        language?: Language;
        locationbias?: string;
    } & RequestParams;
}

Hierarchy

  • Partial<AxiosRequestConfig>
    • FindPlaceFromTextRequest

Properties

Properties

params: {
    fields?: string[];
    input: string;
    inputtype: PlaceInputType;
    language?: Language;
    locationbias?: string;
} & RequestParams

Type declaration

  • Optionalfields?: string[]

    The fields specifying the types of place data to return.

    Note: If you omit the fields parameter from a Find Place request, only the place_id for the result will be returned.

  • input: string

    The text input specifying which place to search for (for example, a name, address, or phone number).

  • inputtype: PlaceInputType

    The type of input. This can be one of either textQuery or phoneNumber.

  • Optionallanguage?: Language

    The language code, indicating in which language the results should be returned, if possible. Searches are also biased to the selected language; results in the selected language may be given a higher ranking

  • Optionallocationbias?: string

    Prefer results in a specified area, by specifying either a radius plus lat/lng, or two lat/lng pairs representing the points of a rectangle. If this parameter is not specified, the API uses IP address biasing by default.