Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

Place Autocomplete（従来版）

非推奨のお知らせ

Place Autocomplete（従来版）は、ユーザーの検索クエリに対応して場所の予測を返します。ユーザーが入力を始めると、予測入力サービスにより、店舗、住所、Plus Codes、スポットなどの場所に関する候補が返されます。

次の方法でアプリにオートコンプリート機能を追加することができます。

予測入力 UI コントロールを追加して開発時間を短縮し、一貫したユーザーエクスペリエンスを確保する。
プログラムで場所の予測を取得して、カスタマイズされたユーザーエクスペリエンスを作成します。

予測入力 UI コントロールを追加する

予測入力 UI コントロールは、予測入力機能が組み込まれた検索ダイアログです。ユーザーが検索キーワードを入力すると、このコントロールにより、選択可能な場所の候補のリストが表示されます。ユーザーが選択すると、GMSPlace インスタンスが返されます。アプリはこれを使用して、選択された場所の詳細を取得できます。

次の方法でアプリにオートコンプリート UI コントロールを追加することができます。

全画面表示コントロールを追加する
結果コントローラを追加する
テーブルデータソースを使用する

全画面表示コントロールの追加

全画面コントロールは、ユーザーが選択を行うまで予測入力 UI がアプリの UI を一時的に置き換えるモーダルコンテキストが必要な場合に使用します。この機能は GMSAutocompleteViewController クラスによって提供されます。ユーザーがプレイスを選択すると、アプリはコールバックを受け取ります。

フルスクリーンコントロールをアプリに追加するには:

メインアプリに、予測入力 UI コントロールを起動する UI 要素（UIButton のタッチハンドラなど）を作成します。
親ビューコントローラに GMSAutocompleteViewControllerDelegate プロトコルを実装します。
GMSAutocompleteViewController のインスタンスを作成し、親ビューコントローラをデリゲートプロパティとして割り当てます。
GMSPlaceField を作成して、返す場所データのタイプを定義します。
GMSAutocompleteFilter を追加して、クエリを特定の場所のタイプに制限します。
[self presentViewController...] を使用して GMSAutocompleteViewController を提示します。
didAutocompleteWithPlace デリゲートメソッドでユーザーの選択を処理します。
didAutocompleteWithPlace、didFailAutocompleteWithError、wasCancelled のデリゲートメソッドでコントローラを閉じます。

以下のコードは、ユーザーがボタンをタップしたときに GMSAutocompleteViewController を起動する方法の 1 つを示しています。

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 = [kGMSPlaceTypeCollectionAddress]
    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:@selector(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

結果コントローラの追加

テキスト入力 UI をより細かく制御する場合は、結果コントローラを使用します。結果コントローラは、入力 UI のフォーカスに基づいて、結果リストの表示を動的に切り替えます。

結果コントローラをアプリに追加するには:

GMSAutocompleteResultsViewController を作成します。
1. 親ビューコントローラに GMSAutocompleteResultsViewControllerDelegate プロトコルを実装し、親ビューコントローラをデリゲートプロパティとして割り当てます。
UISearchController オブジェクトを作成し、GMSAutocompleteResultsViewController を結果コントローラの引数として渡します。
GMSAutocompleteResultsViewController を UISearchController の searchResultsUpdater プロパティとして設定します。
UISearchController の searchBar をアプリの UI に追加します。
didAutocompleteWithPlace デリゲートメソッドでユーザーの選択を処理します。

UISearchController の検索バーをアプリの UI に配置する方法はいくつかあります。

ナビゲーションバーに検索バーを追加する
ビューの上部に検索バーを追加する
ポップオーバー結果を使用して検索バーを追加する

ナビゲーションバーに検索バーを追加する

以下のコード例は、結果のコントローラを追加し、ナビゲーションバーに 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;
}

テーブルデータソースの使用

アプリにカスタム検索テキスト UI がある場合は、GMSAutocompleteTableDataSource クラスを使用して、ビューコントローラに結果を表示するテーブルビューを操作できます。

