概要
GMSPlacesClient を介して送信するテキスト検索リクエストの定義を表します。
公開メンバー関数 | |
| （instancetype） | - initWithTextQuery:placeProperties: |
テキストクエリと、返す Place プロパティを使用して GMSPlaceSearchByTextRequest をインスタンス化します。 | |
プロパティ | |
| NSString * | includedType |
| デフォルトの init は使用できません。 | |
| 返される結果の最大件数です。1 ～ 20 の値を指定できます。 | |
| int | maxResultCount |
| float | minRating |
| 結果に含める場所に対するユーザー評価の下限（平均値）。 | |
| BOOL | isOpenNow |
| 現在営業中の場所に検索結果を絞り込みます。 | |
| NSArray< GMSPlaceProperty > * | placeProperties |
プレイス結果に含める必要がある GMSPlaceProperty の配列。 | |
| NSArray< NSNumber * > * | priceLevels |
結果に含める場所をフィルタリングする GMSPlacesPriceLevel 値の配列。 | |
| GMSPlaceSearchByTextRankPreference | rankPreference |
リクエストから返された結果の並べ替えに使用される GMSPlaceSearchByTextRankPreference。 | |
| NSString * | regionCode |
| リクエストの送信元であるロケーションの Unicode 国/地域コード（CLDR）。 | |
| BOOL | isStrictTypeFiltering |
includedType の結果のみを返すかどうかを定義します。 | |
| NSString * | textQuery |
| 検索のテキストクエリ。 | |
| id< GMSPlaceLocationBias > | locationBias |
| 検索するバイアスのある地域。 | |
| id< GMSPlaceLocationRestriction > | locationRestriction |
| 検索制限地域。 | |
メンバー関数のドキュメント
| - (instancetype) initWithTextQuery: | (NSString *) | textQuery | |
| placeProperties: | (NSArray< GMSPlaceProperty > *) | placeProperties | |
テキストクエリと、返す Place プロパティを使用して GMSPlaceSearchByTextRequest をインスタンス化します。
- パラメータ:
-
textQuery 検索リクエストの文字列クエリ。 placeProperties プレイス結果に含める必要がある GMSPlacePropertyの配列。
プロパティのドキュメント
-（NSString*）includedType [read, write, copy] |
デフォルトの init は使用できません。
指定のイニシャライザを使用してください。リクエストされた場所のタイプ。
サポートされているタイプの最新リストについては、https://developers.google.com/maps/documentation/maps/documentation/places/ios-sdk/data-fields をご覧ください。
-（整数）maxResultCount [read, write, assign] |
返される結果の最大件数です。1 ～ 20 の値を指定できます。
このフィールドに指定できる範囲については、https://developers.google.com/maps/documentation/places/ios-sdk/text-search をご覧ください。
デフォルトは上限です。
-（浮動小数点数）minRating [read, write, assign] |
結果に含める場所に対するユーザー評価の下限（平均値）。
評価は 0.0 ～ 5.0 の範囲になります。
指定した評価は 0.5 単位で切り上げられます。GMSPlace 評価プロパティをご覧ください。
デフォルトは 0.0 です。
-（BOOL）isOpenNow [read, write, assign] |
現在営業中の場所に検索結果を絞り込みます。
デフォルトは true です。
- (NSArray<GMSPlaceProperty>*) placeProperties [read, assign] |
プレイス結果に含める必要がある GMSPlaceProperty の配列。
- (NSArray<NSNumber *>*) priceLevels [read, write, assign] |
結果に含める場所をフィルタリングする GMSPlacesPriceLevel 値の配列。
価格レベルの任意の組み合わせを選択できます。デフォルトはすべての価格レベルです。
- （GMSPlaceSearchByTextRankPreference）rankPreference [read, write, assign] |
リクエストから返された結果の並べ替えに使用される GMSPlaceSearchByTextRankPreference。
- (NSString*) regionCode [read, write, copy] |
リクエストの送信元であるロケーションの Unicode 国/地域コード（CLDR）。
リージョンは、返されるデータの形式や型に影響することがあります。コードが指定されていない場合は、どの国/地域に対してもバイアスは発生しません。
地域コードについては、https://unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html をご覧ください。
-（BOOL）isStrictTypeFiltering [read, write, assign] |
includedType の結果のみを返すかどうかを定義します。
デフォルト値は false です。
- (NSString*) textQuery [read, copy] |
検索のテキストクエリ。
- (id<GMSPlaceLocationBias>) locationBias [read, write, assign] |
検索するバイアスのある地域。
この地域はバイアスとして機能し、指定された地域の検索結果が優先されることを意味します。
検索リクエストを実行するときに、locationRestriction または locationBias を設定する必要があります。
locationRestriction とともに設定しても無視されます。
- (id<GMSPlaceLocationRestriction>) locationRestriction [read, write, assign] |
検索制限地域。
このロケーションは制限として機能し、指定されたロケーション外の結果は返されません。
検索リクエストを実行するときに、locationRestriction または locationBias を設定する必要があります。
locationBias では使用できません。
テキスト検索の locationRestriction は GMSPlaceRectangularLocationOption のみをサポートしています。