概要
付近の場所を取得するために GMSPlacesClient で使用するリクエスト オブジェクト。
パブリック メンバーの関数 | |
| (instancetype) | - initWithLocationRestriction:placeProperties: |
場所の制限を指定して GMSPlaceSearchNearbyRequest をインスタンス化し、返されるプロパティを配置します。 | |
プロパティ | |
| idGMSPlaceLocationRestriction > | locationRestriction |
| デフォルトの init を使用できない。 | |
| NSArray<GMSPlaceProperty >* | placeProperties |
プレイス結果に含める必要がある GMSPlaceProperty の配列。 | |
| NSArray<NSString * >* | includedTypes |
| 検索に含める場所タイプの配列。 | |
| NSArray<NSString * >* | excludedTypes |
| 検索から除外する場所タイプの配列。 | |
| NSArray<NSString * >* | includedPrimaryTypes |
| 検索に含める主要な場所タイプの配列。 | |
| NSArray<NSString * >* | excludedPrimaryTypes |
| 検索から除外する主要な場所タイプの配列。 | |
| NSInteger | maxResultCount |
返される GMSPlace 結果の最大数。 | |
| NSString * | regionCode |
| リクエストの送信元の場所の Unicode 国/地域コード（CLDR）。 | |
| GMSPlaceSearchNearbyRankPreference | rankPreference |
リクエストから返された結果の並べ替えに使用する GMSPlaceSearchNearbyRankPreference。 | |
メンバー関数のドキュメント
| - (instancetype) initWithLocationRestriction: | （id< GMSPlaceLocationRestriction >）。 | locationRestriction | |
| placeProperties: | （NSArray< GMSPlaceProperty > *） | placeProperties | |
場所の制限を指定して GMSPlaceSearchNearbyRequest をインスタンス化し、返されるプロパティを配置します。
- パラメータ:
-
locationRestriction 検索する地域を円として指定します。中心点と半径（メートル単位）で定義します。 placeProperties プレイス結果に含める必要がある GMSPlacePropertyの配列。空にすることはできませんリストが空の場合、リクエストを送信しようとしたときにエラーが発生します。
プロパティのドキュメント
- (id<GMSPlaceLocationRestriction>) locationRestriction [read, write, copy] |
デフォルトの init を使用できない。
指定のイニシャライザを使用してください。検索する地域を円として指定します。中心点と半径（メートル単位）で定義します。半径は 0.0 ～ 50000.0 の範囲で指定してください。この制限に違反すると、INVALID_ARGUMENT エラーが発生します。locationRestriction は GMSPlaceCircularLocationOption とともに指定する必要があります。GMSPlaceRectangularLocationOption を使用すると、INVALID_REQUEST エラーが発生します。
- (NSArray<GMSPlaceProperty>*) placeProperties [read, write, copy] |
プレイス結果に含める必要がある GMSPlaceProperty の配列。
空にすることはできませんリストが空の場合、リクエストを送信しようとしたときにエラーが発生します。
- (NSArray<NSString *>*) includedTypes [read, write, copy] |
検索に含める場所タイプの配列。
最大 50 個のタイプを指定できます。リクエストに複数のタイプ制限が指定されている場合は、すべての制限を満たす場所のみが返されます。配列が空の場合は、すべてのタイプのすべての場所が返されます。サポートされているタイプの一覧については、https://developers.google.com/maps/documentation/places/web-service/place-types#table-a をご覧ください。
- (NSArray<NSString *>*) excludedTypes [read, write, copy] |
検索から除外する場所タイプの配列。
最大 50 個のタイプを指定できます。リクエストに複数のタイプ制限が指定されている場合は、すべての制限を満たす場所のみが返されます。競合する型が指定された場合（includeTypes や excludeTypes に含まれる型など）、INVALID_REQUEST エラーが返されます。サポートされているタイプの一覧については、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] |
検索から除外する主要な場所タイプの配列。
競合する型が指定された場合（includeTypes や excludeTypes に含まれる型など）、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 です。