GMSPlaceSearchNearbyRequest 类参考

GMSPlaceSearchNearbyRequest 类参考

概览

GMSPlacesClient 搭配使用的请求对象,用于提取附近的地点。

公开成员函数

(instancetype)- initWithLocationRestriction:placeProperties:
 实例化具有位置限制的 GMSPlaceSearchNearbyRequest,并要返回的地点属性。

属性

ID<GMSPlaceLocationRestriction >locationRestriction
 默认 init 不可用。
NSArray&lt;GMSPlaceProperty >*placeProperties
 应包含在地点结果中的 GMSPlaceProperty 数组。
NSArray&lt;NSString * >*includedTypes
 要包含在搜索中的地点类型的数组。
NSArray&lt;NSString * >*excludedTypes
 要从搜索中排除的地点类型的数组。
NSArray&lt;NSString * >*includedPrimaryTypes
 要包含在搜索中的主要地点类型的数组。
NSArray&lt;NSString * >*excludedPrimaryTypes
 要从搜索中排除的主要地点类型的数组。
NSIntegermaxResultCount
 要返回的 GMSPlace 结果的数量上限。
NSString * regionCode
 请求来源位置的 Unicode 国家/地区代码 (CLDR)。
GMSPlaceSearchNearbyRankPreferencerankPreference
 GMSPlaceSearchNearbyRankPreference,用于对请求返回的结果进行排序。

成员函数文档

- (instancetype) initWithLocationRestriction: (id<GMSPlaceLocationRestriction >) locationRestriction
placeProperties: (NSArray< GMSPlaceProperty > *) placeProperties

实例化具有位置限制的 GMSPlaceSearchNearbyRequest,并要返回的地点属性。

参数:
locationRestriction要搜索的区域,以圆形表示,由中心点和半径(以米为单位)定义。
placeProperties应包含在地点结果中的 GMSPlaceProperty 数组。不得为空。如果列表为空,将导致尝试发送请求时出错。

属性说明

- (id<GMSPlaceLocationRestriction>)locationRestriction [read, write, copy]GMSPlaceLocationRestriction

默认 init 不可用。

请使用指定的初始化程序。要搜索的区域,以圆形表示,由中心点和半径(以米为单位)定义。半径必须介于 0.0 和 50000.0 之间(含 0.0 和 50000.0)。打破此限制将导致 INVALID_ARGUMENT 错误。必须使用 GMSPlaceCircularLocationOption 指定 locationRestriction。使用 GMSPlaceRectangularLocationOption 将导致 INVALID_REQUEST 错误。

- (NSArray<GMSPlaceProperty>*) placeProperties [read, write, copy]

应包含在地点结果中的 GMSPlaceProperty 数组。

不得为空。如果列表为空,将导致尝试发送请求时出错。

- (NSArray<NSString *>*) includedTypes [read, write, copy]

要包含在搜索中的地点类型的数组。

最多可以指定 50 种类型。如果为一个请求指定了多种类型限制,则系统仅返回满足所有限制的地点。如果该数组为空,则返回所有类型的所有地点。如需查看受支持类型的列表,请参阅表 A:https://developers.google.com/maps/documentation/places/web-service/place-types#table-a

- (NSArray<NSString *>*) excludedTypes [read, write, copy]

要从搜索中排除的地点类型的数组。

最多可以指定 50 种类型。如果为一个请求指定了多种类型限制,则系统仅返回满足所有限制的地点。如果指定的类型存在冲突(例如,includeTypes 和 excludedTypes 中显示的类型),系统会返回 INVALID_REQUEST 错误。如需查看受支持类型的列表,请参阅表 A:https://developers.google.com/maps/documentation/places/web-service/place-types#table-a

- (NSArray<NSString *>*) includedPrimaryTypes [read, write, copy]

要包含在搜索中的主要地点类型的数组。

最多可以指定 50 种类型。如果为一个请求指定了多种类型限制,则系统仅返回满足所有限制的地点。如需详细了解主要类型,请参阅:https://developers.google.com/maps/documentation/places/web-service/nearby-search#includedtypesexcludedtypes,-includedprimarytypesexcludedprimarytypes

- (NSArray<NSString *>*) excludedPrimaryTypes [read, write, copy]

要从搜索中排除的主要地点类型的数组。

如果指定了冲突的类型(例如,includedTypes 和 excludedTypes 中显示的类型),系统会返回 INVALID_REQUEST 错误。最多可以指定 50 种类型。如果为一个请求指定了多种类型限制,则系统仅返回满足所有限制的地点。如需详细了解主要类型,请参阅:https://developers.google.com/maps/documentation/places/web-service/nearby-search#includedtypesexcludedtypes,-includedprimarytypesexcludedprimarytypes

- (NSInteger) maxResultCount [read, write, assign]

要返回的 GMSPlace 结果的数量上限。

必须介于 1 到 20(默认值)之间(包括 1 和 20)。打破此限制将导致返回错误。

- (NSString*) regionCode [read, write, copy]

请求来源位置的 Unicode 国家/地区代码 (CLDR)。

有关区域代码,请参阅 https://www.unicode.org/cldr/charts/44/supplemental/territory_language_information.html

- (GMSPlaceSearchNearbyRankPreference) rankPreference [read, write, assign]

GMSPlaceSearchNearbyRankPreference,用于对请求返回的结果进行排序。

默认值为 GMSPlaceSearchNearbyRankPopularity