列挙型のドキュメント
関数に関するドキュメント
- (インスタンスタイプ)initWithLocationRestriction: | (id< GMSPlaceLocationRestriction >) | locationRestriction | |
placeProperties: | (NSArray< GMSPlaceProperty > *) | placeProperties | |
場所の制限と返す場所プロパティを含む GMSPlaceSearchNearbyRequest
をインスタンス化します。
- パラメータ:
-
locationRestriction 検索対象の領域を円で指定し、中心点と半径(メートル単位)で定義します。 placeProperties プレイス結果に含める必要がある GMSPlaceProperty
の配列。空にすることはできませんリストが空の場合、リクエストを送信しようとするとエラーが発生します。
プロパティ
- (id<GMSPlaceLocationRestriction>) locationRestriction [read, write, copy] |
デフォルトの init は使用できません。
指定のイニシャライザを使用してください。検索対象の領域を円で指定し、中心点と半径(メートル単位)で定義します。radius は 0.0 ~ 50000.0 の範囲で指定する必要があります。この制限に違反すると、INVALID_ARGUMENT エラーが発生します。locationRestriction は GMSPlaceCircularLocationOption
で指定する必要があります。GMSPlaceRectangularLocationOption
を使用すると、INVALID_REQUEST エラーが発生します。
- (NSArray<GMSPlaceProperty>*) placeProperties [read, write, copy] |
プレイス結果に含める必要がある GMSPlaceProperty
の配列。
空にすることはできませんリストが空の場合、リクエストを送信しようとするとエラーが発生します。
- (NSArray<NSString *>*) includeTypes [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 *>*) includePrimaryTypes [read, write, copy] |
検索に含める主要な場所タイプの配列。
最大 50 個のタイプを指定できます。複数のタイプの制限が設定されたリクエストが指定されている場合は、すべての制限を満たす場所のみが返されます。プライマリ タイプの詳細については、https://developers.google.com/maps/documentation/places/web-service/nearby-search#includedtypesexcludedtypes,-includedprimarytypesexcludedprimarytypes をご覧ください。
- (NSArray<NSString *>*)excludePrimaryTypes [read, write, copy] |
検索から除外する主な場所のタイプの配列。
競合するタイプを指定すると(たとえば、includeTypes と 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(デフォルト)の値にする必要があります。この制限に違反すると、エラーが返されます。
- (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
です。