ビューコントローラで GMSAutocompleteTableDataSource をデータソースとして使用し、UITableView のデリゲートとして使用するには、次のようにします。

ビューコントローラに GMSAutocompleteTableDataSourceDelegate プロトコルと UISearchBarDelegate プロトコルを実装します。
GMSAutocompleteTableDataSource インスタンスを作成し、ビューコントローラをデリゲートプロパティとして割り当てます。
ビューコントローラで、GMSAutocompleteTableDataSource を UITableView インスタンスのデータソースおよびデリゲートプロパティとして設定します。
検索テキスト入力のハンドラで、GMSAutocompleteTableDataSource の sourceTextHasChanged を呼び出します。
1. didAutocompleteWithPlace デリゲートメソッドでユーザーの選択を処理します。
didAutocompleteWithPlace、didFailAutocompleteWithError、wasCancelled のデリゲートメソッドでコントローラを閉じます。

次のコード例は、UISearchBar が個別に追加されたときに、GMSAutocompleteTableDataSource クラスを使用して UIViewController のテーブルビューを駆動する方法を示しています。

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

テキストと背景色のカスタマイズ

予測入力 UI コントロールのすべてのテキストと背景の色を設定して、ウィジェットをアプリの外観に近づけることができます。UI コントロールの色を設定するには、次の 2 つの方法があります。

可能な場合は、組み込みの iOS UIAppearance プロトコルを使用して、UI コントロールのスタイルをグローバルに設定します。これらの設定は、すべてではありませんが、多くの UI コントロール要素に適用されます。
ウィジェットクラスの SDK メソッドを使用して、UIAppearance プロトコルでサポートされていないプロパティを設定する。

通常、アプリでは UIAppearance プロトコルと SDK メソッドを組み合わせて使用します。次の図は、スタイル設定が可能な要素を示しています。

予測入力 UI コントロールの色

次の表に、すべての UI 要素と、各要素のスタイル設定方法（UIAppearance プロトコルまたは SDK メソッド）を示します。

UI 要素	メソッド	スタイルのハウツー
ナビゲーションバーの色合い（背景）	UIAppearance プロトコル	`UINavigationBar` プロキシで `setBarTintColor` を呼び出します。
ナビゲーションバーの色合い（検索バーのテキストカーソルと [キャンセル] ボタン）	UIAppearance プロトコル	`UINavigationBar` プロキシで `setTintColor` を呼び出します。
検索バーのテキストの色	UIAppearance プロトコル	`searchBarTextAttributes` で `NSForegroundColorAttributeName` を設定します。
検索バーの色合い	なし	検索バーは半透明で、ナビゲーションバーのシェーディングバージョンとして表示されます。
検索バーのプレースホルダテキストの色（デフォルトの検索テキスト）	UIAppearance プロトコル	`placeholderAttributes` で `NSForegroundColorAttributeName` を設定します。
メインテキスト（エラーテキストとメッセージテキストにも適用）	SDK メソッド	`primaryTextColor`までお電話ください。
メインテキストのハイライト	SDK メソッド	`primaryTextHighlightColor`までお電話ください。
セカンダリテキスト	SDK メソッド	`secondaryTextColor`までお電話ください。
エラーとメッセージのテキスト	SDK メソッド	`primaryTextColor`までお電話ください。
テーブルセルの背景	SDK メソッド	`tableCellBackgroundColor`までお電話ください。
表のセル区切りの色	SDK メソッド	`tableCellSeparatorColor`までお電話ください。
[もう一度試す] ボタン	SDK メソッド	`tintColor`までお電話ください。
アクティビティインジケーター（進行状況スピナー）	UIAppearance プロトコル	`UIActivityIndicatorView` プロキシで `setColor` を呼び出します。
「Powered by Google」ロゴ、悲しそうな雲の画像	なし	背景のコントラストに基づいて、白またはグレーのバージョンが自動的に選択されます。
検索バーのテキストフィールドにある虫メガネとテキストをクリアするアイコン	なし	スタイルを設定するには、デフォルトの画像を目的の色の画像に置き換えます。

