テキスト検索（新版）

プラットフォームを選択: Android iOS JavaScript ウェブサービス

欧州経済領域（EEA）のデベロッパー

テキスト検索（新版）は、「渋谷ピザショップ」「表参道靴店」「123 番地」といった文字列に対して、場所のセットについての情報を返します。テキスト文字列と、その時点で設定済みの地域バイアスをもとに、場所のリストを返すサービスです。

テキスト検索（新版）では、必須パラメータに加えて、オプションパラメータを使用してクエリを絞り込むことで、より良い結果を得ることができます。

テキスト検索で場所のリストを取得する

GMSPlacesClient searchByTextWithRequest: を呼び出してテキスト検索リクエストを作成し、リクエストパラメータとレスポンスを処理するコールバックメソッド（ GMSPlaceSearchByTextResultCallback 型）を定義する GMSPlaceSearchByTextRequest オブジェクトを渡します。

GMSPlaceSearchByTextRequest オブジェクトは、リクエストに必要なパラメータとオプションパラメータをすべて指定します。必須パラメータは次のとおりです。

GMSPlace オブジェクトで返されるフィールドのリスト。フィールドマスクとも呼ばれます。GMSPlaceProperty で定義されます。フィールドリストで 1 つ以上のフィールドを指定しない場合、またはフィールドリストを省略した場合、呼び出しはエラーを返します。
テキストクエリ。

このテキスト検索リクエストの例では、レスポンスの GMSPlace オブジェクトに、検索結果の各 GMSPlace オブジェクトの場所名とプレイス ID が含まれるように指定しています。また、レスポンスをフィルタして、「レストラン」タイプの場所のみを返すようにしています。

Places Swift SDK

let restriction = GMSPlaceRectangularLocationOption(
      northEast: CLLocationCoordinate2D(latitude: 20, longitude: 30),
      southWest: CLLocationCoordinate2D(latitude: 40, longitude: 50)
)
let searchByTextRequest = SearchByTextRequest(
        textQuery: "pizza in New York",
        placeProperties: [ .name, .placeID ],
        locationRestriction: restriction,
        includedType: .restaurant,
        maxResultCount: 5,
        minRating: 3.5,
        priceLevels: [ .moderate, .inexpensive ],
        isStrictTypeFiltering: true
)
switch await placesClient.searchByText(with: searchByTextRequest) {
case .success(let places):
  // Handle places
case .failure(let placesError):
  // Handle error
}

Swift

// Create the GMSPlaceSearchByTextRequest object.
let myProperties = [GMSPlaceProperty.name, GMSPlaceProperty.placeID].map {$0.rawValue}
let request = GMSPlaceSearchByTextRequest(textQuery:"pizza in New York", placeProperties:myProperties)
request.isOpenNow = true
request.includedType = "restaurant"
request.maxResultCount = 5
request.minRating = 3.5
request.rankPreference = .distance
request.isStrictTypeFiltering = true
request.locationBias =  GMSPlaceCircularLocationOption(CLLocationCoordinate2DMake(40.7, -74.0), 200.0)

// Array to hold the places in the response
var placeResults: [GMSPlace] = []

let callback: GMSPlaceSearchByTextResultCallback = { [weak self] results, error in
  guard let self, error == nil else {
    if let error {
      print(error.localizedDescription)
    }
    return
  }
  guard let results = results as? [GMSPlace] else {
    return
  }
  placeResults = results
}

GMSPlacesClient.shared().searchByText(with: request, callback: callback)

Objective-C

// Create the GMSPlaceSearchByTextRequest object.
GMSPlaceSearchByTextRequest *request =
    [[GMSPlaceSearchByTextRequest alloc] initWithTextQuery:@"pizza in New York" placeProperties:@[GMSPlacePropertyName, GMSPlacePropertyPlaceID]];
