Class SearchNearbyRequest

Request proto for Search Nearby.

Inheritance
object
SearchNearbyRequest
Implements
Inherited Members
Namespace: Google.Maps.Places.V1
Assembly: Google.Maps.Places.V1.dll
Syntax
public sealed class SearchNearbyRequest : IMessage<SearchNearbyRequest>, IEquatable<SearchNearbyRequest>, IDeepCloneable<SearchNearbyRequest>, IBufferMessage, IMessage

Constructors

SearchNearbyRequest()

Declaration
public SearchNearbyRequest()

SearchNearbyRequest(SearchNearbyRequest)

Declaration
public SearchNearbyRequest(SearchNearbyRequest other)
Parameters
Type Name Description
SearchNearbyRequest other

Properties

ExcludedPrimaryTypes

Excluded primary Place type (e.g. "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types.

Up to 50 types from Table A may be specified.

If there are any conflicting primary types, i.e. a type appears in both included_primary_types and excluded_primary_types, an INVALID_ARGUMENT error is returned.

If a Place type is specified with multiple type restrictions, only places that satisfy all of the restrictions are returned. For example, if we have {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]}, the returned places provide "restaurant" related services but do not operate primarily as "restaurants".

Declaration
public RepeatedField<string> ExcludedPrimaryTypes { get; }
Property Value
Type Description
RepeatedField<string>

ExcludedTypes

Excluded Place type (eg, "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types.

Up to 50 types from Table A may be specified.

If the client provides both included_types (e.g. restaurant) and excluded_types (e.g. cafe), then the response should include places that are restaurant but not cafe. The response includes places that match at least one of the included_types and none of the excluded_types.

If there are any conflicting types, i.e. a type appears in both included_types and excluded_types, an INVALID_ARGUMENT error is returned.

If a Place type is specified with multiple type restrictions, only places that satisfy all of the restrictions are returned. For example, if we have {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]}, the returned places provide "restaurant" related services but do not operate primarily as "restaurants".

Declaration
public RepeatedField<string> ExcludedTypes { get; }
Property Value
Type Description
RepeatedField<string>

IncludedPrimaryTypes

Included primary Place type (e.g. "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types. A place can only have a single primary type from the supported types table associated with it.

Up to 50 types from Table A may be specified.

If there are any conflicting primary types, i.e. a type appears in both included_primary_types and excluded_primary_types, an INVALID_ARGUMENT error is returned.

If a Place type is specified with multiple type restrictions, only places that satisfy all of the restrictions are returned. For example, if we have {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]}, the returned places provide "restaurant" related services but do not operate primarily as "restaurants".

Declaration
public RepeatedField<string> IncludedPrimaryTypes { get; }
Property Value
Type Description
RepeatedField<string>

IncludedTypes

Included Place type (eg, "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types.

Up to 50 types from Table A may be specified.

If there are any conflicting types, i.e. a type appears in both included_types and excluded_types, an INVALID_ARGUMENT error is returned.

If a Place type is specified with multiple type restrictions, only places that satisfy all of the restrictions are returned. For example, if we have {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]}, the returned places provide "restaurant" related services but do not operate primarily as "restaurants".

Declaration
public RepeatedField<string> IncludedTypes { get; }
Property Value
Type Description
RepeatedField<string>

LanguageCode

Place details will be displayed with the preferred language if available. If the language code is unspecified or unrecognized, place details of any language may be returned, with a preference for English if such details exist.

Current list of supported languages: https://developers.google.com/maps/faq#languagesupport.

Declaration
public string LanguageCode { get; set; }
Property Value
Type Description
string

LocationRestriction

Required. The region to search.

Declaration
public SearchNearbyRequest.Types.LocationRestriction LocationRestriction { get; set; }
Property Value
Type Description
SearchNearbyRequest.Types.LocationRestriction

MaxResultCount

Maximum number of results to return. It must be between 1 and 20 (default), inclusively. If the number is unset, it falls back to the upper limit. If the number is set to negative or exceeds the upper limit, an INVALID_ARGUMENT error is returned.

Declaration
public int MaxResultCount { get; set; }
Property Value
Type Description
int

RankPreference

How results will be ranked in the response.

Declaration
public SearchNearbyRequest.Types.RankPreference RankPreference { get; set; }
Property Value
Type Description
SearchNearbyRequest.Types.RankPreference

RegionCode

The Unicode country/region code (CLDR) of the location where the request is coming from. This parameter is used to display the place details, like region-specific place name, if available. The parameter can affect results based on applicable law.

For more information, see https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.

Note that 3-digit region codes are not currently supported.

Declaration
public string RegionCode { get; set; }
Property Value
Type Description
string

RoutingParameters

Optional. Parameters that affect the routing to the search results.

Declaration
public RoutingParameters RoutingParameters { get; set; }
Property Value
Type Description
RoutingParameters