UIAppearance プロトコルの使用

UIAppearance プロトコルを使用して、特定の UI 要素の外観プロキシを取得し、それを使用して UI 要素の色を設定できます。変更を加えると、特定の UI 要素のすべてのインスタンスが影響を受けます。たとえば、次の例では、UISearchBar に含まれる UITextField クラスのテキストの色をグローバルに緑に変更しています。

[[UITextField appearanceWhenContainedIn:[UISearchBar class], nil]
    setDefaultTextAttributes:@{NSForegroundColorAttributeName:[UIColor greenColor]}];

色の値の定義について詳しくは、UIColor クラスのリファレンスをご覧ください。

次のコードスニペットは、フルスクリーン予測入力 UI コントロールのすべての要素にスタイルを適用するために必要なプロキシコマンドを示しています。このコードを Appdelegate.m の didFinishLaunchingWithOptions メソッドに追加します。

// 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 コントロールのスタイルプロパティを設定する

UI コントロール要素のサブセットには、UIAppearance プロトコルの影響を受けないプロパティがあるため、直接設定する必要があります。次のコード例は、前景色と背景色を定義し、acController という名前の UI コントロールインスタンスに適用する方法を示しています。ViewController.m の onLaunchClicked メソッドに次のコードを追加します。

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;

プログラムで場所の予測を取得する

予測入力ウィジェットが提供する UI の代わりに、カスタム検索 UI を作成できます。これを行うには、アプリでプログラムによって場所の予測を取得する必要があります。アプリは、次のいずれかの方法で、予測される場所の名前や住所のリストを取得できます。

GMSPlacesClient findAutocompletePredictionsFromQuery: に電話する
フェッチャーを使用する

`GMSPlacesClient findAutocompletePredictionsFromQuery:` さんに発信しています

予測される場所の名前や住所のリストを取得するには、まず GMSPlacesClient をインスタンス化してから、次のパラメータを指定して GMSPlacesClient findAutocompletePredictionsFromQuery: メソッドを呼び出します。

ユーザーが入力したテキストを含む autocompleteQuery 文字列。
GMSAutocompleteSessionToken。個々のセッションを識別するために使用されます。アプリは、予測入力リクエストの呼び出しごとに同じトークンを渡し、そのトークンとプレイス ID を後続の fetchPlacefromPlaceID: の呼び出しで渡して、ユーザーが選択した場所の Place Details を取得する必要があります。
A 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 = [kGMSPlaceTypeBank]
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 形式）。たとえば、「Sydney Opera House, Sydney, New South Wales, Australia」などです。ユーザー入力と一致するすべてのテキスト範囲には、kGMSAutocompleteMatchAttribute 属性があります。この属性を使用すると、以下に示すように、ユーザーのクエリで一致するテキストをハイライト表示できます。
placeID - 予測された場所のプレイス ID。プレイス ID は、場所を一意に識別するテキスト表記の ID です。プレイス ID について詳しくは、プレイス ID の概要をご覧ください。
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 を使用できます。これは、GMSPlacesClient の autocompleteQuery メソッドをラップします。フェッチャーはリクエストをスロットリングし、最後に入力された検索テキストの結果のみを返します。UI 要素は提供されません。

GMSAutocompleteFetcher を実装する手順は次のとおりです。

GMSAutocompleteFetcherDelegate プロトコルを実装します。
GMSAutocompleteFetcher オブジェクトを作成します。
ユーザーが入力するたびに、フェッチャーで sourceTextHasChanged を呼び出します。
didAutcompleteWithPredictions プロトコルメソッドと didFailAutocompleteWithError プロトコルメソッドを使用して、予測とエラーを処理します。

次のコード例は、フェッチャーを使用してユーザー入力を取得し、一致する場所をテキストビューに表示する方法を示しています。場所を選択する機能は省略されています。FetcherSampleViewController は、FetcherSampleViewController.h の UIViewController から派生しています。

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>

@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

セッショントークン