request.isOpenNow = YES;
request.includedType = @"restaurant";
request.maxResultCount = 5;
request.minRating = 3.5;
request.rankPreference = GMSPlaceSearchByTextRankPreferenceDistance;
request.isStrictTypeFiltering = YES;
request.priceLevels = @[ @(kGMSPlacesPriceLevelFree), @(kGMSPlacesPriceLevelCheap) ];
request.locationBias = GMSPlaceCircularLocationOption(CLLocationCoordinate2DMake(40.7, -74.0), 200.0);

// Array to hold the places in the response
_placeResults = [NSArray array];

// Create the GMSPlaceSearchByTextRequest object.
[_placesClient searchByTextWithRequest:request
    callback:^(NSArray<GMSPlace *> *_Nullable placeResults, NSError * _Nullable error) {
      if (error != nil) {
        NSLog(@"An error occurred %@", [error localizedDescription]);
        return;
      } else {
        if (placeResults.count > 0) {
          // Get list of places.
          _placeResults = placeResults;
      }
    }
  }
];

テキスト検索のレスポンス

テキスト検索 API は、一致する場所ごとに 1 つの GMSPlace オブジェクトを含む、一致する場所の配列を形式で GMSPlace オブジェクトで返します。

注: レスポンスの GMSPlace オブジェクトのフィールドを空にすることはできません。たとえば、フィールドリストに GMSPlacePropertyPhotos を含めてレスポンスで photos フィールドをリクエストしても、レスポンスの photos フィールドが空の場合、レスポンスの GMSPlace オブジェクトから省略されます。

営業ステータスを取得する

GMSPlacesClient オブジェクトには、isOpenWithRequest というメンバー関数（Swift では isOpenRequest、GooglePlacesSwift では isPlaceOpenRequest）が含まれています。この関数は、呼び出しで指定された時間に基づいて、場所が現在営業中かどうかを示すレスポンスを返します。

注: 非推奨の GMSPlace isOpen: 関数と GMSPlace isOpenAtDate: 関数は正確でない可能性があり、Places API（New）での使用は想定されていません。

このメソッドは、次のものを含む GMSPlaceIsOpenWithRequest 型の単一の引数を受け取ります。

A GMSPlace オブジェクト、またはプレイス ID を指定する文字列。必要なフィールドを含む Place オブジェクトの作成について詳しくは、Place Details をご覧ください。

注: Place オブジェクトには有効なプレイス ID が含まれている必要があります。
確認する時間を指定するオプションの NSDate（Obj-C）または Date（Swift）オブジェクト。時間を指定しない場合、デフォルトは現在です。
レスポンスを処理する GMSPlaceOpenStatusResponseCallback メソッド。

GMSPlaceIsOpenWithRequest メソッドでは、GMSPlace オブジェクトに次のフィールドを設定する必要があります:

GMSPlacePropertyUTCOffsetMinutes
GMSPlacePropertyBusinessStatus
GMSPlacePropertyOpeningHours
GMSPlacePropertyCurrentOpeningHours
GMSPlacePropertySecondaryOpeningHours

これらのフィールドが Place オブジェクトに指定されていない場合、またはプレイス ID を渡した場合、メソッドは GMSPlacesClient GMSFetchPlaceRequest: を使用してフィールドを取得します。

`isOpenWithRequest` のレスポンス

isOpenWithRequest は、ビジネスが営業中か、休業中か、ステータスが不明かを示すブール値 status を含む GMSPlaceIsOpenResponse オブジェクトを返します。

言語	営業中の場合の値	休業中の場合の値	ステータスが不明な場合の値
Places Swift	`true`	`false`	`nil`
Swift	`.open`	`.closed`	`.unknown`
Objective-C	`GMSPlaceOpenStatusOpen`	`GMSPlaceOpenStatusClosed`	`GMSPlaceOpenStatusUnknown`

`isOpenWithRequest` の課金

