Struct google_api_proto::google::maps::places::v1::AutocompletePlacesRequest

pub struct AutocompletePlacesRequest {
    pub input: String,
    pub location_bias: Option<LocationBias>,
    pub location_restriction: Option<LocationRestriction>,
    pub included_primary_types: Vec<String>,
    pub included_region_codes: Vec<String>,
    pub language_code: String,
    pub region_code: String,
    pub origin: Option<LatLng>,
    pub input_offset: i32,
    pub include_query_predictions: bool,
    pub session_token: String,
}

Request proto for AutocompletePlaces.

Fields

input: String

Required. The text string on which to search.

location_bias: Option<LocationBias>

Optional. Bias results to a specified location.

At most one of location_bias or location_restriction should be set. If neither are set, the results will be biased by IP address, meaning the IP address will be mapped to an imprecise location and used as a biasing signal.

location_restriction: Option<LocationRestriction>

Optional. Restrict results to a specified location.

At most one of location_bias or location_restriction should be set. If neither are set, the results will be biased by IP address, meaning the IP address will be mapped to an imprecise location and used as a biasing signal.

included_primary_types: Vec<String>

Optional. Included primary Place type (for example, “restaurant” or “gas_station”) in Place Types (https://developers.google.com/maps/documentation/places/web-service/place-types), or only (regions), or only (cities). A Place is only returned if its primary type is included in this list. Up to 5 values can be specified. If no types are specified, all Place types are returned.

included_region_codes: Vec<String>

Optional. Only include results in the specified regions, specified as up to 15 CLDR two-character region codes. An empty set will not restrict the results. If both location_restriction and included_region_codes are set, the results will be located in the area of intersection.

language_code: String

Optional. The language in which to return results. Defaults to en-US. The results may be in mixed languages if the language used in input is different from language_code or if the returned Place does not have a translation from the local language to language_code.

region_code: String

Optional. The region code, specified as a CLDR two-character region code. This affects address formatting, result ranking, and may influence what results are returned. This does not restrict results to the specified region. To restrict results to a region, use region_code_restriction.

origin: Option<LatLng>

Optional. The origin point from which to calculate geodesic distance to the destination (returned as distance_meters). If this value is omitted, geodesic distance will not be returned.

input_offset: i32

Optional. A zero-based Unicode character offset of input indicating the cursor position in input. The cursor position may influence what predictions are returned.

If empty, defaults to the length of input.

include_query_predictions: bool

Optional. If true, the response will include both Place and query predictions. Otherwise the response will only return Place predictions.

session_token: String

Optional. A string which identifies an Autocomplete session for billing purposes. Must be a URL and filename safe base64 string with at most 36 ASCII characters in length. Otherwise an INVALID_ARGUMENT error is returned.

The session begins when the user starts typing a query, and concludes when they select a place and a call to Place Details or Address Validation is made. Each session can have multiple queries, followed by one Place Details or Address Validation request. The credentials used for each request within a session must belong to the same Google Cloud Console project. Once a session has concluded, the token is no longer valid; your app must generate a fresh token for each session. If the session_token parameter is omitted, or if you reuse a session token, the session is charged as if no session token was provided (each request is billed separately).

We recommend the following guidelines:

• Use session tokens for all Place Autocomplete calls.
• Generate a fresh token for each session. Using a version 4 UUID is recommended.
• Ensure that the credentials used for all Place Autocomplete, Place Details, and Address Validation requests within a session belong to the same Cloud Console project.
• Be sure to pass a unique session token for each new session. Using the same token for more than one session will result in each request being billed individually.

Trait Implementations

impl Clone for AutocompletePlacesRequest

fn clone(&self) -> AutocompletePlacesRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AutocompletePlacesRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AutocompletePlacesRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for AutocompletePlacesRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for AutocompletePlacesRequest

fn eq(&self, other: &AutocompletePlacesRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AutocompletePlacesRequest