セッショントークンは、予測入力検索でのユーザーのクエリと選択フェーズを、請求処理のために個別のセッションにグループ化します。セッションは、ユーザーが検索語句を入力し始めたときに開始され、ユーザーが場所を選択すると終了します。セッションによっては、複数の検索語句が入力された後に、1 つの場所が選択される場合もあります。セッションが終了すると、トークンは無効になります。アプリでは、セッションごとに新しいトークンを生成する必要があります。すべてのプログラムによる予測入力セッションでセッショントークンを使用することをおすすめします（フルスクリーンコントローラまたは結果コントローラを使用する場合、API が自動的に処理します）。

Places SDK for iOS では、GMSAutocompleteSessionToken を使用して各セッションを識別します。アプリは、新しいセッションを開始するたびに新しいセッショントークンを渡し、その後、fetchPlacefromPlaceID: の呼び出しで、その同じトークンとプレイス ID を渡して、ユーザーが選択した場所の Place Details を取得する必要があります。

セッショントークンの詳細

次のコードを使用して、新しいセッショントークンを生成します。

let token: GMSAutocompleteSessionToken = GMSAutocompleteSessionToken.init()

使用量上限

GMSPlacesClient findAutocompletePredictionsFromQuery メソッドの使用には、階層化されたクエリの上限が適用されます。使用量上限に関するドキュメントをご覧ください。

アプリに帰属情報を表示する

アプリでプログラムによって予測入力サービスを使用する場合、UI に「Powered by Google」の帰属表示を表示するか、Google ブランドの地図内に表示する必要があります。
アプリで予測入力 UI コントロールを使用している場合、追加の対応は必要ありません（必要な帰属表示はデフォルトで表示されます）。
ID で場所を取得した後に、追加の場所情報を取得して表示する場合は、サードパーティの帰属表示も行う必要があります。

詳細については、アトリビューションに関するドキュメントをご覧ください。

ネットワークアクティビティインジケーターの制御

アプリケーションのステータスバーでネットワークアクティビティインジケーターを制御するには、使用している予測入力クラスに適切なオプションのデリゲートメソッドを実装し、ネットワークインジケーターを自分でオンまたはオフにする必要があります。

GMSAutocompleteViewController の場合は、デリゲートメソッド didRequestAutocompletePredictions: と didUpdateAutocompletePredictions: を実装する必要があります。
GMSAutocompleteResultsViewController の場合、デリゲートメソッド didRequestAutocompletePredictionsForResultsController: と didUpdateAutocompletePredictionsForResultsController: を実装する必要があります。
GMSAutocompleteTableDataSource の場合、デリゲートメソッド didRequestAutocompletePredictionsForTableDataSource: と didUpdateAutocompletePredictionsForTableDataSource: を実装する必要があります。

これらのメソッドを実装し、[UIApplication sharedApplication].networkActivityIndicatorVisible をそれぞれ YES と NO に設定することで、ステータスバーが予測入力 UI と正しく一致するようになります。

予測入力の結果を制限する

予測入力 UI コントロールを設定して、結果を特定の地理的リージョンに制限したり、結果を 1 つ以上の場所タイプや特定の国にフィルタしたりできます。結果を制限するには、次の操作を行います。

定義されたリージョン内の結果を優先（バイアス）するには、GMSAutocompleteFilter で locationBias を設定します（定義されたリージョン外の結果が返されることもあります）。locationRestriction も設定されている場合、locationBias は無視されます。
定義された地域内の結果のみを表示（制限）するには、GMSAutocompleteFilter で locationRestriction を設定します（定義された地域内の結果のみが返されます）。
- 注: この制限はルート全体にのみ適用されます。ルートの 1 つが位置情報の制限と重なる場合、長方形の境界外にある合成結果が返されることがあります。
特定の場所タイプに一致する結果のみを返すには、GMSAutocompleteFilter で types を設定します（たとえば、kGMSPlaceTypeCollectionAddress を指定すると、ウィジェットは正確な住所を持つ結果のみを返します）。
指定した最大 5 か国内の結果のみを返すには、GMSAutocompleteFilter で countries を設定します。

