Nearby Search (New) リクエストは、検索する地域を円として入力します。円は、円の中心点の緯度と経度の座標、および半径（メートル単位）で定義されます。リクエストは、指定された検索エリア内の、一致する場所のリストを返します。各場所は Place オブジェクトで表されます。
デフォルトでは、レスポンスには検索エリア内のすべてのタイプの場所が含まれます。必要に応じて、レスポンスに明示的に含めるか除外する場所タイプのリストを指定して、レスポンスをフィルタできます。たとえば、レスポンスに「レストラン」、「パン屋」、「カフェ」のタイプの場所のみを含めるように指定したり、「学校」のタイプの場所をすべて除外するように指定したりできます。
Nearby Search（新規）リクエスト
PlacesClient.searchNearby を呼び出し、リクエスト パラメータを定義する SearchNearbyRequest オブジェクトを渡して、Nearby Search（新版）リクエストを作成します。
SearchNearbyRequest オブジェクトは、リクエストに必要なすべての必須パラメータとオプション パラメータを指定します。必須パラメータは次のとおりです。
Placeオブジェクトで返すフィールドのリスト。フィールド マスクとも呼ばれます。フィールド リストで 1 つ以上のフィールドを指定しない場合、またはフィールド リストを省略した場合、呼び出しはエラーを返します。- 検索エリアの位置制限。緯度と経度のペアと半径の値（メートル単位）で定義されます。
この近隣検索リクエストの例では、レスポンスの Place オブジェクトに、検索結果の各 Place オブジェクトのプレイス フィールド Place.Field.ID と Place.Field.DISPLAY_NAME が含まれるように指定しています。また、レスポンスをフィルタして、タイプが「restaurant」と「cafe」の場所のみを返し、「pizza_restaurant」と「american_restaurant」の場所を除外します。
// Define a list of fields to include in the response for each returned place. final List<Place.Field> placeFields = Arrays.asList(Place.Field.ID, Place.Field.DISPLAY_NAME); // Define the search area as a 1000 meter diameter circle in New York, NY. LatLng center = new LatLng(40.7580, -73.9855); CircularBounds circle = CircularBounds.newInstance(center, /* radius = */ 1000); // Define a list of types to include. final List<String> includedTypes = Arrays.asList("restaurant", "cafe"); // Define a list of types to exclude. final List<String> excludedTypes = Arrays.asList("pizza_restaurant", "american_restaurant"); // Use the builder to create a SearchNearbyRequest object. final SearchNearbyRequest searchNearbyRequest = SearchNearbyRequest.builder(/* location restriction = */ circle, placeFields) .setIncludedTypes(includedTypes) .setExcludedTypes(excludedTypes) .setMaxResultCount(10) .build()); // Call placesClient.searchNearby() to perform the search. // Define a response handler to process the returned List of Place objects. placesClient.searchNearby(searchNearbyRequest) .addOnSuccessListener(response -> { List<Place> places = response.getPlaces(); });
Nearby Search（新版）のレスポンス
SearchNearbyResponse クラスは、検索リクエストからのレスポンスを表します。SearchNearbyResponse オブジェクトには次の要素が含まれます。
- 一致するすべての場所を表す
Placeオブジェクトのリスト。一致する場所ごとに 1 つのPlaceオブジェクトがあります。 - 各
Placeオブジェクトには、リクエストで渡されたフィールド リストで定義されたフィールドのみが含まれます。
たとえば、リクエストでフィールド リストを次のように定義したとします。
// Define a list of fields to include in the response for each returned place. final List<Place.Field> placeFields = Arrays.asList(Place.Field.ID, Place.Field.NAME);
このフィールド リストは、レスポンス内の各 Place オブジェクトに、一致する各場所のプレイス ID と名前のみが含まれることを意味します。その後、Place.getId() メソッドと Place.getName() メソッドを使用して、各 Place オブジェクトのこれらのフィールドにアクセスできます。
Place オブジェクトのデータにアクセスする例については、Place オブジェクトのデータ フィールドにアクセスするをご覧ください。
必須パラメータ
SearchNearbyRequest オブジェクトを使用して、検索に必要なパラメータを指定します。
フィールド リスト
Place Details をリクエストする際は、場所の
Placeオブジェクトで、返すデータをフィールド マスクとして指定する必要があります。フィールド マスクを定義するには、Place.FieldからSearchNearbyRequestオブジェクトに値の配列を渡します。フィールド マスキングは、不要なデータをリクエストしないようにするための優れた設計手法です。これにより、不要な処理時間と課金を回避できます。次のフィールドを 1 つ以上指定します。
次のフィールドは、Nearby Search Pro SKU をトリガーします。
Place.Field.ADDRESS_COMPONENTS
Place.Field.BUSINESS_STATUS
Place.Field.ADDRESS
Place.Field.DISPLAY_NAME>*
* 非推奨のPlace.Field.NAMEの代わりに使用します。
Place.Field.ICON_BACKGROUND_COLOR
Place.Field.ICON_MASK_URL*
* 非推奨のPlace.Field.ICON_URLの代わりに使用します。
Place.Field.ID
Place.Field.LAT_LNG
Place.Field.PHOTO_METADATAS
Place.Field.PLUS_CODE
Place.Field.PRIMARY_TYPE
Place.Field.PRIMARY_TYPE_DISPLAY_NAME
Place.Field.RESOURCE_NAME
Place.Field.TYPES
Place.Field.UTC_OFFSET
Place.Field.VIEWPORT
Place.Field.WHEELCHAIR_ACCESSIBLE_ENTRANCE次のフィールドは、Nearby Search Enterprise SKU をトリガーします。
Place.Field.CURRENT_OPENING_HOURS
Place.Field.CURRENT_SECONDARY_OPENING_HOURS
Place.Field.INTERNATIONAL_PHONE_NUMBER*
* 非推奨のPlace.Field.PHONE_NUMBERの代わりに使用します。
Place.Field.NATIONAL_PHONE_NUMBER
Place.Field.OPENING_HOURS
Place.Field.PRICE_LEVEL
Place.Field.RATING
Place.Field.SECONDARY_OPENING_HOURS
Place.Field.USER_RATING_COUNT*
* 非推奨のPlace.Field.USER_RATINGS_TOTALの代わりに使用します。
Place.Field.WEBSITE_URI次のフィールドは、Nearby Search Enterprise Plus SKU をトリガーします。
Place.Field.ALLOWS_DOGS
Place.Field.CURBSIDE_PICKUP
Place.Field.DELIVERY
Place.Field.DINE_IN
Place.Field.EDITORIAL_SUMMARY
Place.Field.EV_CHARGE_OPTIONS
Place.Field.FUEL_OPTIONS
Place.Field.GOOD_FOR_CHILDREN
Place.Field.GOOD_FOR_GROUPS
Place.Field.GOOD_FOR_WATCHING_SPORTS
Place.Field.LIVE_MUSIC
Place.Field.MENU_FOR_CHILDREN
Place.Field.OUTDOOR_SEATING
Place.Field.PARKING_OPTIONS
Place.Field.PAYMENT_OPTIONS
Place.Field.RESERVABLE
Place.Field.RESTROOM
Place.Field.REVIEWS
Place.Field.SERVES_BEER
Place.Field.SERVES_BREAKFAST
Place.Field.SERVES_BRUNCH
Place.Field.SERVES_COCKTAILS
Place.Field.SERVES_COFFEE
Place.Field.SERVES_DESSERT
Place.Field.SERVES_DINNER
Place.Field.SERVES_LUNCH
Place.Field.SERVES_VEGETARIAN_FOOD
Place.Field.SERVES_WINE
Place.Field.TAKEOUT
フィールド リスト パラメータを設定するには、
SearchNearbyRequestオブジェクトを作成するときにsetPlaceFields()メソッドを呼び出します。次の例では、リクエストによって返される
PlaceオブジェクトにPlace.Field.IDフィールドとPlace.Field.DISPLAY_NAMEフィールドが含まれることを指定する 2 つのフィールド値のリストを定義します。
// Define a list of fields to include in the response for each returned place. final List<Place.Field> placeFields = Arrays.asList(Place.Field.ID, Place.Field.DISPLAY_NAME);
地域の制限
検索する領域を定義する
LocationRestrictionオブジェクト。円として指定され、中心点と半径（メートル単位）で定義されます。半径は 0.0 より大きく 50000.0 以下にする必要があります。半径が小さすぎると、レスポンスとしてZERO_RESULTSが返されることに注意してください。位置情報の制限パラメータを設定するには、
SearchNearbyRequestオブジェクトをビルドするときにsetLocationRestriction()メソッドを呼び出します。
オプション パラメータ
SearchNearbyRequest オブジェクトを使用して、検索のオプション パラメータを指定します。
-
タイプとプライマリ タイプ
検索結果のフィルタリングに使用されるタイプ 表 A のタイプの一覧を指定できます。各型制限カテゴリで指定できる型は最大 50 個です。
1 つの場所に関連付けることができるプライマリ タイプは、表 A のタイプから 1 つのみです。たとえば、プライマリ タイプは
"mexican_restaurant"または"steak_house"になります。includedPrimaryTypesとexcludedPrimaryTypesを使用して、場所のメインタイプで結果をフィルタします。場所には、テーブル A のタイプから複数のタイプ値を関連付けることもできます。たとえば、レストランには
"seafood_restaurant"、"restaurant"、"food"、"point_of_interest"、"establishment"などのタイプがあります。includedTypesとexcludedTypesを使用して、場所に関連付けられたタイプのリストで結果をフィルタします。"restaurant"や"hotel"などの一般的なプライマリ タイプを指定すると、レスポンスには、指定したプライマリ タイプよりも具体的なプライマリ タイプを持つ場所が含まれることがあります。たとえば、"restaurant"のプライマリ タイプを含めるように指定します。レスポンスには、主なタイプが"restaurant"の場所を含めることができますが、"chinese_restaurant"や"seafood_restaurant"など、より具体的な主なタイプの場所を含めることもできます。複数のタイプの制限を指定して検索した場合、すべての制限を満たす場所のみが返されます。たとえば、
includedTypes = Arrays.asList("restaurant")とexcludedPrimaryTypes = Arrays.asList("steak_house")を指定した場合、返される場所は"restaurant"関連のサービスを提供しますが、主に"steak_house"として運営されていません。includedTypesとexcludedTypesの使用例については、Nearby Search（新版）リクエストをご覧ください。含まれるタイプ
検索するテーブル A の場所タイプのリスト。このパラメータを省略すると、すべてのタイプの場所が返されます。
含まれる型のパラメータを設定するには、
SearchNearbyRequestオブジェクトをビルドするときにsetIncludedTypes()メソッドを呼び出します。除外するタイプ
検索から除外するテーブル A の場所タイプのリスト。
リクエストで
includedTypes（"school"など）とexcludedTypes（"primary_school"など）の両方を指定すると、レスポンスには"school"に分類されるが"primary_school"には分類されない場所が含まれます。レスポンスには、includedTypesのうちの少なくとも 1 つと一致し、excludedTypesのうちのいずれとも一致しない場所が含まれます。includedTypesとexcludedTypesの両方に表示される型など、競合する型がある場合は、INVALID_REQUESTエラーが返されます。除外するタイプのパラメータを設定するには、
SearchNearbyRequestオブジェクトを作成するときにsetExcludedTypes()メソッドを呼び出します。含まれるプライマリ タイプ
検索に含める テーブル A の主要な場所タイプのリスト。
含まれるプライマリ タイプ パラメータを設定するには、
SearchNearbyRequestオブジェクトをビルドするときにsetIncludedPrimaryTypes()メソッドを呼び出します。除外されるプライマリ タイプ
検索から除外するテーブル A の主要な場所タイプのリスト。
includedPrimaryTypesとexcludedPrimaryTypesの両方に表示されるタイプなど、競合するプライマリ タイプがある場合は、INVALID_ARGUMENTエラーが返されます。除外するプライマリ タイプ パラメータを設定するには、
SearchNearbyRequestオブジェクトを作成するときにsetExcludedPrimaryTypes()メソッドを呼び出します。 -
結果の最大数
返される場所の結果の最大数を指定します。1 ～ 20（デフォルト）の範囲で指定する必要があります。
最大結果数パラメータを設定するには、
SearchNearbyRequestオブジェクトのビルド時にsetMaxResultCount()メソッドを呼び出します。 -
ランクの優先度
使用するランキングのタイプ。このパラメータを省略すると、結果は人気度でランク付けされます。次のいずれかになります。
POPULARITY（デフォルト）人気度に基づいて結果を並べ替えます。DISTANCE: 指定された場所からの距離に応じて結果を昇順で並べ替えます。
ランク優先度パラメータを設定するには、
SearchNearbyRequestオブジェクトをビルドするときにsetRankPreference()メソッドを呼び出します。 -
地域コード
レスポンスのフォーマットに使用される地域コード。 2 文字の CLDR コード値として指定します。デフォルト値はありません。
レスポンスの
FORMATTED_ADDRESSフィールドの国名がregionCodeと一致する場合、国コードはFORMATTED_ADDRESSから省略されます。大半の CLDR コードは ISO 3166-1 コードと同一ですが、いくつか注意が必要な例外もあります。たとえば、英国の ccTLD は「uk」（.co.uk）ですが、ISO 3166-1 コードは「gb」（厳密には「グレートブリテンおよび北アイルランド連合王国」のエンティティ用）です。このパラメータは、適用される法律に基づいて結果に影響を与える可能性があります。
地域コード パラメータを設定するには、
SearchNearbyRequestオブジェクトを作成するときにsetRegionCode()メソッドを呼び出します。
アプリに属性を表示する
アプリで PlacesClient から取得した情報（写真やクチコミなど）を表示する場合、必要な帰属情報も表示する必要があります。
詳しくは、Places SDK for Android のポリシーをご覧ください。