שירות ההשלמה האוטומטית ב-Place SDK עבור iOS מחזיר חיזויי מקומות בתגובה לשאילתות חיפוש של משתמשים. בזמן שהמשתמש מקליד, שירות ההשלמה האוטומטית מחזיר הצעות למקומות כמו עסקים, כתובות, קודי OLC ונקודות עניין.
ניתן להוסיף השלמה אוטומטית לאפליקציה בדרכים הבאות:
- כדאי להוסיף פקד להשלמה אוטומטית בממשק המשתמש כדי לחסוך זמן פיתוח ולהבטיח חוויית משתמש עקבית.
- קבלו חיזויים של מקומות באופן פרוגרמטי כדי ליצור חוויית משתמש מותאמת אישית.
הוספת פקד להשלמה אוטומטית בממשק המשתמש
הפקד של ההשלמה האוטומטית בממשק המשתמש הוא תיבת דו-שיח לחיפוש עם פונקציונליות מובנית של השלמה אוטומטית. כשמשתמש מזין מונחי חיפוש, הפקד מציג רשימה של מיקומים חזויים לבחירה. כשהמשתמש מבצע בחירה, מוחזר מופע של GMSPlace
, שהאפליקציה יכולה להשתמש בו כדי לקבל פרטים על המקום שנבחר.
ניתן להוסיף לאפליקציה את הפקד של ההשלמה האוטומטית בממשק המשתמש בדרכים הבאות:
הוספת פקד במסך מלא
תוכלו להשתמש בפקד במסך מלא כשאתם רוצים הקשר מודאלי, שבו ממשק המשתמש של ההשלמה האוטומטית מחליף באופן זמני את ממשק המשתמש של האפליקציה עד שהמשתמש יסיים את הבחירה. הפונקציונליות הזו מסופקת על ידי המחלקה GMSAutocompleteViewController
. כשהמשתמש בוחר מקום, האפליקציה מקבלת קריאה חוזרת (callback).
כדי להוסיף לאפליקציה פקד במסך מלא:
- יוצרים רכיב בממשק המשתמש באפליקציה הראשית כדי להפעיל את הפקד של ההשלמה האוטומטית בממשק המשתמש, לדוגמה רכיב מגע ב-
UIButton
. - מטמיעים את הפרוטוקול
GMSAutocompleteViewControllerDelegate
בבקרת התצוגה הראשית. - יוצרים מכונה של
GMSAutocompleteViewController
ומקצים את הבקר של תצוגת ההורה בתור הנכס להאצלה. - יוצרים
GMSPlaceField
כדי להגדיר את הסוגים של נתוני המקום שיוחזרו. - כדי להגביל את השאילתה לסוג מסוים של מקום, צריך להוסיף
GMSAutocompleteFilter
. - הצגת
GMSAutocompleteViewController
באמצעות[self presentViewController...]
. - מטפלים בבחירת המשתמש בשיטת הענקת הגישה
didAutocompleteWithPlace
. - סוגרים את הבקר בשיטות הענקת הגישה
didAutocompleteWithPlace
,didFailAutocompleteWithError
ו-wasCancelled
.
הדוגמה הבאה ממחישה דרך אפשרית אחת להפעלת GMSAutocompleteViewController
בתגובה שהמשתמש מקיש על לחצן.
Swift
import UIKit import GooglePlaces class ViewController: UIViewController { override func viewDidLoad() { makeButton() } // Present the Autocomplete view controller when the button is pressed. @objc func autocompleteClicked(_ sender: UIButton) { let autocompleteController = GMSAutocompleteViewController() autocompleteController.delegate = self // Specify the place data types to return. let fields: GMSPlaceField = GMSPlaceField(rawValue: UInt(GMSPlaceField.name.rawValue) | UInt(GMSPlaceField.placeID.rawValue))! autocompleteController.placeFields = fields // Specify a filter. let filter = GMSAutocompleteFilter() filter.types = [.address] autocompleteController.autocompleteFilter = filter // Display the autocomplete view controller. present(autocompleteController, animated: true, completion: nil) } // Add a button to the view. func makeButton() { let btnLaunchAc = UIButton(frame: CGRect(x: 5, y: 150, width: 300, height: 35)) btnLaunchAc.backgroundColor = .blue btnLaunchAc.setTitle("Launch autocomplete", for: .normal) btnLaunchAc.addTarget(self, action: #selector(autocompleteClicked), for: .touchUpInside) self.view.addSubview(btnLaunchAc) } } extension ViewController: GMSAutocompleteViewControllerDelegate { // Handle the user's selection. func viewController(_ viewController: GMSAutocompleteViewController, didAutocompleteWith place: GMSPlace) { print("Place name: \(place.name)") print("Place ID: \(place.placeID)") print("Place attributions: \(place.attributions)") dismiss(animated: true, completion: nil) } func viewController(_ viewController: GMSAutocompleteViewController, didFailAutocompleteWithError error: Error) { // TODO: handle the error. print("Error: ", error.localizedDescription) } // User canceled the operation. func wasCancelled(_ viewController: GMSAutocompleteViewController) { dismiss(animated: true, completion: nil) } // Turn the network activity indicator on and off again. func didRequestAutocompletePredictions(_ viewController: GMSAutocompleteViewController) { UIApplication.shared.isNetworkActivityIndicatorVisible = true } func didUpdateAutocompletePredictions(_ viewController: GMSAutocompleteViewController) { UIApplication.shared.isNetworkActivityIndicatorVisible = false } }
Objective-C
#import "ViewController.h" @import GooglePlaces; @interface ViewController () <GMSAutocompleteViewControllerDelegate> @end @implementation ViewController { GMSAutocompleteFilter *_filter; } - (void)viewDidLoad { [super viewDidLoad]; [self makeButton]; } // Present the autocomplete view controller when the button is pressed. - (void)autocompleteClicked { GMSAutocompleteViewController *acController = [[GMSAutocompleteViewController alloc] init]; acController.delegate = self; // Specify the place data types to return. GMSPlaceField fields = (GMSPlaceFieldName | GMSPlaceFieldPlaceID); acController.placeFields = fields; // Specify a filter. _filter = [[GMSAutocompleteFilter alloc] init]; _filter.types = @[ kGMSPlaceTypeBank ]; acController.autocompleteFilter = _filter; // Display the autocomplete view controller. [self presentViewController:acController animated:YES completion:nil]; } // Add a button to the view. - (void)makeButton{ UIButton *btnLaunchAc = [UIButton buttonWithType:UIButtonTypeCustom]; [btnLaunchAc addTarget:self action:NSSelectorFromString(@"autocompleteClicked") forControlEvents:UIControlEventTouchUpInside]; [btnLaunchAc setTitle:@"Launch autocomplete" forState:UIControlStateNormal]; btnLaunchAc.frame = CGRectMake(5.0, 150.0, 300.0, 35.0); btnLaunchAc.backgroundColor = [UIColor blueColor]; [self.view addSubview:btnLaunchAc]; } // Handle the user's selection. - (void)viewController:(GMSAutocompleteViewController *)viewController didAutocompleteWithPlace:(GMSPlace *)place { [self dismissViewControllerAnimated:YES completion:nil]; // Do something with the selected place. NSLog(@"Place name %@", place.name); NSLog(@"Place ID %@", place.placeID); NSLog(@"Place attributions %@", place.attributions.string); } - (void)viewController:(GMSAutocompleteViewController *)viewController didFailAutocompleteWithError:(NSError *)error { [self dismissViewControllerAnimated:YES completion:nil]; // TODO: handle the error. NSLog(@"Error: %@", [error description]); } // User canceled the operation. - (void)wasCancelled:(GMSAutocompleteViewController *)viewController { [self dismissViewControllerAnimated:YES completion:nil]; } // Turn the network activity indicator on and off again. - (void)didRequestAutocompletePredictions:(GMSAutocompleteViewController *)viewController { [UIApplication sharedApplication].networkActivityIndicatorVisible = YES; } - (void)didUpdateAutocompletePredictions:(GMSAutocompleteViewController *)viewController { [UIApplication sharedApplication].networkActivityIndicatorVisible = NO; } @end
הוספת בקר תוצאות
אם רוצים יותר שליטה בממשק המשתמש של קלט הטקסט, אפשר להשתמש בבקר תוצאות. בקר התוצאות משנה באופן דינמי את החשיפה של רשימת התוצאות על סמך המיקוד בקלט של ממשק המשתמש.
כדי להוסיף בקר תוצאות לאפליקציה:
- יוצרים
GMSAutocompleteResultsViewController
. - מטמיעים את הפרוטוקול
GMSAutocompleteResultsViewControllerDelegate
בבקרת התצוגה המפורטת הראשית ומקצים את בקר התצוגה הראשי כנכס שמואצל. - יוצרים אובייקט
UISearchController
ומעבירים את הערךGMSAutocompleteResultsViewController
כארגומנט של בקר התוצאות. - מגדירים את
GMSAutocompleteResultsViewController
כנכסsearchResultsUpdater
שלUISearchController
. - צריך להוסיף את
searchBar
שלUISearchController
לממשק המשתמש של האפליקציה. - מטפלים בבחירת המשתמש בשיטת הענקת הגישה
didAutocompleteWithPlace
.
יש כמה דרכים להציב את סרגל החיפוש של UISearchController
בממשק המשתמש של האפליקציה:
הוספת סרגל חיפוש לסרגל הניווט
דוגמת הקוד הבאה ממחישה הוספה של בקר תוצאות, הוספת searchBar
לסרגל הניווט וטיפול בבחירת המשתמש:
Swift
class ViewController: UIViewController { var resultsViewController: GMSAutocompleteResultsViewController? var searchController: UISearchController? var resultView: UITextView? override func viewDidLoad() { super.viewDidLoad() resultsViewController = GMSAutocompleteResultsViewController() resultsViewController?.delegate = self searchController = UISearchController(searchResultsController: resultsViewController) searchController?.searchResultsUpdater = resultsViewController // Put the search bar in the navigation bar. searchController?.searchBar.sizeToFit() navigationItem.titleView = searchController?.searchBar // When UISearchController presents the results view, present it in // this view controller, not one further up the chain. definesPresentationContext = true // Prevent the navigation bar from being hidden when searching. searchController?.hidesNavigationBarDuringPresentation = false } } // Handle the user's selection. extension ViewController: GMSAutocompleteResultsViewControllerDelegate { func resultsController(_ resultsController: GMSAutocompleteResultsViewController, didAutocompleteWith place: GMSPlace) { searchController?.isActive = false // Do something with the selected place. print("Place name: \(place.name)") print("Place address: \(place.formattedAddress)") print("Place attributions: \(place.attributions)") } func resultsController(_ resultsController: GMSAutocompleteResultsViewController, didFailAutocompleteWithError error: Error){ // TODO: handle the error. print("Error: ", error.localizedDescription) } // Turn the network activity indicator on and off again. func didRequestAutocompletePredictions(_ viewController: GMSAutocompleteViewController) { UIApplication.shared.isNetworkActivityIndicatorVisible = true } func didUpdateAutocompletePredictions(_ viewController: GMSAutocompleteViewController) { UIApplication.shared.isNetworkActivityIndicatorVisible = false } }
Objective-C
- (void)viewDidLoad { _resultsViewController = [[GMSAutocompleteResultsViewController alloc] init]; _resultsViewController.delegate = self; _searchController = [[UISearchController alloc] initWithSearchResultsController:_resultsViewController]; _searchController.searchResultsUpdater = _resultsViewController; // Put the search bar in the navigation bar. [_searchController.searchBar sizeToFit]; self.navigationItem.titleView = _searchController.searchBar; // When UISearchController presents the results view, present it in // this view controller, not one further up the chain. self.definesPresentationContext = YES; // Prevent the navigation bar from being hidden when searching. _searchController.hidesNavigationBarDuringPresentation = NO; } // Handle the user's selection. - (void)resultsController:(GMSAutocompleteResultsViewController *)resultsController didAutocompleteWithPlace:(GMSPlace *)place { _searchController.active = NO; // Do something with the selected place. NSLog(@"Place name %@", place.name); NSLog(@"Place address %@", place.formattedAddress); NSLog(@"Place attributions %@", place.attributions.string); } - (void)resultsController:(GMSAutocompleteResultsViewController *)resultsController didFailAutocompleteWithError:(NSError *)error { [self dismissViewControllerAnimated:YES completion:nil]; // TODO: handle the error. NSLog(@"Error: %@", [error description]); } // Turn the network activity indicator on and off again. - (void)didRequestAutocompletePredictionsForResultsController: (GMSAutocompleteResultsViewController *)resultsController { [UIApplication sharedApplication].networkActivityIndicatorVisible = YES; } - (void)didUpdateAutocompletePredictionsForResultsController: (GMSAutocompleteResultsViewController *)resultsController { [UIApplication sharedApplication].networkActivityIndicatorVisible = NO; }
הוספת סרגל חיפוש לראש התצוגה
דוגמת הקוד הבאה מציגה את ההוספה של searchBar
לחלק העליון של תצוגה מפורטת.
Swift
import UIKit import GooglePlaces class ViewController: UIViewController { var resultsViewController: GMSAutocompleteResultsViewController? var searchController: UISearchController? var resultView: UITextView? override func viewDidLoad() { super.viewDidLoad() resultsViewController = GMSAutocompleteResultsViewController() resultsViewController?.delegate = self searchController = UISearchController(searchResultsController: resultsViewController) searchController?.searchResultsUpdater = resultsViewController let subView = UIView(frame: CGRect(x: 0, y: 65.0, width: 350.0, height: 45.0)) subView.addSubview((searchController?.searchBar)!) view.addSubview(subView) searchController?.searchBar.sizeToFit() searchController?.hidesNavigationBarDuringPresentation = false // When UISearchController presents the results view, present it in // this view controller, not one further up the chain. definesPresentationContext = true } } // Handle the user's selection. extension ViewController: GMSAutocompleteResultsViewControllerDelegate { func resultsController(_ resultsController: GMSAutocompleteResultsViewController, didAutocompleteWith place: GMSPlace) { searchController?.isActive = false // Do something with the selected place. print("Place name: \(place.name)") print("Place address: \(place.formattedAddress)") print("Place attributions: \(place.attributions)") } func resultsController(_ resultsController: GMSAutocompleteResultsViewController, didFailAutocompleteWithError error: Error){ // TODO: handle the error. print("Error: ", error.localizedDescription) } // Turn the network activity indicator on and off again. func didRequestAutocompletePredictions(forResultsController resultsController: GMSAutocompleteResultsViewController) { UIApplication.shared.isNetworkActivityIndicatorVisible = true } func didUpdateAutocompletePredictions(forResultsController resultsController: GMSAutocompleteResultsViewController) { UIApplication.shared.isNetworkActivityIndicatorVisible = false } }
Objective-C
- (void)viewDidLoad { [super viewDidLoad]; _resultsViewController = [[GMSAutocompleteResultsViewController alloc] init]; _resultsViewController.delegate = self; _searchController = [[UISearchController alloc] initWithSearchResultsController:_resultsViewController]; _searchController.searchResultsUpdater = _resultsViewController; UIView *subView = [[UIView alloc] initWithFrame:CGRectMake(0, 65.0, 250, 50)]; [subView addSubview:_searchController.searchBar]; [_searchController.searchBar sizeToFit]; [self.view addSubview:subView]; // When UISearchController presents the results view, present it in // this view controller, not one further up the chain. self.definesPresentationContext = YES; } // Handle the user's selection. - (void)resultsController:(GMSAutocompleteResultsViewController *)resultsController didAutocompleteWithPlace:(GMSPlace *)place { [self dismissViewControllerAnimated:YES completion:nil]; // Do something with the selected place. NSLog(@"Place name %@", place.name); NSLog(@"Place address %@", place.formattedAddress); NSLog(@"Place attributions %@", place.attributions.string); } - (void)resultsController:(GMSAutocompleteResultsViewController *)resultsController didFailAutocompleteWithError:(NSError *)error { [self dismissViewControllerAnimated:YES completion:nil]; // TODO: handle the error. NSLog(@"Error: %@", [error description]); } // Turn the network activity indicator on and off again. - (void)didRequestAutocompletePredictionsForResultsController: (GMSAutocompleteResultsViewController *)resultsController { [UIApplication sharedApplication].networkActivityIndicatorVisible = YES; } - (void)didUpdateAutocompletePredictionsForResultsController: (GMSAutocompleteResultsViewController *)resultsController { [UIApplication sharedApplication].networkActivityIndicatorVisible = NO; }
כברירת מחדל, סרגל הניווט מוסתר על ידי UISearchController
במהלך שיתוף המסך (אפשר להשבית את האפשרות הזו). במקרים שבהם סרגל הניווט גלוי אטום, מערכת UISearchController
לא תגדיר את המיקום בצורה נכונה.
אפשר להשתמש בקוד הבא כפתרון עקיף:
Swift
navigationController?.navigationBar.translucent = false searchController?.hidesNavigationBarDuringPresentation = false // This makes the view area include the nav bar even though it is opaque. // Adjust the view placement down. self.extendedLayoutIncludesOpaqueBars = true self.edgesForExtendedLayout = .top
Objective-C
self.navigationController.navigationBar.translucent = NO; _searchController.hidesNavigationBarDuringPresentation = NO; // This makes the view area include the nav bar even though it is opaque. // Adjust the view placement down. self.extendedLayoutIncludesOpaqueBars = YES; self.edgesForExtendedLayout = UIRectEdgeTop;
הוספת סרגל חיפוש באמצעות תוצאות קופצות
דוגמת הקוד הבאה מציגה הצבת סרגל חיפוש בצד שמאל של סרגל הניווט והצגת תוצאות בחלון קופץ.
Swift
import UIKit import GooglePlaces class ViewController: UIViewController { var resultsViewController: GMSAutocompleteResultsViewController? var searchController: UISearchController? var resultView: UITextView? override func viewDidLoad() { super.viewDidLoad() resultsViewController = GMSAutocompleteResultsViewController() resultsViewController?.delegate = self searchController = UISearchController(searchResultsController: resultsViewController) searchController?.searchResultsUpdater = resultsViewController // Add the search bar to the right of the nav bar, // use a popover to display the results. // Set an explicit size as we don't want to use the entire nav bar. searchController?.searchBar.frame = (CGRect(x: 0, y: 0, width: 250.0, height: 44.0)) navigationItem.rightBarButtonItem = UIBarButtonItem(customView: (searchController?.searchBar)!) // When UISearchController presents the results view, present it in // this view controller, not one further up the chain. definesPresentationContext = true // Keep the navigation bar visible. searchController?.hidesNavigationBarDuringPresentation = false searchController?.modalPresentationStyle = .popover } } // Handle the user's selection. extension ViewController: GMSAutocompleteResultsViewControllerDelegate { func resultsController(_ resultsController: GMSAutocompleteResultsViewController, didAutocompleteWith place: GMSPlace) { searchController?.isActive = false // Do something with the selected place. print("Place name: \(place.name)") print("Place address: \(place.formattedAddress)") print("Place attributions: \(place.attributions)") } func resultsController(_ resultsController: GMSAutocompleteResultsViewController, didFailAutocompleteWithError error: Error){ // TODO: handle the error. print("Error: ", error.localizedDescription) } // Turn the network activity indicator on and off again. func didRequestAutocompletePredictions(forResultsController resultsController: GMSAutocompleteResultsViewController) { UIApplication.shared.isNetworkActivityIndicatorVisible = true } func didUpdateAutocompletePredictions(forResultsController resultsController: GMSAutocompleteResultsViewController) { UIApplication.shared.isNetworkActivityIndicatorVisible = false } }
Objective-C
- (void)viewDidLoad { [super viewDidLoad]; _resultsViewController = [[GMSAutocompleteResultsViewController alloc] init]; _resultsViewController.delegate = self; _searchController = [[UISearchController alloc] initWithSearchResultsController:_resultsViewController]; _searchController.searchResultsUpdater = _resultsViewController; // Add the search bar to the right of the nav bar, // use a popover to display the results. // Set an explicit size as we don't want to use the entire nav bar. _searchController.searchBar.frame = CGRectMake(0, 0, 250.0f, 44.0f); self.navigationItem.rightBarButtonItem = [[UIBarButtonItem alloc] initWithCustomView:_searchController.searchBar]; // When UISearchController presents the results view, present it in // this view controller, not one further up the chain. self.definesPresentationContext = YES; // Keep the navigation bar visible. _searchController.hidesNavigationBarDuringPresentation = NO; _searchController.modalPresentationStyle = UIModalPresentationPopover; } // Handle the user's selection. - (void)resultsController:(GMSAutocompleteResultsViewController *)resultsController didAutocompleteWithPlace:(GMSPlace *)place { [self dismissViewControllerAnimated:YES completion:nil]; NSLog(@"Place name %@", place.name); NSLog(@"Place address %@", place.formattedAddress); NSLog(@"Place attributions %@", place.attributions.string); } - (void)resultsController:(GMSAutocompleteResultsViewController *)resultsController didFailAutocompleteWithError:(NSError *)error { [self dismissViewControllerAnimated:YES completion:nil]; // TODO: handle the error. NSLog(@"Error: %@", [error description]); } // Turn the network activity indicator on and off again. - (void)didRequestAutocompletePredictionsForResultsController: (GMSAutocompleteResultsViewController *)resultsController { [UIApplication sharedApplication].networkActivityIndicatorVisible = YES; } - (void)didUpdateAutocompletePredictionsForResultsController: (GMSAutocompleteResultsViewController *)resultsController { [UIApplication sharedApplication].networkActivityIndicatorVisible = NO; }
שימוש במקור נתונים של טבלה
אם לאפליקציה שלכם יש ממשק משתמש מותאם אישית של טקסט לחיפוש, תוכלו להשתמש במחלקה GMSAutocompleteTableDataSource
כדי לשנות את תצוגת הטבלה שמציגה את התוצאות בבקרת התצוגה.
כדי להשתמש ב-GMSAutocompleteTableDataSource
כמקור הנתונים וכמאציל של UITableView
בבקר התצוגה המפורטת:
- מטמיעים את הפרוטוקולים
GMSAutocompleteTableDataSourceDelegate
ו-UISearchBarDelegate
בבקרת התצוגה. - יוצרים מכונה של
GMSAutocompleteTableDataSource
ומקצים את בקר התצוגה בתור הנכס להאצלת הגישה. - מגדירים את
GMSAutocompleteTableDataSource
כמקור הנתונים וכמאפייני ההאצלה של המכונהUITableView
בבקר של התצוגה המפורטת. - ב-handler של קלט הטקסט של החיפוש, מפעילים את
sourceTextHasChanged
ב-GMSAutocompleteTableDataSource
. - טיפול בבחירת המשתמש בשיטת הענקת הגישה של
didAutocompleteWithPlace
. - סוגרים את הבקר בשיטות הענקת הגישה
didAutocompleteWithPlace
,didFailAutocompleteWithError
ו-wasCancelled
.
דוגמת הקוד הבאה ממחישה את השימוש במחלקה GMSAutocompleteTableDataSource
כדי להפעיל את תצוגת הטבלה של UIViewController
כשמוסיפים את UISearchBar
בנפרד.
Swift
// Copyright 2020 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. import GooglePlaces import UIKit class PlaceAutocompleteViewController: UIViewController { private var tableView: UITableView! private var tableDataSource: GMSAutocompleteTableDataSource! override func viewDidLoad() { super.viewDidLoad() let searchBar = UISearchBar(frame: CGRect(x: 0, y: 20, width: self.view.frame.size.width, height: 44.0)) searchBar.delegate = self view.addSubview(searchBar) tableDataSource = GMSAutocompleteTableDataSource() tableDataSource.delegate = self tableView = UITableView(frame: CGRect(x: 0, y: 64, width: self.view.frame.size.width, height: self.view.frame.size.height - 44)) tableView.delegate = tableDataSource tableView.dataSource = tableDataSource view.addSubview(tableView) } } extension PlaceAutocompleteViewController: UISearchBarDelegate { func searchBar(_ searchBar: UISearchBar, textDidChange searchText: String) { // Update the GMSAutocompleteTableDataSource with the search text. tableDataSource.sourceTextHasChanged(searchText) } } extension PlaceAutocompleteViewController: GMSAutocompleteTableDataSourceDelegate { func didUpdateAutocompletePredictions(for tableDataSource: GMSAutocompleteTableDataSource) { // Turn the network activity indicator off. UIApplication.shared.isNetworkActivityIndicatorVisible = false // Reload table data. tableView.reloadData() } func didRequestAutocompletePredictions(for tableDataSource: GMSAutocompleteTableDataSource) { // Turn the network activity indicator on. UIApplication.shared.isNetworkActivityIndicatorVisible = true // Reload table data. tableView.reloadData() } func tableDataSource(_ tableDataSource: GMSAutocompleteTableDataSource, didAutocompleteWith place: GMSPlace) { // Do something with the selected place. print("Place name: \(place.name)") print("Place address: \(place.formattedAddress)") print("Place attributions: \(place.attributions)") } func tableDataSource(_ tableDataSource: GMSAutocompleteTableDataSource, didFailAutocompleteWithError error: Error) { // Handle the error. print("Error: \(error.localizedDescription)") } func tableDataSource(_ tableDataSource: GMSAutocompleteTableDataSource, didSelect prediction: GMSAutocompletePrediction) -> Bool { return true } }
Objective-C
// Copyright 2020 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. #import "PlaceAutocompleteViewController.h" @import GooglePlaces; @import UIKit; @interface PlaceAutocompleteViewController () <GMSAutocompleteTableDataSourceDelegate, UISearchBarDelegate> @end @implementation PlaceAutocompleteViewController { UITableView *tableView; GMSAutocompleteTableDataSource *tableDataSource; } - (void)viewDidLoad { [super viewDidLoad]; UISearchBar *searchBar = [[UISearchBar alloc] initWithFrame:CGRectMake(0, 20, self.view.frame.size.width, 44)]; searchBar.delegate = self; [self.view addSubview:searchBar]; tableDataSource = [[GMSAutocompleteTableDataSource alloc] init]; tableDataSource.delegate = self; tableView = [[UITableView alloc] initWithFrame:CGRectMake(0, 64, self.view.frame.size.width, self.view.frame.size.height - 44)]; tableView.delegate = tableDataSource; tableView.dataSource = tableDataSource; [self.view addSubview:tableView]; } #pragma mark - GMSAutocompleteTableDataSourceDelegate - (void)didUpdateAutocompletePredictionsForTableDataSource:(GMSAutocompleteTableDataSource *)tableDataSource { // Turn the network activity indicator off. UIApplication.sharedApplication.networkActivityIndicatorVisible = NO; // Reload table data. [tableView reloadData]; } - (void)didRequestAutocompletePredictionsForTableDataSource:(GMSAutocompleteTableDataSource *)tableDataSource { // Turn the network activity indicator on. UIApplication.sharedApplication.networkActivityIndicatorVisible = YES; // Reload table data. [tableView reloadData]; } - (void)tableDataSource:(GMSAutocompleteTableDataSource *)tableDataSource didAutocompleteWithPlace:(GMSPlace *)place { // Do something with the selected place. NSLog(@"Place name: %@", place.name); NSLog(@"Place address: %@", place.formattedAddress); NSLog(@"Place attributions: %@", place.attributions); } - (void)tableDataSource:(GMSAutocompleteTableDataSource *)tableDataSource didFailAutocompleteWithError:(NSError *)error { // Handle the error NSLog(@"Error %@", error.description); } - (BOOL)tableDataSource:(GMSAutocompleteTableDataSource *)tableDataSource didSelectPrediction:(GMSAutocompletePrediction *)prediction { return YES; } #pragma mark - UISearchBarDelegate - (void)searchBar:(UISearchBar *)searchBar textDidChange:(NSString *)searchText { // Update the GMSAutocompleteTableDataSource with the search text. [tableDataSource sourceTextHasChanged:searchText]; } @end
התאמה אישית של צבעי הטקסט והרקע
אפשר להגדיר את הצבעים של כל הטקסט והרקעים בבקרה של ההשלמה האוטומטית של ממשק המשתמש, כדי להתאים טוב יותר את הווידג'ט למראה החזותי של האפליקציה. יש שתי דרכים להגדיר את הצבעים של הפקדים בממשק המשתמש:
- שימוש בפרוטוקול iOSמראה המקורי כדי לעצב באופן גלובלי את בקרות הממשק למשתמש במידת האפשר. ההגדרות האלה חלות על הרבה מרכיבי הבקרה בממשק המשתמש, אבל לא על כולם.
- על ידי שימוש בשיטות ה-SDK במחלקות של הווידג'טים כדי להגדיר מאפיינים שלא נתמכים בפרוטוקול UIמראה.
בדרך כלל, האפליקציה משתמשת בשילוב מסוים של פרוטוקול UIמראה ושיטות ה-SDK. בתרשים הבא אפשר לראות את הרכיבים שאפשר לסגנן:
בטבלה הבאה מפורטים כל רכיבי ממשק המשתמש, ומוסבר איך צריך לעצב כל אחד מהם (פרוטוקול UIמראה או שיטת SDK).
רכיב בממשק המשתמש | שיטה | מדריכים וסטייל |
---|---|---|
גוון סרגל הניווט (רקע) | פרוטוקול UIמראה | התקשרות אל setBarTintColor בשרת proxy של UINavigationBar . |
צבע הגוון של סרגל הניווט (סמן טקסט בסרגל החיפוש ולחצן ביטול) | פרוטוקול UIמראה | התקשרות אל setTintColor בשרת proxy של UINavigationBar . |
צבע הטקסט בסרגל החיפוש | פרוטוקול UIמראה | הגדרת NSForegroundColorAttributeName בsearchBarTextAttributes . |
צבע הגוון של סרגל החיפוש | לא רלוונטי | סרגל החיפוש שקוף ומוצג כגרסה מוצלת של סרגל הניווט. |
צבע הטקסט של ה-placeholder בסרגל החיפוש (טקסט ברירת המחדל לחיפוש) | פרוטוקול UIמראה | הגדרת NSForegroundColorAttributeName בplaceholderAttributes . |
טקסט ראשי (רלוונטי גם לשגיאות ולטקסטים של הודעות) | שיטת ה-SDK | התקשרו אל primaryTextColor . |
הדגשת טקסט ראשי | שיטת ה-SDK | התקשרו אל primaryTextHighlightColor . |
טקסט משני | שיטת ה-SDK | התקשרו אל secondaryTextColor . |
השגיאה והטקסט של ההודעה | שיטת ה-SDK | התקשרו אל primaryTextColor . |
רקע של תא בטבלה | שיטת ה-SDK | התקשרו אל tableCellBackgroundColor . |
הצבע של מפריד תא בטבלה | שיטת ה-SDK | התקשרו אל tableCellSeparatorColor . |
הלחצן 'ניסיון חוזר' | שיטת ה-SDK | התקשרו אל tintColor . |
אינדיקטור של פעילות (סימן גרפי להתקדמות) | פרוטוקול UIמראה | התקשרות אל setColor בשרת proxy של UIActivityIndicatorView . |
הלוגו של "Powered by Google", תמונה של ענן עצוב | לא רלוונטי | גרסה לבנה או אפורה נבחרת באופן אוטומטי על סמך הניגודיות של הרקע. |
סמלי זכוכית מגדלת וטקסט ברור בשדה הטקסט של סרגל החיפוש | לא רלוונטי | כדי לעצב, מחליפים את תמונות ברירת המחדל בתמונות בצבע הרצוי. |
שימוש בפרוטוקול UIמראה
אפשר להשתמש ב-UIמראה Protocol כדי לקבל את שרת ה-proxy למראה לאלמנט נתון של ממשק המשתמש, ולהשתמש בו כדי להגדיר את הצבע של הרכיב בממשק המשתמש. כשמבצעים שינוי, כל המופעים של רכיב נתון בממשק המשתמש מושפעים. לדוגמה, בדוגמה הבאה משתנה באופן גלובלי צבע הטקסט של מחלקות UITextField
לירוק כשהם מכילים ב-UISearchBar
:
[[UITextField appearanceWhenContainedIn:[UISearchBar class], nil] setDefaultTextAttributes:@{NSForegroundColorAttributeName:[UIColor greenColor]}];
למידע נוסף על הגדרת ערכי צבעים, אפשר לעיין בחומר העזר בנושא סיווג של UIColor Class.
קטעי הקוד הבאים מציגים את כל פקודות ה-proxy שבהן צריך להשתמש כדי לעצב את כל הפקודות של השלמה אוטומטית בממשק המשתמש במסך מלא. מוסיפים את הקוד הזה ל-method didFinishLaunchingWithOptions
ב-Appdelegate.m:
// Define some colors. UIColor *darkGray = [UIColor darkGrayColor]; UIColor *lightGray = [UIColor lightGrayColor]; // Navigation bar background. [[UINavigationBar appearance] setBarTintColor:darkGray]; [[UINavigationBar appearance] setTintColor:lightGray]; // Color of typed text in the search bar. NSDictionary *searchBarTextAttributes = @{ NSForegroundColorAttributeName: lightGray, NSFontAttributeName : [UIFont systemFontOfSize:[UIFont systemFontSize]] }; [UITextField appearanceWhenContainedInInstancesOfClasses:@[[UISearchBar class]]] .defaultTextAttributes = searchBarTextAttributes; // Color of the placeholder text in the search bar prior to text entry. NSDictionary *placeholderAttributes = @{ NSForegroundColorAttributeName: lightGray, NSFontAttributeName : [UIFont systemFontOfSize:[UIFont systemFontSize]] }; // Color of the default search text. // NOTE: In a production scenario, "Search" would be a localized string. NSAttributedString *attributedPlaceholder = [[NSAttributedString alloc] initWithString:@"Search" attributes:placeholderAttributes]; [UITextField appearanceWhenContainedInInstancesOfClasses:@[[UISearchBar class]]] .attributedPlaceholder = attributedPlaceholder; // Color of the in-progress spinner. [[UIActivityIndicatorView appearance] setColor:lightGray]; // To style the two image icons in the search bar (the magnifying glass // icon and the 'clear text' icon), replace them with different images. [[UISearchBar appearance] setImage:[UIImage imageNamed:@"custom_clear_x_high"] forSearchBarIcon:UISearchBarIconClear state:UIControlStateHighlighted]; [[UISearchBar appearance] setImage:[UIImage imageNamed:@"custom_clear_x"] forSearchBarIcon:UISearchBarIconClear state:UIControlStateNormal]; [[UISearchBar appearance] setImage:[UIImage imageNamed:@"custom_search"] forSearchBarIcon:UISearchBarIconSearch state:UIControlStateNormal]; // Color of selected table cells. UIView *selectedBackgroundView = [[UIView alloc] init]; selectedBackgroundView.backgroundColor = [UIColor lightGrayColor]; [UITableViewCell appearanceWhenContainedIn:[GMSAutocompleteViewController class], nil] .selectedBackgroundView = selectedBackgroundView;
הגדרת מאפייני סגנון פקד של ממשק משתמש
לקבוצת משנה של רכיבי שליטה בממשק המשתמש יש מאפיינים שלא מושפעים מהפרוטוקול UIמראה, ולכן צריך להגדיר אותם ישירות. דוגמת הקוד הבאה מציגה איך מגדירים צבעים של רקע וחזית, ומחילים אותם על מכונת פקד של ממשק משתמש שנקראת acController
. מוסיפים את הקוד הזה ל-method onLaunchClicked
ב-ViewController.m:
UIColor *darkGray = [UIColor darkGrayColor]; UIColor *lightGray = [UIColor lightGrayColor]; acController.secondaryTextColor = [UIColor colorWithWhite:1.0f alpha:0.5f]; acController.primaryTextColor = lightGray; acController.primaryTextHighlightColor = [UIColor grayColor]; acController.tableCellBackgroundColor = darkGray; acController.tableCellSeparatorColor = lightGray; acController.tintColor = lightGray;
קבלת חיזויים של מקומות באופן פרוגרמטי
אפשר ליצור ממשק משתמש של חיפוש מותאם אישית כחלופה לממשק המשתמש שמסופק על ידי הווידג'ט של ההשלמה האוטומטית. כדי לעשות זאת, האפליקציה צריכה לקבל חיזויים של מקומות באופן פרוגרמטי. האפליקציה שלכם יכולה לקבל רשימה של הצעות לשמות ו/או כתובות של מקומות באחת מהדרכים הבאות:
מתבצעת התקשרות אל GMSPlacesClient findAutocompletePredictionsFromQuery:
על מנת לקבל רשימה של שמות ו/או כתובות חזויים של מקומות, קודם צריך להפעיל את GMSPlacesClient ואז לקרוא לשיטה GMSPlacesClient findAutocompletePredictionsFromQuery:
עם הפרמטרים הבאים:
- מחרוזת
autocompleteQuery
שמכילה את הטקסט שהמשתמש הקליד. GMSAutocompleteSessionToken
, שמשמש לזיהוי של כל סשן בנפרד. האפליקציה צריכה להעביר את אותו האסימון לכל קריאה של בקשה להשלמה אוטומטית, ולאחר מכן להעביר בקריאה הבאה אלfetchPlacefromPlaceID:
את האסימון, ביחד עם מזהה מקום, כדי לאחזר את פרטי המקום של המקום שנבחר.GMSAutocompleteFilter
אל:- הטייה או הגבלת התוצאות לאזור מסוים.
- להגביל את התוצאות לסוג מסוים של מקום.
- אובייקט
GMSPlaceLocationBias
/Restriction שמטה את התוצאות לאזור ספציפי שמצוין לפי גבולות של קווי אורך ורוחב.
- שיטת קריאה חוזרת לטיפול בחיזויים שהוחזרו.
בדוגמאות הקוד הבאות מוצגת קריאה אל findAutocompletePredictionsFromQuery:
.
Swift
/** * Create a new session token. Be sure to use the same token for calling * findAutocompletePredictions, as well as the subsequent place details request. * This ensures that the user's query and selection are billed as a single session. */ let token = GMSAutocompleteSessionToken.init() // Create a type filter. let filter = GMSAutocompleteFilter() filter.types = [.bank] filter.locationBias = GMSPlaceRectangularLocationOption( northEastBounds, southWestBounds); placesClient?.findAutocompletePredictions(fromQuery: "cheesebu", filter: filter, sessionToken: token, callback: { (results, error) in if let error = error { print("Autocomplete error: \(error)") return } if let results = results { for result in results { print("Result \(result.attributedFullText) with placeID \(result.placeID)") } } })
Objective-C
/** * Create a new session token. Be sure to use the same token for calling * findAutocompletePredictionsFromQuery:, as well as the subsequent place details request. * This ensures that the user's query and selection are billed as a single session. */ GMSAutocompleteSessionToken *token = [[GMSAutocompleteSessionToken alloc] init]; // Create a type filter. GMSAutocompleteFilter *_filter = [[GMSAutocompleteFilter alloc] init]; _filter.types = @[ kGMSPlaceTypeBank ]; [_placesClient findAutocompletePredictionsFromQuery:@"cheesebu" filter:_filter sessionToken:token callback:^(NSArray<GMSAutocompletePrediction *> * _Nullable results, NSError * _Nullable error) { if (error != nil) { NSLog(@"An error occurred %@", [error localizedDescription]); return; } if (results != nil) { for (GMSAutocompletePrediction *result in results) { NSLog(@"Result %@ with PlaceID %@", result.attributedFullText, result.placeID); } } }];
ה-API מפעיל את שיטת הקריאה החוזרת שצוינה ומעביר מערך של אובייקטים מסוג GMSAutocompletePrediction
.
כל אובייקט GMSAutocompletePrediction
מכיל את המידע הבא:
attributedFullText
– הטקסט המלא של החיזוי, בצורתNSAttributedString
. לדוגמה, 'בית האופרה של סידני, סידני, ניו סאות' וויילס, אוסטרליה'. לכל טווח טקסט שתואם לקלט של המשתמש יש מאפייןkGMSAutocompleteMatchAttribute
. אפשר להשתמש במאפיין הזה כדי להדגיש את הטקסט התואם בשאילתה של המשתמש, לדוגמה, כפי שמוצג בהמשך.placeID
– מזהה המקום של המקום החזוי. מזהה מקום הוא מזהה טקסט שמזהה מקום באופן ייחודי. בסקירה הכללית על מזהי מקומות תוכלו לקרוא מידע נוסף על מזהי מקומות.distanceMeters
– מרחק הקו הישר מהיעדorigin
שצוין. אם המאפייןorigin
לא מוגדר, לא יוחזר ערך מרחק.
דוגמת הקוד הבאה ממחישה איך להדגיש בטקסט מודגש את חלקי התוצאה שתואמים לטקסט בשאילתת המשתמש, באמצעות enumerateAttribute
:
Swift
let regularFont = UIFont.systemFont(ofSize: UIFont.labelFontSize) let boldFont = UIFont.boldSystemFont(ofSize: UIFont.labelFontSize) let bolded = prediction.attributedFullText.mutableCopy() as! NSMutableAttributedString bolded.enumerateAttribute(kGMSAutocompleteMatchAttribute, in: NSMakeRange(0, bolded.length), options: []) { (value, range: NSRange, stop: UnsafeMutablePointer<ObjCBool>) -> Void in let font = (value == nil) ? regularFont : boldFont bolded.addAttribute(NSFontAttributeName, value: font, range: range) } label.attributedText = bolded
Objective-C
UIFont *regularFont = [UIFont systemFontOfSize:[UIFont labelFontSize]]; UIFont *boldFont = [UIFont boldSystemFontOfSize:[UIFont labelFontSize]]; NSMutableAttributedString *bolded = [prediction.attributedFullText mutableCopy]; [bolded enumerateAttribute:kGMSAutocompleteMatchAttribute inRange:NSMakeRange(0, bolded.length) options:0 usingBlock:^(id value, NSRange range, BOOL *stop) { UIFont *font = (value == nil) ? regularFont : boldFont; [bolded addAttribute:NSFontAttributeName value:font range:range]; }]; label.attributedText = bolded;
שימוש במאחזר
אם אתם רוצים ליצור שליטה משלכם בהשלמה האוטומטית, תוכלו להשתמש ב-GMSAutocompleteFetcher
,
שממיר את השיטה autocompleteQuery
ב-GMSPlacesClient
.
המאחזר מווסת בקשות, ומחזיר רק את התוצאות של טקסט החיפוש האחרון שהוזן. הוא לא מספק רכיבים בממשק המשתמש.
כדי להטמיע את GMSAutocompleteFetcher
, צריך לבצע את השלבים הבאים:
- מטמיעים את הפרוטוקול
GMSAutocompleteFetcherDelegate
. - יוצרים אובייקט
GMSAutocompleteFetcher
. - קוראים לפונקציה
sourceTextHasChanged
במאחזר בזמן שהמשתמש מקליד. - טיפול בחיזויים ובשגיאות באמצעות שיטות הפרוטוקול
didAutcompleteWithPredictions
ו-didFailAutocompleteWithError
.
דוגמת הקוד הבאה ממחישה איך להשתמש במאחזר כדי לקבל קלט של משתמשים ולהציג התאמות מקומות בתצוגת טקסט. הפונקציונליות של בחירת מקום
הושמטה. FetcherSampleViewController
נגזר מ-UIViewController
ב-FetcherSampleViewController.h.
Swift
import UIKit import GooglePlaces class ViewController: UIViewController { var textField: UITextField? var resultText: UITextView? var fetcher: GMSAutocompleteFetcher? override func viewDidLoad() { super.viewDidLoad() view.backgroundColor = .white edgesForExtendedLayout = [] // Set bounds to inner-west Sydney Australia. let neBoundsCorner = CLLocationCoordinate2D(latitude: -33.843366, longitude: 151.134002) let swBoundsCorner = CLLocationCoordinate2D(latitude: -33.875725, longitude: 151.200349) // Set up the autocomplete filter. let filter = GMSAutocompleteFilter() filter.locationRestriction = GMSPlaceRectangularLocationOption(neBoundsCorner, swBoundsCorner) // Create a new session token. let token: GMSAutocompleteSessionToken = GMSAutocompleteSessionToken.init() // Create the fetcher. fetcher = GMSAutocompleteFetcher(bounds: nil, filter: filter) fetcher?.delegate = self fetcher?.provide(token) textField = UITextField(frame: CGRect(x: 5.0, y: 10.0, width: view.bounds.size.width - 5.0, height: 64.0)) textField?.autoresizingMask = .flexibleWidth textField?.addTarget(self, action: #selector(textFieldDidChange(textField:)), for: .editingChanged) let placeholder = NSAttributedString(string: "Type a query...") textField?.attributedPlaceholder = placeholder resultText = UITextView(frame: CGRect(x: 0, y: 65.0, width: view.bounds.size.width, height: view.bounds.size.height - 65.0)) resultText?.backgroundColor = UIColor(white: 0.95, alpha: 1.0) resultText?.text = "No Results" resultText?.isEditable = false self.view.addSubview(textField!) self.view.addSubview(resultText!) } @objc func textFieldDidChange(textField: UITextField) { fetcher?.sourceTextHasChanged(textField.text!) } } extension ViewController: GMSAutocompleteFetcherDelegate { func didAutocomplete(with predictions: [GMSAutocompletePrediction]) { let resultsStr = NSMutableString() for prediction in predictions { resultsStr.appendFormat("\n Primary text: %@\n", prediction.attributedPrimaryText) resultsStr.appendFormat("Place ID: %@\n", prediction.placeID) } resultText?.text = resultsStr as String } func didFailAutocompleteWithError(_ error: Error) { resultText?.text = error.localizedDescription } }
Objective-C
#import "FetcherSampleViewController.h" #import <GooglePlaces/GooglePlaces.h> #import <GoogleMapsBase/GoogleMapsBase.h> @interface FetcherSampleViewController () <GMSAutocompleteFetcherDelegate> @end @implementation FetcherSampleViewController { UITextField *_textField; UITextView *_resultText; GMSAutocompleteFetcher* _fetcher; } - (void)viewDidLoad { [super viewDidLoad]; self.view.backgroundColor = [UIColor whiteColor]; self.edgesForExtendedLayout = UIRectEdgeNone; // Set bounds to inner-west Sydney Australia. CLLocationCoordinate2D neBoundsCorner = CLLocationCoordinate2DMake(-33.843366, 151.134002); CLLocationCoordinate2D swBoundsCorner = CLLocationCoordinate2DMake(-33.875725, 151.200349); GMSAutocompleteFilter *autocompleteFilter = [[GMSAutocompleteFilter alloc] init]; autocompleteFilter.locationRestriction = GMSPlaceRectangularLocationOption(neBoundsCorner, swBoundsCorner); // Create the fetcher. _fetcher = [[GMSAutocompleteFetcher alloc] initWithBounds:nil filter:filter]; _fetcher.delegate = self; // Set up the UITextField and UITextView. _textField = [[UITextField alloc] initWithFrame:CGRectMake(5.0f, 0, self.view.bounds.size.width - 5.0f, 44.0f)]; _textField.autoresizingMask = UIViewAutoresizingFlexibleWidth; [_textField addTarget:self action:@selector(textFieldDidChange:) forControlEvents:UIControlEventEditingChanged]; _resultText =[[UITextView alloc] initWithFrame:CGRectMake(0, 45.0f, self.view.bounds.size.width, self.view.bounds.size.height - 45.0f)]; _resultText.backgroundColor = [UIColor colorWithWhite:0.95f alpha:1.0f]; _resultText.text = @"No Results"; _resultText.editable = NO; [self.view addSubview:_textField]; [self.view addSubview:_resultText]; } - (void)textFieldDidChange:(UITextField *)textField { NSLog(@"%@", textField.text); [_fetcher sourceTextHasChanged:textField.text]; } #pragma mark - GMSAutocompleteFetcherDelegate - (void)didAutocompleteWithPredictions:(NSArray *)predictions { NSMutableString *resultsStr = [NSMutableString string]; for (GMSAutocompletePrediction *prediction in predictions) { [resultsStr appendFormat:@"%@\n", [prediction.attributedPrimaryText string]]; } _resultText.text = resultsStr; } - (void)didFailAutocompleteWithError:(NSError *)error { _resultText.text = [NSString stringWithFormat:@"%@", error.localizedDescription]; } @end
אסימוני סשן
אסימוני הפעלה מקבצים את שלבי השאילתה והבחירה של חיפוש בהשלמה אוטומטית של משתמש לסשן נפרד למטרות חיוב. הסשן מתחיל כשהמשתמש מתחיל להקליד שאילתה, ומסתיים כשהוא בוחר מקום. כל הפעלה יכולה לכלול מספר שאילתות, ולאחר מכן בחירת מקום אחד. לאחר סיום הסשן, האסימון כבר לא תקף. האפליקציה צריכה ליצור אסימון חדש לכל סשן. מומלץ להשתמש באסימוני סשנים בכל הסשנים של ההשלמה האוטומטית הפרוגרמטית (כשמשתמשים בבקר במסך מלא, או בבקר התוצאות, ה-API יטפל בכך באופן אוטומטי).
Places SDK ל-iOS משתמש ב-GMSAutocompleteSessionToken
כדי לזהות כל סשן. האפליקציה צריכה להעביר אסימון הפעלה חדש בכל התחלה של כל סשן חדש, ולאחר מכן להעביר בקריאה הבאה ל-fetchPlacefromPlaceID:
את אותו אסימון, ביחד עם מזהה מקום, כדי לאחזר את פרטי המקום של המקום שנבחר.
משתמשים בקוד הבא כדי ליצור אסימון חדש לסשן:
let token: GMSAutocompleteSessionToken = GMSAutocompleteSessionToken.init()
מגבלות שימוש
- השימוש ב-method
GMSPlacesClient findAutocompletePredictionsFromQuery
כפוף למגבלות של שאילתות מדורגות. קראו את המאמר בנושא מגבלות שימוש.
הצגת ייחוס באפליקציה
- אם האפליקציה משתמשת בשירות ההשלמה האוטומטית באופן פרוגרמטי, ממשק המשתמש חייב להציג ייחוס 'מופעל על ידי Google' או להופיע במפה עם מיתוג של Google.
- אם האפליקציה משתמשת בפקד ההשלמה האוטומטית של ממשק המשתמש, לא נדרשת פעולה נוספת (הייחוס הנדרש מוצג כברירת מחדל).
- אם מאחזרים ומציגים מידע נוסף על המקום אחרי שקיבלתם מקום לפי מזהה, עליכם להציג גם שיוכים של צד שלישי.
מידע נוסף זמין במסמכי התיעוד בנושא שיוך (Attribution).
שליטה במחוון הפעילות ברשת
כדי לשלוט באינדיקטור של פעילות הרשת בשורת הסטטוס של האפליקציות, עליכם להטמיע את השיטות האופציונליות להאצלה שמתאימות לכיתת ההשלמה האוטומטית שבה אתם משתמשים ולהפעיל ולהשבית את אינדיקטור הרשת בעצמכם.
- עבור
GMSAutocompleteViewController
, צריך להטמיע את שיטות הענקת הגישהdidRequestAutocompletePredictions:
ו-didUpdateAutocompletePredictions:
. - עבור
GMSAutocompleteResultsViewController
, צריך להטמיע את שיטות הענקת הגישהdidRequestAutocompletePredictionsForResultsController:
ו-didUpdateAutocompletePredictionsForResultsController:
. - עבור
GMSAutocompleteTableDataSource
, צריך להטמיע את שיטות הענקת הגישהdidRequestAutocompletePredictionsForTableDataSource:
ו-didUpdateAutocompletePredictionsForTableDataSource:
.
אם מיישמים את השיטות האלה ומגדירים את [UIApplication sharedApplication].networkActivityIndicatorVisible
ל-YES
ול-NO
, בהתאמה, שורת הסטטוס תתאים לממשק המשתמש של ההשלמה האוטומטית.
הגבלת תוצאות ההשלמה האוטומטית
תוכלו להגדיר את הפקד של ההשלמה האוטומטית בממשק המשתמש כך שיגביל את התוצאות לאזור גיאוגרפי מסוים, או לסנן את התוצאות לפי סוג מקום אחד או יותר, או לפי מדינה או מדינות ספציפיות. כדי להגביל את התוצאות, אפשר לבצע את הפעולות הבאות:
- על מנת להעדיף (הטיות) תוצאות בתוך האזור המוגדר, מגדירים את הערך
locationBias
ב-GMSAutocompleteFilter
(יכול להיות שעדיין יוחזרו תוצאות מסוימות מחוץ לאזור המוגדר). אם המדיניותlocationRestriction
מוגדרת גם, המערכת תתעלם מ-locationBias
. על מנת להציג רק (להגביל) תוצאות בתוך האזור המוגדר, צריך להגדיר את הערך
locationRestriction
ב-GMSAutocompleteFilter
(יוחזרו רק תוצאות בתוך האזור המוגדר).- הערה: ההגבלה הזו חלה רק על מסלולים שלמים. יכול להיות שתוצאות סינתטיות שנמצאות מחוץ לגבולות המלבניים יוחזרו על סמך מסלול שחופף להגבלת המיקום.
כדי להחזיר רק תוצאות שתואמות לסוג מסוים של מקום, מגדירים את הערך
types
ב-GMSAutocompleteFilter
(לדוגמה, ציון TypeFilter.ADDRESS יגרום לווידג'ט להחזיר רק תוצאות עם כתובת מדויקת).על מנת להחזיר רק תוצאות בטווח של עד חמש מדינות שצוינו, מגדירים את הערך
countries
בGMSAutocompleteFilter
.
הטיית תוצאות לאזור ספציפי
על מנת להעדיף (הטיות) תוצאות בתוך האזור המוגדר, מגדירים את הערך locationBias
ב-GMSAutocompleteFilter
, כפי שמוצג כאן:
northEast = CLLocationCoordinate2DMake(39.0, -95.0);
southWest = CLLocationCoordinate2DMake(37.5, -100.0);
GMSAutocompleteFilter *filter = [[GMSAutocompleteFilter alloc] init];
filter.locationBias = GMSPlaceRectangularLocationOption(northEast, southWest);
הגבלת התוצאות לאזור מסוים
על מנת להציג (להגביל) תוצאות רק בתוך האזור המוגדר, צריך להגדיר את הערך locationRestriction
ב-GMSAutocompleteFilter
כמו שמוצג כאן:
northEast = CLLocationCoordinate2DMake(39.0, -95.0);
southWest = CLLocationCoordinate2DMake(37.5, -100.0);
GMSAutocompleteFilter *filter = [[GMSAutocompleteFilter alloc] init];
filter.locationRestriction = GMSPlaceRectangularLocationOption(northEast, southWest);
סינון התוצאות לפי מדינה
כדי לסנן תוצאות בטווח של עד חמש מדינות ספציפיות, מגדירים את countries
ב-GMSAutocompleteFilter
, כמו שמוצג כאן:
GMSAutocompleteFilter *filter = [[GMSAutocompleteFilter alloc] init];
filter.countries = @[ @"au", @"nz" ];
סינון תוצאות לפי סוג מקום או סוג אוסף
מגבילים את התוצאות לאוסף מסוג מסוים או מסוג מסוים על ידי הגדרת המאפיין types
של GMSAutoCompleteFilter
.
השתמשו במאפיין הזה כדי לציין מסננים שמופיעים בטבלאות 1, 2 ו-3 בקטע סוגי מקומות. אם לא צוין דבר, מוחזרים כל הסוגים.
כדי לציין מסנן של סוג או סוג של אוסף:
אפשר להשתמש במאפיין
types
כדי לציין עד חמישה ערכי סוג מטבלה 1 ומטבלה 2 שמוצגים בסוגי מקומות. ערכי הסוגים מוגדרים באמצעות הקבועים ב-GMSPlaceType
.השתמשו במאפיין
types
כדי לציין אוסף טיפוס מטבלה 3 שמוצג בסוגי מקומות. הערכים של אוסף הסוגים מוגדרים לפי הקבועים ב-GMSPlaceType
.אפשר לכלול בבקשה רק סוג אחד מטבלה 3. אם ציינתם ערך מטבלה 3, לא תוכלו לציין ערך מטבלה 1 או מטבלה 2. במקרה כזה, תופיע שגיאה.
לדוגמה, כדי להחזיר רק תוצאות שתואמות לסוג מסוים של מקום, מגדירים את הערך types
ב-GMSAutocompleteFilter
. הדוגמה הבאה מציגה איך להגדיר את המסנן כך שיחזיר רק תוצאות עם כתובת מדויקת:
GMSAutocompleteFilter *filter = [[GMSAutocompleteFilter alloc] init];
filter.types = @[ kGMSPlaceTypeAirport, kGMSPlaceTypeAmusementPark ];
אופטימיזציה של השלמה אוטומטית במקומות
בקטע הזה מתוארות שיטות מומלצות שיעזרו לך להפיק את המרב משירות ההשלמה האוטומטית של מקומות.
הנה כמה הנחיות כלליות:
- הדרך המהירה ביותר לפתח ממשק משתמש פעיל היא להשתמש בווידג'ט להשלמה אוטומטית של API של מפות Google, ב-Place SDK ל-Android ווידג'ט של השלמה אוטומטית או ב-Place SDK ל-iOS, בקרה על השלמה אוטומטית של ממשק משתמש
- חשוב להבין את שדות הנתונים החיוניים להשלמה אוטומטית של מקומות כבר מההתחלה.
- השדות 'הטיות לפי מיקום' ו'הגבלת מיקום' הם אופציונליים, אבל עשויה להיות להם השפעה משמעותית על הביצועים של ההשלמה האוטומטית.
- שימוש בטיפול בשגיאות כדי לוודא שהאיכות של האפליקציה תפחת בהדרגה אם ה-API מחזיר שגיאה.
- צריך לוודא שהאפליקציה מטפלת במצב שבו לא נבחרה אפשרות ושהיא מציעה למשתמשים אפשרות להמשיך.
שיטות מומלצות לאופטימיזציית עלויות
אופטימיזציה בסיסית של עלויות
כדי לייעל את עלות השימוש בשירות השלמה אוטומטית של מקומות, יש להשתמש במסכות של שדות בווידג'טים של 'פרטי מקום' ו'השלמה אוטומטית של מקום' כדי להחזיר רק את השדות של נתוני המקום שנחוצים לכם.
אופטימיזציה מתקדמת של עלויות
כדאי להשתמש בהטמעה פרוגרמטית של השלמה אוטומטית של מקומות כדי לגשת לתמחור לפי בקשה ולבקש תוצאות של Geocoding API לגבי המקום שנבחר במקום 'פרטי מקום'. תמחור לפי בקשה בשילוב עם Geocoding API משתלם יותר מתמחור לכל סשן (מבוסס-ביקור) אם מתקיימים שני התנאים הבאים:
- אם יש צורך רק בקווי הרוחב/האורך או הכתובת של המקום שנבחר על ידי המשתמש, ה-Geocoding API יספק את המידע הזה עבור פחות משיחה של 'פרטי מקום'.
- אם משתמשים בוחרים בחיזוי להשלמה אוטומטית בתוך ארבע בקשות לחיזויים של ההשלמה האוטומטית בממוצע, או פחות, התמחור לפי בקשה עשוי להיות משתלם יותר מהתמחור לכל סשן.
האם הבקשה שלך דורשת מידע נוסף מלבד הכתובת וקו הרוחב/קו האורך של החיזוי שנבחר?
כן, נדרשים פרטים נוספים
השתמשו בהשלמה אוטומטית של מקומות על בסיס פרטי המקום, עם פרטי המקום.
מאחר שהאפליקציה שלך דורשת פרטי מקום כמו שם המקום, סטטוס העסק או שעות הפתיחה, עליך להטמיע את ההשלמה האוטומטית של מקום באמצעות אסימון סשן (פרוגרמטי או מובנה בווידג'טים של JavaScript, Android או iOS) כך שהעלות הכוללת תהיה 0.017 $לכל סשן וגם מק"טים של נתוני המקומות הרלוונטיים, בהתאם לשדות המק"טים של נתוני המקומות בהתאם לשדות הבקשה המבוקשים.
הטמעת ווידג'ט
ניהול הסשנים מובנה באופן אוטומטי בווידג'טים JavaScript, Android או iOS. החיזוי הזה כולל גם את הבקשות להשלמה אוטומטית של מקומות וגם את הבקשה לפרטי מקום בחיזוי שנבחר. חשוב לציין את הפרמטר fields
כדי לוודא שביקשת רק את
השדות של נתוני המקום הדרושים.
הטמעה פרוגרמטית
יש להשתמש באסימון סשן עם הבקשות להשלמה אוטומטית של מקומות. כשמבקשים לקבל פרטי מקום לגבי החיזוי שנבחר, צריך לכלול את הפרמטרים הבאים:
- מזהה המקום מהתשובה להשלמה אוטומטית של מקום
- אסימון הסשן שבו נעשה שימוש בבקשת ההשלמה האוטומטית של מקום
- הפרמטר
fields
שמציין את השדות של נתוני המקום הדרושים
לא, צריך רק כתובת ומיקום
הממשק Geocoding API יכול להיות יותר חסכוני יותר מאשר 'פרטי מקום' עבור האפליקציה, בהתאם לביצועים של השימוש בהשלמה האוטומטית של מקומות. יעילות ההשלמה האוטומטית של כל אפליקציה משתנה בהתאם למה שהמשתמשים מזינים, למיקום שבו נעשה שימוש באפליקציה ולשאלה אם יושמו שיטות מומלצות לאופטימיזציית ביצועים.
כדי לענות על השאלה הבאה, צריך לנתח את מספר התווים הממוצע שמשתמש מקליד לפני שבוחרים חיזוי להשלמה אוטומטית של מקום באפליקציה.
האם המשתמשים שלכם בוחרים חיזוי להשלמה אוטומטית של מקומות בארבע בקשות או פחות, בממוצע?
כן
יש להטמיע באופן פרוגרמטי השלמה אוטומטית של מקומות ללא אסימוני סשן וקריאה ל-Geocoding API בחיזוי המקום שנבחר.
API לקידוד גיאוגרפי מספק כתובות וקואורדינטות של קווי אורך ורוחב בעלות של 0.005 $לבקשה. ביצוע ארבע בקשות מסוג השלמה אוטומטית במקום – לכל בקשה עולה 0.01,32$, כך שהעלות הכוללת של ארבע בקשות בתוספת קריאה ל-Geocoding API לגבי חיזוי המקום שנבחר תהיה 0.01632$, שהוא נמוך מהמחיר להשלמה אוטומטית לכל סשן בסך 0.017 $לכל סשן.1
נסו להשתמש בשיטות מומלצות לשיפור הביצועים כדי לעזור למשתמשים לקבל את התחזית שהם מחפשים, תוך שימוש בפחות תווים.
לא
השתמשו בהשלמה אוטומטית של מקומות על בסיס פרטי המקום, עם פרטי המקום.
מכיוון שהמספר הממוצע של הבקשות שאתם מצפים לשלוח לפני שמשתמש בוחר בחיזוי של השלמה אוטומטית של מקום, גבוה מהמחיר של כל סשן, אם תטמיעו את התכונה 'השלמה אוטומטית של מקומות', תצטרכו להשתמש באסימון סשן גם לבקשות להשלמה אוטומטית של מקומות וגם לבקשה של פרטי מקום שמשויכת, בעלות כוללת של 0.017 $לכל סשן.1
הטמעת ווידג'ט
ניהול הסשנים מובנה באופן אוטומטי בווידג'טים JavaScript, Android או iOS. החיזוי הזה כולל גם את הבקשות להשלמה אוטומטית של מקומות וגם את הבקשה לפרטי מקום בחיזוי שנבחר. חשוב לציין את הפרמטר fields
כדי לוודא שביקשת רק את השדות של נתונים בסיסיים.
הטמעה פרוגרמטית
יש להשתמש באסימון סשן עם הבקשות להשלמה אוטומטית של מקומות. כשמבקשים לקבל פרטי מקום לגבי החיזוי שנבחר, צריך לכלול את הפרמטרים הבאים:
- מזהה המקום מהתשובה להשלמה אוטומטית של מקום
- אסימון הסשן שבו נעשה שימוש בבקשת ההשלמה האוטומטית של מקום
- הפרמטר
fields
שבו מצוינים שדות נתונים בסיסיים, כמו כתובת וגיאומטריה
כדאי לשקול לעכב בקשות להשלמה אוטומטית של מקומות
ניתן להשתמש באסטרטגיות כמו השהיית בקשה להשלמה אוטומטית של מקום עד שהמשתמש יקליד בשלושת או ארבעת התווים הראשונים, כדי שהאפליקציה תשלח פחות בקשות. לדוגמה, שליחת בקשות להשלמה אוטומטית של מקומות עבור כל תו אחרי שהמשתמש הקליד את התו השלישי, המשמעות היא שאם המשתמש מקליד שבעה תווים ולאחר מכן בוחר חיזוי שעבורו אתם שולחים בקשה אחת ל-Geocoding API, העלות הכוללת תהיה 0.01632$ (4 * $0.00283 השלמה אוטומטית לכל בקשה + 0.005 $קידוד גיאוגרפי).1
אם מספר הבקשות הפרוגרמטי הממוצע שתוכלו לקבל נמוך מ-4, תוכלו לפעול לפי ההנחיות בנושא הטמעת השלמה אוטומטית של מקומות לפי ביצועים באמצעות Geocoding API. הערה: משתמשים שצפויים לצפות לראות חיזויים בכל הקשה חדשה על ידי הקשה על המקשים האלה, עלולים להיחשב כזמן אחזור אצל המשתמשים.
נסו להשתמש בשיטות מומלצות לשיפור הביצועים כדי לעזור למשתמשים לקבל את התחזית שהם מחפשים, בפחות תווים.
-
העלויות המפורטות כאן הן בדולר ארה"ב. לקבלת מידע על התמחור המלא, אפשר לעיין בדף חיוב בפלטפורמה של מפות Google.
שיטות מומלצות לשיפור הביצועים
ההנחיות הבאות מתארות דרכים לביצוע אופטימיזציה של ביצועי ההשלמה האוטומטית של מקומות:
- להוסיף הגבלות לפי מדינה, הטיות לפי מיקום והעדפות שפה (בהטמעות פרוגרמטיות) להטמעה של ההשלמה האוטומטית של מקומות. בווידג'טים אין צורך בהעדפת שפה, כי הם בוחרים את העדפות השפה מהדפדפן או מהנייד של המשתמש.
- אם ההשלמה האוטומטית של מקום מלווה במפה, ניתן להטות את המיקום לפי אזור התצוגה של המפה.
- במצבים שבהם המשתמש לא בוחר באחד מהחיזויים של ההשלמה האוטומטית, בדרך כלל
מאחר שאף אחד מהחיזויים האלה אינו כתובת של התוצאה הרצויה, אפשר להשתמש שוב בקלט המקורי של המשתמש כדי לנסות לקבל תוצאות רלוונטיות יותר:
- אם אתם מצפים שהמשתמש יזין רק פרטי כתובת, השתמשו שוב בקלט המקורי של המשתמש בשיחה אל Geocoding API.
- אם אתם מצפים שהמשתמש יזין שאילתות לגבי מקום ספציפי לפי שם או כתובת, השתמשו בבקשה לחיפוש מקום. אם צפויות תוצאות רק באזור ספציפי, השתמשו בתעדוף לפי מיקום.
- משתמשים שמזינים כתובות של הנחות משנה במדינות שבהן התמיכה בהשלמה אוטומטית של מקומות בכתובות של תת-דומיינים לא הושלמה, למשל צ'כיה, אסטוניה וליטא. לדוגמה, הכתובת בצ'כית "Stroupežnického 3191/17, Praha" מניבה חיזוי חלקי בהשלמה אוטומטית של מקום.
- משתמשים שמזינים כתובות עם קידומות של קטעי כביש, כמו " 23-30 29th St, Queens" בניו יורק, או " 47-380 Kamehameha Hwy, Kaneohe" באי קאואי שבהוואי.
פתרון בעיות
למרות שיש מגוון רחב של שגיאות, רוב השגיאות שעלולות להתרחש באפליקציה נגרמות בדרך כלל משגיאות בהגדרה (למשל, שימוש במפתח API שגוי או שמפתח ה-API הוגדר בצורה לא נכונה) או משגיאות שקשורות למכסה (האפליקציה חרגה מהמכסה). מידע נוסף על המכסות זמין במאמר מגבלות השימוש.
שגיאות שמתרחשות במהלך השימוש בפקדי ההשלמה האוטומטית מוחזרות בשיטה didFailAutocompleteWithError()
בפרוטוקולים השונים של הענקת גישה. המאפיין code
של האובייקט NSError
שסופק מוגדר לאחד מהערכים של המספור GMSPlacesErrorCode
.