特定の地域を優先するよう結果にバイアスを設定する

定義したリージョン内の結果を優先（バイアス）するには、次のように GMSAutocompleteFilter で locationBias を設定します。

northEast = CLLocationCoordinate2DMake(39.0, -95.0);  southWest =
CLLocationCoordinate2DMake(37.5, -100.0);  GMSAutocompleteFilter *filter =
[[GMSAutocompleteFilter alloc] init];  filter.locationBias =
GMSPlaceRectangularLocationOption(northEast, southWest);

結果を特定のリージョンに制限する

定義した地域内の結果のみを表示（制限）するには、次のように GMSAutocompleteFilter で locationRestriction を設定します。

northEast = CLLocationCoordinate2DMake(39.0, -95.0);  southWest =
CLLocationCoordinate2DMake(37.5, -100.0);  GMSAutocompleteFilter *filter =
[[GMSAutocompleteFilter alloc] init];  filter.locationRestriction =
GMSPlaceRectangularLocationOption(northEast, southWest);

国で結果をフィルタする

指定した最大 5 か国で結果をフィルタするには、次のように GMSAutocompleteFilter で countries を設定します。

GMSAutocompleteFilter *filter = [[GMSAutocompleteFilter alloc] init];
filter.countries = @[ @"au", @"nz" ];

場所のタイプまたはタイプコレクションで検索結果をフィルタする

GMSAutoCompleteFilter の types プロパティを設定して、結果を特定のタイプまたはタイプコレクションに制限します。このプロパティを使用して、場所タイプの表 1、2、3 に記載されているフィルタを指定します。何も指定しないと、すべてのタイプが返されます。

タイプまたはタイプコレクションフィルタを指定するには:

types プロパティを使用して、プレイスタイプに示されている表 1 と表 2 から最大 5 つのタイプ値を指定します。タイプ値は、GMSPlaceType の定数によって定義されます。
types プロパティを使用して、場所のタイプに表示されている表 3 からタイプコレクションを指定します。タイプコレクションの値は、GMSPlaceType の定数で定義されます。

リクエストでは、表 3 のタイプのうち、1 つのみが許可されます。表 3 の値を指定する場合、表 1 または表 2 の値は指定できません。そうすると、エラーが発生します。

たとえば、特定の場所タイプに一致する結果のみを返すには、GMSAutocompleteFilter で types を設定します。次の例では、正確な住所を含む結果のみを返すようにフィルタを設定しています。

GMSAutocompleteFilter *filter = [[GMSAutocompleteFilter alloc] init];
filter.types = @[ kGMSPlaceTypeAirport, kGMSPlaceTypeAmusementPark ];

Place Autocomplete（従来版）の最適化

このセクションでは、Place Autocomplete（従来版）サービスを最大限に活用するためのヒントを紹介します。

概要は次のとおりです。

機能的なユーザーインターフェースを最も手早く作成するには、Maps JavaScript API Place Autocomplete（従来版）ウィジェット、Places SDK for Android Place Autocomplete（従来版）ウィジェット、または Places SDK for iOS Place Autocomplete（従来版）UI コントロールを使用します。
Place Autocomplete（従来版）のデータフィールドの基本を理解します。
位置情報のバイアスと位置情報の制限のフィールドは省略可能ですが、予測入力のパフォーマンスに大きく影響する場合があります。
エラー処理を使用して、API がエラーを返した場合に、アプリでグレースフルデグラデーションが行われるようにします。
アプリでは、選択肢がない場合でもユーザーが操作を続行できるようにします。

費用の最適化に関するヒント

基本的な費用の最適化

Place Autocomplete（従来版）サービスの費用を最適化するには、Place Details（従来版）と Place Autocomplete（従来版）ウィジェットのフィールドマスクを使用して、必要な Place Autocomplete（従来版）のデータフィールドのみを返すよう設定します。

高度な費用の最適化