GMSPlacePropertyUTCOffsetMinutes フィールドと GMSPlacePropertyBusinessStatus フィールドは、Basic Data SKU で課金されます。その他の営業時間については、Place Details Enterprise SKU で課金されます。
以前のリクエストで GMSPlace オブジェクトにこれらのフィールドがすでに含まれている場合、再度課金されることはありません。
警告 GMSPlace オブジェクトにこれらのフィールドが含まれていない場合、再度 Basic Data SKU の料金が課金されます。その他の営業時間については、Place Details Enterprise SKU で課金されます。プロジェクトで isOpenWithRequest を使用する場合は、必要な Place Details を取得することをおすすめします。

例: `GMSPlaceIsOpenWithRequest` リクエストを作成する

次の例は、既存の GMSPlace オブジェクト内で GMSPlaceIsOpenWithRequest を初期化する方法を示しています。

Places Swift SDK

        let isOpenRequest = IsPlaceOpenRequest(place: place)
        switch await placesClient.isPlaceOpen(with: isOpenRequest) {
          case .success(let isOpenResponse):
            switch isOpenResponse.status {
              case true:
                // Handle open
              case false:
                // Handle closed
              case nil:
                // Handle unknown
          case .failure(let placesError):
            // Handle error
        }

Swift

    let isOpenRequest = GMSPlaceIsOpenRequest(place: place, date: nil)
      GMSPlacesClient.shared().isOpen(with: isOpenRequest) { response, error in
        if let error = error {
          // Handle Error
        }
        switch response.status {
          case .open:
            // Handle open
          case .closed:
            // Handle closed
          case .unknown:
            // Handle unknown
        }
      }

Objective-C

          GMSPlaceIsOpenRequest *isOpenRequest = [[GMSPlaceIsOpenRequest alloc] initWithPlace:place date:nil];

          [[GMSPlacesClient sharedClient] isOpenWithRequest:isOpenRequest callback:^(GMSPlaceIsOpenResponse response, NSError *_Nullable error) {
            if (error) {
              // Handle error
            }

            switch (response.status) {
              case GMSPlaceOpenStatusOpen:
                // Handle open
              case GMSPlaceOpenStatusClosed:
                // Handle closed
              case GMSPlaceOpenStatusUnknown:
                // Handle unknown
            }
          }];

ページネーション

テキスト検索では、ページネーションオブジェクト（ hasNextPage ブール値）が提供されます。これは、テキスト検索呼び出しに対する最初のレスポンスで返されます。次のページがある場合は、fetchNextPage() 関数を使用して読み込むことができます。

次の例は、次のページがあるかどうかを確認し、ページを読み込む方法を示しています。

Swift

public struct PlaceSearchPagination {
  public var pageSize: Int
  public var hasNextPage: Bool
  public func fetchNextPage() async -> SearchByTextResponse
}

public struct SearchByTextResponse {
  public var pagination: PlaceSearchPagination?
  public var places: [Place]?
  public var error: PlaceError?
}

PlacesClient.swift
public func searchByText(with request: SearchByTextRequest) async -> SearchByTextResponse

let searchByTextRequest = SearchByTextRequest(textQuery: "restaurants",
    placeProperties: [PlaceProperty.displayName],
    locationBias: CircularCoordinateRegion(center: CLLocationCoordinate2D(latitude: 0, longitude: 0), radius: 100))

searchByTextRequest.maxResultCount = 10

var searchByTextResponse = await PlacesClient.shared.searchByText(with: searchByTextRequest)
print("Found \(searchByTextResponse.places.count) places")

searchByTextResponse.pagination.pageSize = 20

// Continue making requests until no more results are found in pagination object
while searchByTextResponse.pagination.hasNextPage {
    searchByTextResponse = await searchByTextResponse.pagination.fetchNextPage()
    print("Found \(searchByTextResponse.places.count) places")
}

Objective-C

GMSPlaceSearchByTextRequest *searchByTextRequest = [[GMSPlaceSearchByTextRequest alloc]
    initWithTextQuery: @"restaurants"
    placeProperties: @[GMSPlacePropertyAll]];

searchByTextRequest.maxResultCount = 10;

__block void (^recursiveCallback)(GMSPlaceSearchByTextResponse *, NSError *);
recursiveCallback = ^(GMSPlaceSearchByTextResponse * response, NSError* error) {
    NSLog(@"Found %d places", response.places.count);
    if (response.pagination.hasNextPage) {
      [response.pagination fetchNextPageWithCompletion:recursiveCallback];
   }
};
[GMSPlacesClient.sharedClient searchByTextWithRequest:searchByTextRequest  
                                           completion:recursiveCallback];

必須パラメータ

GMSPlaceSearchByTextRequest オブジェクトを使用して、検索に必要なパラメータを指定します。

フィールドリスト

返す Place Data プロパティを指定します。返すデータフィールドを指定する GMSPlace プロパティのリストを渡します。フィールドマスクを省略すると、リクエストはエラーを返します。

フィールドリストは、不要なデータをリクエストしないようにするための優れた設計手法です。これにより、不要な処理時間や課金が発生するのを防ぐことができます。

次のフィールドを 1 つ以上指定します。
- 次のフィールドは、テキスト検索の基本事項 ID Only SKU をトリガーします。
  GMSPlacePropertyPlaceID
- 次のフィールドは、テキスト検索 Pro SKU をトリガーします。
  GMSPlacePropertyAddressComponents
  GMSPlacePropertyBusinessStatus
  GMSPlacePropertyCoordinate
  GMSPlacePropertyFormattedAddress
  GMSPlacePropertyIconBackgroundColor
  GMSPlacePropertyIconImageURL
  GMSPlacePropertyName
  GMSPlacePropertyPhotos
  GMSPlacePropertyPlusCode
  GMSPlacePropertyTypes
  GMSPlacePropertyUTCOffsetMinutes
  GMSPlacePropertyViewport
  GMSPlacePropertyWheelchairAccessibleEntrance
- 次のフィールドは、テキスト検索 Enterprise SKU をトリガーします。
  GMSPlacePropertyCurrentOpeningHours
  GMSPlacePropertySecondaryOpeningHours
  GMSPlacePropertyPhoneNumber
  GMSPlacePropertyPriceLevel
  GMSPlacePropertyRating
  GMSPlacePropertyOpeningHours
  GMSPlacePropertyUserRatingsTotal
  GMSPlacePropertyWebsite
- 次のフィールドは、テキスト検索 Enterprise Plus SKU をトリガーします。
  GMSPlacePropertyCurbsidePickup
  GMSPlacePropertyDelivery
  GMSPlacePropertyDineIn
  GMSPlacePropertyEditorialSummary
  GMSPlacePropertyReservable
  GMSPlacePropertyReviews
  GMSPlacePropertyServesBeer
  GMSPlacePropertyServesBreakfast
  GMSPlacePropertyServesBrunch
  GMSPlacePropertyServesDinner
  GMSPlacePropertyServesLunch
  GMSPlacePropertyServesVegetarianFood
  GMSPlacePropertyServesWine
  GMSPlacePropertyTakeout
textQuery

検索するテキスト文字列（「レストラン」、「123 番通り」、「サンフランシスコのおすすめスポット」など）です。

注: 電話番号で検索する際に最適な結果を得るには、国コードの後にスペースを入力し、 regionCode パラメータを国コードに対応するように設定します。電話番号の形式は国によって異なり、API はこれらのさまざまな形式の結果を返そうとします。有効な電話番号の場合、Places API（New）は E.164 形式をサポートしています。アルファベット文字は、 E.161 キーパッドマッピングに基づいて変換されます。

オプションパラメータ

GMSPlaceSearchByTextRequest オブジェクトを使用して、検索のオプションパラメータを指定します。

includedType

結果を、表 A で定義された指定したタイプに一致する場所に制限します。指定できるタイプは 1 つだけです。次に例を示します。
- let request = SearchByTextRequest() request.includedType = "bar"
- let request = SearchByTextRequest() request.includedType = "pharmacy"
注: 表 B の値はレスポンスでのみ返されます。表 B の値をフィルタとして使用することはできません。
isOpenNow

true の場合、クエリが送信された時点で営業している場所のみを返します。 `false` の場合、営業ステータスに関係なくすべてのビジネスを返します。このパラメータを false に設定すると、Google プレイスのデータベースに営業時間が指定されていない場所が返されます。
isStrictTypeFiltering

includeType パラメータとともに使用します。`true` に設定すると、 true `includeType` で指定されたタイプに一致する場所のみが返されます。 includeTypeデフォルトの false の場合、レスポンスには指定したタイプに一致しない場所が含まれることがあります。
locationBias

検索する領域を指定します。この場所はバイアスとして機能します。つまり、指定した場所の周辺の結果が返される可能性があります。指定した領域外の結果も含まれます。

locationRestriction または locationBias を指定できますが、両方は指定できません。locationRestriction は結果が収まる必要のあるリージョンを指定し、locationBias は結果が近くにある必要のあるリージョンを指定しますが、領域外にすることもできます。

注: locationBias と locationRestriction の両方を省略すると、API はデフォルトで IP バイアスを使用します。IP バイアスを使用すると、API はデバイスの IP アドレスを使用して結果にバイアスをかけます。

注: locationBias パラメータは textQuery に Market in Barcelona などの明示的な場所が含まれている場合、オーバーライドできます。この場合、locationBias は無視されます。
リージョンを矩形のビューポートまたは円として指定します。
- 円は、中心点と半径（メートル単位）で定義されます。半径は 0.0 ～ 50000.0 の範囲で指定してください。デフォルトの半径は 0.0 です。次に例を示します。
```
let request = SearchByTextRequest()
request.locationBias =  GMSPlaceCircularLocationOption(CLLocationCoordinate2DMake(40.7, -74.0), 200.0)
```
- 長方形は緯度経度のビューポートで、対角線上の 2 つの低点と高点で表されます。低点は長方形の南西隅を示し、高点は長方形の北東隅を表します。
  
  ビューポートは閉じた領域と見なされます。つまり、境界が含まれます。緯度の範囲は -90 ～ 90 度、経度の範囲は -180 ～ 180 度にする必要があります。
  - low = high の場合、ビューポートはその 1 点で構成されます。
  - low.longitude > high.longitude の場合、経度の範囲が反転します（ビューポートが 180 度の経度線を越えます）。
  - low.longitude = -180 度、 high.longitude = 180 度の場合、ビューポートにはすべての経度が含まれます。
  - low.longitude = 180 度、 high.longitude = -180 度の場合、経度の範囲は空になります。
  - low.latitude > high.latitude の場合、緯度の範囲は空になります。
locationRestriction

検索する領域を指定します。指定した領域外の結果は返されません。リージョンを矩形のビューポートとして指定します。ビューポートの定義については、 locationBias の説明をご覧ください。

locationRestriction または locationBias を指定できますが、両方は指定できません。locationRestriction は結果が収まる必要のあるリージョンを指定し、locationBias は結果が近くにある必要のあるリージョンを指定しますが、領域外にすることもできます。

注: locationBias と locationRestriction の両方を省略すると、API はデフォルトで IP バイアスを使用します。IP バイアスを使用すると、API はデバイスの IP アドレスを使用して結果にバイアスをかけます。
maxResultCount

返される場所の結果の最大数を指定します。1 ～ 20（デフォルト）の範囲で指定してください。
minRating

結果を、ユーザーの評価の平均がこの上限以上のものに限定します。値は 0.0 ～ 5.0 の範囲で、 0.5 刻みで指定してください。例: 0、0.5、1.0、...、5.0。値は最も近い 0.5 に切り上げられます。たとえば、値が 0.6 の場合、評価が 1.0 未満の結果はすべて除外されます。
priceLevels

検索を、特定の価格帯でマークされている場所に制限します。デフォルトでは、すべての価格帯が選択されます。

PriceLevel で定義された値の 1 つ以上の配列を指定します。

注: PRICE_LEVEL_FREE はリクエストで使用できません。レスポンスの入力にのみ使用されます。

次に例を示します。
```
    let request = SearchByTextRequest()
    request.priceLevels = [GMSPlacesPriceLevel.moderate.rawValue, GMSPlacesPriceLevel.cheap.rawValue]
```
rankPreference

クエリのタイプに基づいて、レスポンスで結果をランク付けする方法を指定します。
- 「ニューヨーク市のレストラン」などのカテゴリクエリの場合、 .relevance（検索の関連性で結果をランク付け）がデフォルトです。 rankPreference を .relevance または .distance（距離で結果をランク付け）に設定できます。
- 「Mountain View, CA」などのカテゴリ以外のクエリの場合は、 `rankPreference` を設定しないことをおすすめします。rankPreference
regionCode

レスポンスのフォーマットに使用するリージョンコード。 2 文字の CLDR コード値として指定します。このパラメータは、検索結果にバイアスをかけることもできます。デフォルト値はありません。

レスポンスのアドレスフィールドの国名がリージョンコードと一致する場合、国コードはアドレスから省略されます。

ほとんどの CLDR コードは ISO 3166-1 コードと同一ですが、いくつか注意が必要な例外もあります。たとえば、イギリスの ccTLD は「uk」（.co.uk）ですが、ISO 3166-1 コードは「gb」（厳密には「グレートブリテンおよび北アイルランド連合王国」のエンティティ用）です。このパラメータは、適用される法律に基づいて結果に影響を与える可能性があります。

shouldIncludePureServiceAreaBusinesses

true の場合、検索結果に純粋な非店舗型ビジネスを返します。純粋な非店舗型ビジネスとは、客先に出向いてサービスを提供し、ビジネス拠点の住所では接客しないビジネスです。

次に例を示します。

Places Swift SDK

let request = SearchByTextRequest()
request.shouldIncludePureServiceAreaBusinesses = true

Swift

let request = SearchByTextRequest()
request.shouldIncludePureServiceAreaBusinesses: true

Objective-C

GMSPlaceSearchByTextRequest *request =
    [[GMSPlaceSearchByTextRequest alloc] initWithTextQuery:@"pizza in New York" placeProperties:@[GMSPlacePropertyAll]];
request.shouldIncludePureServiceAreaBusinesses = YES;

アプリに属性を表示する

アプリで GMSPlacesClientから取得した情報（写真やクチコミなど）を表示する場合は、必要な帰属情報も表示する必要があります。

たとえば、reviews オブジェクトの GMSPlacesClient プロパティには、最大 5 つの GMSPlaceReview オブジェクトの配列が含まれています。各 GMSPlaceReview オブジェクトには、帰属情報と著作者の帰属情報を含めることができます。アプリでクチコミを表示する場合は、帰属情報または著作者の帰属情報も表示する必要があります。

詳細については、帰属情報に関するドキュメントをご覧ください。

テキスト検索（新版） コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

テキスト検索で場所のリストを取得する

Places Swift SDK

Swift

Objective-C

テキスト検索のレスポンス

営業ステータスを取得する

isOpenWithRequest のレスポンス

isOpenWithRequest の課金

例: GMSPlaceIsOpenWithRequest リクエストを作成する

Places Swift SDK

Swift

Objective-C

ページネーション

Swift

Objective-C

必須パラメータ

フィールド リスト

textQuery

オプション パラメータ

includedType

isOpenNow

isStrictTypeFiltering

locationBias

locationRestriction

maxResultCount

minRating

priceLevels

rankPreference

regionCode

shouldIncludePureServiceAreaBusinesses

Places Swift SDK

Swift

Objective-C

アプリに属性を表示する

テキスト検索（新版）

`isOpenWithRequest` のレスポンス

`isOpenWithRequest` の課金

例: `GMSPlaceIsOpenWithRequest` リクエストを作成する

フィールドリスト

オプションパラメータ