SKU: Autocomplete - Per Request の料金設定を利用し、Place Details（従来版）の代わりに選択された場所に関する Geocoding API の結果をリクエストするためには、Place Autocomplete（従来版）のプログラマティック実装を行うことをおすすめします。次の両方に該当する場合は、リクエストあたりの料金設定と Geocoding API を組み合わせた方が、セッションあたり（セッションベース）の料金設定よりも費用対効果が高くなります。

ユーザーが選択した場所の緯度と経度または住所のみが必要な場合。その場合は、Geocoding API の方が、Place Details（従来版）の呼び出しよりも少ないコストでこの情報を提供できます。
ユーザーが Place Autocomplete（従来版）の予測入力候補を平均 4 回以下の予測リクエストで選択した場合、リクエストあたりの料金設定の方がセッションあたりの料金設定よりも費用対効果が高くなります。

アプリケーションの費用を最小限に抑える Place Autocomplete（従来版）の実装を選択するには、次の表でアプリケーションのニーズに一致する行を見つけます。

アプリケーションに必要なもの	ユーザーが予測を選択するまでに実行される Place Autocomplete（従来版）リクエストの平均数	おすすめの実装方法
住所と位置以外の Place Details（場所の名前、ビジネスのステータス、営業時間など）	その他の数字	セッションベースの Place Autocomplete（従来版）と Place Details（従来版）
選択された予測結果の住所と緯度 / 経度のみ	4 以下	Geocoding API を使用したリクエストごとの Place Autocomplete（従来版）
選択された予測結果の住所と緯度 / 経度のみ	4 回以上	住所のみのアプリケーション向けのセッションベースの Place Autocomplete（従来版）

Place Autocomplete（従来版）使用時のパフォーマンスによっては、アプリケーションで Places Details（従来版）を使用するよりも、Geocoding API を使用した方が費用対効果が高くなる場合があります。アプリケーションの Place Autocomplete（従来版）の効率は、ユーザーの入力内容や、アプリケーションが使用される場所、パフォーマンス最適化のベストプラクティスが導入されているかどうかによって変わります。

表のリクエスト数の平均を求めるには、ユーザーがアプリケーション内で Place Autocomplete（従来版）の予測を選択するまでに、平均でどのくらいの文字数を入力するのかを分析します。

セッションベースの Place Autocomplete（従来版）と Place Details（従来版）

セッションベースの Place Autocomplete（従来版）と Place Details（従来版）を併用します。
アプリケーションで Place Details（従来版）（場所の名前、営業状況、営業時間など）が必要な場合、Place Autocomplete（従来版）の実装では、セッションごとにセッショントークン（プログラムまたは JavaScript、Android、iOS ウィジェットに組み込まれたもの）を使用し、リクエストする場所データフィールドに応じて、該当する Places Data SKU を使用する必要があります。¹

ウィジェット実装
セッション管理が JavaScript、Android、または iOS ウィジェットに自動的に組み込まれます。これには、選択された予測結果での Place Autocomplete（従来版）リクエストと Place Details（従来版）リクエストの両方が含まれます。必要な Place Autocomplete（従来版）のデータフィールドのみをリクエストするように、必ず fields パラメータを指定してください。

プログラマティック実装
Place Autocomplete（従来版）リクエストでセッショントークンを使用します。選択された予測結果に関する Place Details（従来版）をリクエストする際は、次のパラメータを含めます。

Place Autocomplete（従来版）レスポンスのプレイス ID
Place Autocomplete（従来版）リクエストで使用されるセッショントークン
必要な Place Autocomplete（従来版）のデータフィールドを指定する fields パラメータ

リクエストごとの Place Autocomplete（従来版）と Geocoding API

セッショントークンを使用せずにプログラムによって Place Autocomplete（従来版）を実装し、選択された場所の予測で Geocoding API を呼び出します。
Geocoding API は、住所と緯度 / 経度の座標を提供します。 Autocomplete - Per Request のリクエスト 4 件と、選択された場所予測に関する Geocoding API の呼び出しを合わせた料金は、Place Autocomplete（従来版）のセッション 1 回あたりの料金よりも少ないコストです。¹

パフォーマンスに関するベストプラクティスを導入し、できるだけ少ない入力文字数でユーザーが求める候補を提供できるようすることをおすすめします。

住所のみのアプリケーション向けのセッションベースの Place Autocomplete（従来版）

セッションベースの Place Autocomplete（従来版）と Place Details（従来版）を併用します。
ユーザーが Place Autocomplete（従来版）の予測を選択するまでに行うと予想されるリクエストの平均数が、セッションあたりの料金を上回るため、Place Autocomplete（従来版）の実装では、Place Autocomplete（従来版）リクエストと関連する Place Details（従来版）リクエストの両方で、セッションごとにセッショントークンを使用する必要があります。 ¹

ウィジェット実装
セッション管理が JavaScript、Android、または iOS ウィジェットに自動的に組み込まれます。これには、選択された予測結果での Place Autocomplete（従来版）リクエストと Place Details（従来版）リクエストの両方が含まれます。必要なフィールドのみをリクエストするように、必ず fields パラメータを指定してください。

Place Autocomplete（従来版）レスポンスのプレイス ID
Place Autocomplete（従来版）リクエストで使用されるセッショントークン
住所やジオメトリなどの基本データフィールドを指定する fields パラメータ

Place Autocomplete（従来版）リクエストを遅らせることを検討する
ユーザーが最初の 3 ～ 4 文字を入力するまで Place Autocomplete（従来版）リクエストを遅らせて、アプリケーションでのリクエスト数を減らすこともできます。たとえば、ユーザーが 3 文字目を入力した後に、1 文字入力されるごとに Place Autocomplete（従来版）リクエストを行う場合、ユーザーが 7 文字を入力してから予測を選択し、Geocoding API リクエストを 1 回行うと、合計費用は Place Autocomplete（従来版）Per Request 4 回分 + Geocoding 1 回分となります。¹

リクエストを遅らせることで、プログラマティックリクエストの回数を平均 4 回以下に抑えられる場合は、高パフォーマンスで Place Autocomplete（従来版）と Geocoding API を併用する実装に関するガイダンスをご覧ください。なお、リクエストを遅らせると、1 文字入力するたびに予測が表示されはずと考えているユーザーには、遅延と受けとられる場合もあります。

費用については、Google Maps Platform の料金表をご覧ください。

パフォーマンスに関するベストプラクティス

Place Autocomplete（従来版）のパフォーマンスを最適化するためのガイドラインは次のとおりです。

Place Autocomplete（従来版）実装に、国別のポリシー、場所のバイアス、言語設定（プログラマティック実装の場合）を追加します。ウィジェットはユーザーのブラウザやモバイルデバイスから言語設定を選択するため、ウィジェットでは言語設定は不要です。
Place Autocomplete（従来版）が地図に関連付けられている場合は、地図のビューポートを基準に場所にバイアスをかけることができます。
ユーザーがいずれかの Place Autocomplete（従来版）の予測入力候補を選択しなかった場合は（通常は目的の住所が候補に挙がらなかったことが原因）、ユーザーの元の入力内容を再利用して、より関連性の高い結果を取得できます。
- ユーザーが住所情報のみを入力することが予想される場合は、Geocoding API の呼び出しで、ユーザーの元の入力内容を再利用します。
- ユーザーが特定の場所に関する検索語句（名前や住所）を入力することが予想される場合は、Place Details（従来版）リクエストを使用します。特定の地域の結果のみが求められる場合は、場所のバイアスを使用します。
Geocoding API へのフォールバックが最適となるその他のシナリオは次のとおりです。
- ユーザーが、建物内の特定のユニットやアパートの住所など、サブプレミスの住所を入力している。たとえば、チェコ語の住所「Stroupežnického 3191/17, Praha」では、Place Autocomplete（従来版）で部分的な予測が生成されます。
- ユーザーがニューヨークの「23-30 29th St, Queens」や、ハワイのカウアイ島の「47-380 Kamehameha Hwy, Kaneohe」など、道路区間のプレフィックスを入力する場合。

位置情報のバイアス

location パラメータと radius パラメータを渡すことで、バイアスを設定し、指定した範囲内の結果を優先します。これにより、Place Autocomplete（従来版）は、定義されたエリア内の結果を優先的に表示します。指定した範囲外の結果が返されることもあります。includedRegionCodes パラメータを使用すると、指定した国内の場所のみを表示するように結果をフィルタできます。

警告: radius が指定されていない場合、location パラメータは無視されます。

検索エリアが広い場合、通常、施設の結果は検索結果に表示されるほど上位にランク付けされません。施設とジオコードが混在する結果に施設を表示する場合は、より小さい半径を指定できます。または、types=establishment を使用して、結果を施設のみに制限します。

ロケーションの制限

locationRestriction パラメータを渡して、結果を特定のエリアに制限します。

strictbounds パラメータを追加することで、location パラメータと radius パラメータで定義された地域に結果を制限することもできます。これにより、Place Autocomplete（従来版）は、その地域内の結果のみを返すようになります。

トラブルシューティング

さまざまなエラーが発生する可能性がありますが、アプリで発生する可能性が高いエラーのほとんどは、通常、構成エラー（間違った API キーが使用された、API キーが正しく構成されていないなど）または割り当てエラー（アプリが割り当てを超過した）が原因です。割り当ての詳細については、使用量上限をご覧ください。

予測入力コントロールの使用中に発生したエラーは、さまざまなデリゲートプロトコルの didFailAutocompleteWithError() メソッドで返されます。指定された NSError オブジェクトの code プロパティは、GMSPlacesErrorCode 列挙型の値のいずれかに設定されます。

Place Autocomplete（従来版） コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

予測入力 UI コントロールを追加する

全画面表示コントロールの追加

Swift

Objective-C

結果コントローラの追加

ナビゲーション バーに検索バーを追加する

Swift

Objective-C

ビューの上部に検索バーを追加する

Swift

Objective-C

Swift

Objective-C

ポップオーバー結果を使用して検索バーを追加する

Swift

Objective-C

テーブル データソースの使用

Swift

Objective-C

テキストと背景色のカスタマイズ

UIAppearance プロトコルの使用

UI コントロールのスタイル プロパティを設定する

プログラムで場所の予測を取得する

GMSPlacesClient findAutocompletePredictionsFromQuery: さんに発信しています

Swift

Objective-C

Swift

Objective-C

フェッチャーの使用

Swift

Objective-C

セッション トークン

使用量上限

アプリに帰属情報を表示する

ネットワーク アクティビティ インジケーターの制御

予測入力の結果を制限する

特定の地域を優先するよう結果にバイアスを設定する

結果を特定のリージョンに制限する

国で結果をフィルタする

場所のタイプまたはタイプ コレクションで検索結果をフィルタする

Place Autocomplete（従来版）の最適化

費用の最適化に関するヒント

基本的な費用の最適化

高度な費用の最適化

セッション ベースの Place Autocomplete（従来版）と Place Details（従来版）

リクエストごとの Place Autocomplete（従来版）と Geocoding API

住所のみのアプリケーション向けのセッション ベースの Place Autocomplete（従来版）

パフォーマンスに関するベスト プラクティス

位置情報のバイアス

ロケーションの制限

トラブルシューティング

Place Autocomplete（従来版）

ナビゲーションバーに検索バーを追加する

テーブルデータソースの使用

UI コントロールのスタイルプロパティを設定する

`GMSPlacesClient findAutocompletePredictionsFromQuery:` さんに発信しています

セッショントークン

ネットワークアクティビティインジケーターの制御

場所のタイプまたはタイプコレクションで検索結果をフィルタする

セッションベースの Place Autocomplete（従来版）と Place Details（従来版）

住所のみのアプリケーション向けのセッションベースの Place Autocomplete（従来版）

パフォーマンスに関するベストプラクティス