Text Search（新版）は、「渋谷のラーメン」、「吉祥寺周辺の靴屋」、「東京都港区六本木 6-10-1」などの文字列に基づいて一連の場所情報を返します。このサービスは、テキスト文字列や場所の優先度設定と合致するプレイスのリストをレスポンスとして返します。
このサービスは、自動システムであいまいな住所をクエリする場合に特に便利です。文字列の住所以外の構成要素を、店舗や住所と照合できます。あいまいな住所のクエリには、不適切な形式の住所、店舗名など住所以外の要素を含むリクエストなどがあります。次の表の最初の 2 つの例のようなリクエストでは、地域、位置情報の制限、位置情報のバイアスなどの位置情報が設定されていない限り、結果がゼロになることがあります。
| 「10 High Street, UK」または「123 Main Street, US」 | 英国では複数の「High Street」、米国では複数の「Main Street」が存在します。 位置情報の制限が設定されていない限り、クエリで望ましい結果が返されません。 |
| 「ChainRestaurant New York」 | ニューヨークに複数の「ChainRestaurant」の店舗があり、住所や通りの名前が指定されていない。 |
| 「10 High Street, Escher UK」または「123 Main Street, Pleasanton US」 | 英国の Escher 市には「High Street」が 1 つしかなく、米国の Pleasanton CA 市には「Main Street」が 1 つしかありません。 |
| 「UniqueRestaurantName New York」 | ニューヨークにこの名前の施設は 1 か所のみです。区別するために住所は必要ありません。 |
| 「ニューヨークのピザレストラン」 | このクエリには場所の制限が含まれており、「ピザレストラン」は明確に定義された場所のタイプです。複数の結果が返されます。 |
| 「+1 514-670-8700」 | このクエリには電話番号が含まれています。その電話番号に関連付けられている場所の複数の結果が返されます。 |
API Explorer では、ライブ リクエストを実行して、API と API オプションを把握できます。
Text Search リクエスト
テキスト検索リクエストは、次の形式の HTTP POST リクエストです。
https://places.googleapis.com/v1/places:searchText
すべてのパラメータを JSON リクエスト本文またはヘッダーで POST リクエストの一部として渡します。次に例を示します。
curl -X POST -d '{
"textQuery" : "Spicy Vegetarian Food in Sydney, Australia"
}' \
-H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \
-H 'X-Goog-FieldMask: places.displayName,places.formattedAddress,places.priceLevel' \
'https://places.googleapis.com/v1/places:searchText'Text Search（新版）のレスポンス
テキスト検索（新規）は、 レスポンスとして JSON オブジェクトを返します。レスポンスの説明:
places配列には、一致するすべての場所が含まれます。- 配列内の各場所は、
Placeオブジェクトで表されます。Placeオブジェクトには、単一のプレイスに関する詳細情報が含まれます。 - リクエストで渡された FieldMask には、
Placeオブジェクトで返されるフィールドのリストが指定されます。
完全な JSON オブジェクトの形式は次のとおりです。
{
"places": [
{
object (Place)
}
]
}必須パラメータ
-
FieldMask
レスポンス フィールド マスクを作成して、レスポンスで返すフィールドのリストを指定します。URL パラメータ
$fieldsまたはfieldsを使用するか、HTTP ヘッダーX-Goog-FieldMaskを使用して、レスポンス フィールド マスクをメソッドに渡します。レスポンスで返されるフィールドのデフォルト リストはありません。フィールドマスクを省略すると、メソッドからエラーが返されます。フィールド マスキングは、不要なデータをリクエストしないようにするための優れた設計手法です。これにより、不要な処理時間と課金が発生するのを防ぐことができます。
返すプレイスデータの種類をカンマ区切りのリストで指定します。たとえば、場所の表示名と住所を取得します。
X-Goog-FieldMask: places.displayName,places.formattedAddress
すべてのフィールドを取得するには、
*を使用します。X-Goog-FieldMask: *
次のフィールドを 1 つ以上指定します。
次のフィールドは、Text Search (ID Only) SKU をトリガーします。
places.attributions、places.id、places.name*、nextPageToken
*places.nameフィールドには、places/PLACE_ID形式の場所のリソース名が含まれます。places.displayNameを使用して、場所のテキスト名にアクセスします。次のフィールドは、Text Search (Basic) SKU をトリガーします。
places.accessibilityOptions、places.addressComponents、places.adrFormatAddress、places.businessStatus、places.containingPlaces、places.displayName、places.formattedAddress、places.googleMapsLinks*、places.googleMapsUri、places.iconBackgroundColor、places.iconMaskBaseUri、places.location、places.photos、places.plusCode、places.primaryType、places.primaryTypeDisplayName、places.pureServiceAreaBusiness、places.shortFormattedAddress、places.subDestinations、places.types、places.utcOffsetMinutes、places.viewport
*places.googleMapsLinksフィールドは一般提供前のプレビュー段階にあり、プレビュー期間中の使用料は請求されません（請求額は $0 です）。次のフィールドは、Text Search (Advanced) SKU をトリガーします。
places.currentOpeningHours,places.currentSecondaryOpeningHours,places.internationalPhoneNumber,places.nationalPhoneNumber,places.priceLevel,places.priceRange,places.rating,places.regularOpeningHours,places.regularSecondaryOpeningHours,places.userRatingCount,places.websiteUri次のフィールドは、Text Search (Preferred) SKU をトリガーします。
places.allowsDogs、places.curbsidePickup、places.delivery、places.dineIn、places.editorialSummary、places.evChargeOptions、places.fuelOptions、places.goodForChildren、places.goodForGroups、places.goodForWatchingSports、places.liveMusic、places.menuForChildren、places.parkingOptions、places.paymentOptions、places.outdoorSeating、places.reservable、places.restroom、places.reviews、places.routingSummaries、*places.servesBeer、places.servesBreakfast、places.servesBrunch、places.servesCocktails、places.servesCoffee、places.servesDessert、places.servesDinner、places.servesLunch、places.servesVegetarianFood、places.servesWine、places.takeout
* テキスト検索と周辺検索のみ
-
textQuery
検索するテキスト文字列（「レストラン」、「123 番地」、「サンフランシスコのおすすめスポット」など）。API はこの文字列と一致する候補を、関連性の高い順に並べて結果として返します。
オプション パラメータ
includedType
表 A で定義された指定したタイプに一致する場所のみに結果を制限します。指定できるタイプは 1 つだけです。次に例を示します。
"includedType":"bar""includedType":"pharmacy"
-
includePureServiceAreaBusinesses
trueに設定すると、顧客を直接訪問または配送するサービスを行っているものの、ビジネス拠点の住所ではサービスを提供していない非店舗型ビジネスがレスポンスに含まれます。falseに設定すると、物理的なビジネス拠点があるビジネスのみが返されます。 languageCode
結果を返す言語。
- サポートされている言語の一覧をご覧ください。サポートされる言語は頻繁に更新されるため、このリストがすべてのサポート言語を網羅しているとは限りません。
-
languageCodeが指定されていない場合、API はデフォルトでenになります。無効な言語コードを指定すると、API はINVALID_ARGUMENTエラーを返します。 - API では、できるだけユーザーとローカルの両言語で判読可能な番地を返します。そのために、ジオコーダはローカル言語で番地を返し、優先言語も考慮して、必要に応じてユーザーが理解できるスクリプトに書き直します。それ以外の住所はすべて、優先言語で返されます。住所コンポーネントはすべて、最初のコンポーネントで選択した言語と同じ言語で返されます。
- 優先言語で名前を表示できない場合、API は最も近い言語を使用します。
- 優先言語は、API が返す結果や、結果が返される順序に多少影響します。「～通り」を表す略語や特定の言語だけで有効な同義語など、ジオコーダによる略語の解釈は言語によって異なります。
locationBias
検索する領域を指定します。この位置情報はバイアスとして機能します。つまり、指定された位置情報の周辺の結果（指定されたエリア外の場所の結果を含む）が返される可能性があります。
locationRestrictionまたはlocationBiasを指定できますが、両方は指定できません。locationRestrictionは、結果が含まれる必要があるリージョンを指定すると考えてください。locationBiasは、結果が含まれる可能性が高いリージョンを指定すると考えてください。ただし、結果がそのリージョンの外部にある可能性もあります。リージョンを長方形のビューポートまたは円として指定します。
円は、中心点と半径（メートル単位）で定義されます。半径は 0.0 ～ 50000.0 の範囲で指定する必要があります。デフォルトの半径は 0.0 です。次に例を示します。
"locationBias": { "circle": { "center": { "latitude": 37.7937, "longitude": -122.3965 }, "radius": 500.0 } }
長方形は緯度と経度のビューポートで、対角線上の 2 つの低いポイントと高いポイントで表されます。低いポイントは長方形の南西の角を示し、高いポイントは長方形の北東の角を表します。
ビューポートは閉じた領域と見なされます。つまり、境界が含まれます。緯度の範囲は -90 ～ 90 度、経度の範囲は -180 ～ 180 度の範囲で指定する必要があります。
low=highの場合、ビューポートは単一のポイントで構成されます。low.longitude>high.longitudeの場合、経度の範囲が反転します（ビューポートが経度 180 度線を横切ります）。low.longitude= -180 度、high.longitude= 180 度の場合、ビューポートにはすべての経度が含まれます。low.longitude= 180 度、high.longitude= -180 度の場合、経度の範囲は空になります。low.latitude>high.latitudeの場合、緯度範囲は空になります。
下限と上限の両方を入力する必要があります。また、表すボックスを空にすることはできません。ビューポートが空の場合、エラーが発生します。
たとえば、このビューポートはニューヨーク市を完全に囲んでいます。
"locationBias": { "rectangle": { "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } } }
locationRestriction
検索する領域を指定します。指定した範囲外の結果は返されません。
リージョンを長方形のビューポートとして指定します。ビューポートの定義例については、
locationBiasの説明をご覧ください。locationRestrictionまたはlocationBiasを指定できますが、両方は指定できません。locationRestrictionは、結果が含まれる必要があるリージョンを指定すると考えてください。locationBiasは、結果が含まれる可能性が高いリージョンを指定すると考えてください。ただし、結果がそのリージョンの外部にある可能性もあります。-
maxResultCount（非推奨）
1 ページに表示する結果の数（1 ～ 20）を指定します。 たとえば、
maxResultCountの値を 5 に設定すると、最初のページに最大 5 件の結果が返されます。クエリから返される結果がさらにある場合、レスポンスにはnextPageTokenが含まれます。この値を次のリクエストに渡して、次のページにアクセスできます。 evOptions
利用可能な電気自動車（EV）充電コネクタと充電レートを特定するためのパラメータを指定します。
connectorTypes
スポットで利用可能な EV 充電コネクタのタイプでフィルタします。いずれのコネクタ タイプもサポートしていない場所は除外されます。サポートされている EV 充電コネクタの種類には、AC と DC の両方に対応した充電器、テスラ充電器、GB/T 準拠の充電器（中国での EV 急速充電用）、コンセント充電器などがあります。詳細については、リファレンス ドキュメントをご覧ください。
minimumChargingRateKw
最低 EV 充電速度（キロワット（kW）単位）で場所をフィルタします。最小充電料金より低い料金の場所は除外されます。たとえば、充電速度が 10 kW 以上の EV 充電スタンドを見つけるには、このパラメータを「10」に設定します。
minRating
平均ユーザー評価がこの上限以上の結果のみを表示します。値は 0.0 ～ 5.0（指定した値を含む）の範囲で、0.5 単位で指定する必要があります。たとえば、0、0.5、1.0、...、5.0 です。値は 0.5 の最も近い数値に切り上げられます。たとえば、値を 0.6 にすると、評価が 1.0 未満の結果がすべて除外されます。
openNow
trueの場合、クエリが送信された時点で営業している場所のみを返します。falseの場合、営業状況に関係なくすべてのビジネスを返します。このパラメータをfalseに設定すると、Google プレイスのデータベースに営業時間が登録されていない場所も返されます。pageSize
1 ページに表示する結果の数（1 ～ 20）を指定します。 たとえば、
pageSizeの値を 5 に設定すると、最初のページに最大 5 件の結果が返されます。クエリから返される結果がさらにある場合、レスポンスにはnextPageTokenが含まれます。この値を次のリクエストに渡して、次のページにアクセスできます。pageToken
前のページのレスポンス本文の
nextPageTokenを指定します。-
priceLevels
特定の料金レベルでマークされている場所に検索を制限します。 デフォルトでは、すべての料金レベルが選択されています。
PriceLevelで定義された 1 つ以上の値の配列を指定します。次に例を示します。
"priceLevels":["PRICE_LEVEL_INEXPENSIVE", "PRICE_LEVEL_MODERATE"]
rankPreference
クエリのタイプに基づいて、レスポンスで結果をランク付けする方法を指定します。
- 「ニューヨーク市のレストラン」などのカテゴリ検索の場合、デフォルトは
RELEVANCE（検索の関連性に基づいて結果をランク付け）です。rankPreferenceはRELEVANCEまたはDISTANCE（距離で結果をランク付け）に設定できます。 - 「Mountain View, CA」などのカテゴリ外のクエリの場合は、
rankPreferenceを設定しないことをおすすめします。
- 「ニューヨーク市のレストラン」などのカテゴリ検索の場合、デフォルトは
regionCode
レスポンスのフォーマットに使用される地域コード。 2 文字の CLDR コード値で指定します。このパラメータは、検索結果にバイアス効果をもたらす可能性があります。デフォルト値はありません。
レスポンスの
formattedAddressフィールドの国名がregionCodeと一致する場合、国コードはformattedAddressから省略されます。このパラメータは、利用可能な場合は常に国名が含まれるadrFormatAddressと、国名が含まれないshortFormattedAddressには影響しません。CLDR コードのほとんどは ISO 3166-1 コードと同一ですが、いくつか注意が必要な例外もあります。たとえば、英国の ccTLD は「uk」（.co.uk）ですが、その ISO 3166-1 コードは「gb」（厳密には「United Kingdom of Great Britain and Northern Ireland」のエンティティ）です。このパラメータは、適用される法律に基づいて結果に影響する可能性があります。
strictTypeFiltering
includedTypeパラメータで使用します。trueに設定すると、includeTypeで指定されたタイプに一致するプレイスのみが返されます。false（デフォルト）の場合、レスポンスには指定されたタイプと一致しない場所が含まれる場合があります。
Text Search の例
クエリ文字列で場所を検索する
次の例は、「オーストラリアのシドニーでスパイシーなベジタリアン料理」のテキスト検索リクエストを示しています。
curl -X POST -d '{
"textQuery" : "Spicy Vegetarian Food in Sydney, Australia"
}' \
-H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \
-H 'X-Goog-FieldMask: places.displayName,places.formattedAddress' \
'https://places.googleapis.com/v1/places:searchText'
X-Goog-FieldMask ヘッダーは、レスポンスに places.displayName,places.formattedAddress というデータフィールドが含まれていることを指定します。レスポンスの形式は次のとおりです。
{ "places": [ { "formattedAddress": "367 Pitt St, Sydney NSW 2000, Australia", "displayName": { "text": "Mother Chu's Vegetarian Kitchen", "languageCode": "en" } }, { "formattedAddress": "175 First Ave, Five Dock NSW 2046, Australia", "displayName": { "text": "Veggo Sizzle - Vegan & Vegetarian Restaurant, Five Dock, Sydney", "languageCode": "en" } }, { "formattedAddress": "29 King St, Sydney NSW 2000, Australia", "displayName": { "text": "Peace Harmony", "languageCode": "en" } }, ... ] }
フィールドマスクにデータ型を追加して、追加情報を返します。たとえば、places.types,places.websiteUri を追加して、レストランの種類とウェブアドレスをレスポンスに含めます。
curl -X POST -d '{
"textQuery" : "Spicy Vegetarian Food in Sydney, Australia"
}' \
-H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \
-H 'X-Goog-FieldMask: places.displayName,places.formattedAddress,places.types,places.websiteUri' \
'https://places.googleapis.com/v1/places:searchText'レスポンスの形式は次のようになります。
{ "places": [ { "types": [ "vegetarian_restaurant", "vegan_restaurant", "chinese_restaurant", "restaurant", "food", "point_of_interest", "establishment" ], "formattedAddress": "367 Pitt St, Sydney NSW 2000, Australia", "websiteUri": "http://www.motherchusvegetarian.com.au/", "displayName": { "text": "Mother Chu's Vegetarian Kitchen", "languageCode": "en" } }, { "types": [ "vegan_restaurant", "thai_restaurant", "vegetarian_restaurant", "indian_restaurant", "italian_restaurant", "american_restaurant", "restaurant", "food", "point_of_interest", "establishment" ], "formattedAddress": "175 First Ave, Five Dock NSW 2046, Australia", "websiteUri": "http://www.veggosizzle.com.au/", "displayName": { "text": "Veggo Sizzle - Vegan & Vegetarian Restaurant, Five Dock, Sydney", "languageCode": "en" } }, ... ] }
価格帯で場所をフィルタする
priceLevel オプションを使用して、低価格または中価格と定義されたレストランに結果を絞り込むことができます。
curl -X POST -d '{
"textQuery" : "Spicy Vegetarian Food in Sydney, Australia",
"priceLevels":["PRICE_LEVEL_INEXPENSIVE", "PRICE_LEVEL_MODERATE"]
}' \
-H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \
-H 'X-Goog-FieldMask: places.displayName,places.formattedAddress,places.priceLevel' \
'https://places.googleapis.com/v1/places:searchText'この例では、X-Goog-FieldMask ヘッダーを使用して places.priceLevel データ フィールドをレスポンスに追加し、次のような形式にしています。
{ "places": [ { "formattedAddress": "367 Pitt St, Sydney NSW 2000, Australia", "priceLevel": "PRICE_LEVEL_MODERATE", "displayName": { "text": "Mother Chu's Vegetarian Kitchen", "languageCode": "en" } }, { "formattedAddress": "115 King St, Newtown NSW 2042, Australia", "priceLevel": "PRICE_LEVEL_MODERATE", "displayName": { "text": "Green Mushroom", "languageCode": "en" } }, ... ] }
検索を絞り込むオプション（includedType、minRating、rankPreference、openNow など）を追加します。オプション パラメータで説明されているパラメータも使用できます。
検索を指定されたエリアに制限する
検索をエリアに制限するには、locationRestriction または locationBias を使用します（両方は使用できません）。locationRestriction は、結果が含まれる必要があるリージョンを指定すると考えてください。locationBias は、結果が近接している必要があるリージョンを指定すると考えてください。ただし、そのリージョンの外側にあってもかまいません。
locationRestriction を使用してエリアを制限する
locationRestriction パラメータを使用して、クエリ結果を指定されたリージョンに制限します。リクエスト本文で、リージョン境界を定義する low と high の緯度と経度の値を指定します。
次の例は、ニューヨーク市の「ベジタリアン料理」に関するテキスト検索リクエストを示しています。このリクエストでは、営業中の場所の最初の 10 件の結果のみが返されます。
curl -X POST -d '{
"textQuery" : "vegetarian food",
"pageSize" : "10",
"locationRestriction": {
"rectangle": {
"low": {
"latitude": 40.477398,
"longitude": -74.259087
},
"high": {
"latitude": 40.91618,
"longitude": -73.70018
}
}
}
}' \
-H 'Content-Type: application/json' \
-H 'X-Goog-Api-Key: API_KEY' \
-H 'X-Goog-FieldMask: places.id,places.formattedAddress' \
'https://places.googleapis.com/v1/places:searchText'
locationBias を使用して特定のエリアを優先する
次の例は、サンフランシスコのダウンタウンにある地点から 500 メートル以内の場所に偏重した「ベジタリアン料理」のテキスト検索リクエストを示しています。このリクエストでは、営業中の場所の最初の 10 件の結果のみが返されます。
curl -X POST -d '{
"textQuery" : "vegetarian food",
"openNow": true,
"pageSize": 10,
"locationBias": {
"circle": {
"center": {"latitude": 37.7937, "longitude": -122.3965},
"radius": 500.0
}
},
}' \
-H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \
-H 'X-Goog-FieldMask: places.displayName,places.formattedAddress' \
'https://places.googleapis.com/v1/places:searchText'
最小充電レートの EV 充電器を検索する
minimumChargingRateKw と connectorTypes を使用して、お乗りの EV に対応した充電器が利用できる場所を検索します。
次の例は、カリフォルニア州マウンテンビューで、最小充電速度が 10 kW の Tesla と J1772 タイプ 1 の EV 充電コネクタのリクエストを示しています。4 件の結果のみが返されます。
curl -X POST -d '{
"textQuery": "EV Charging Station Mountain View",
"pageSize": 4,
"evOptions": {
"minimumChargingRateKw": 10,
"connectorTypes": ["EV_CONNECTOR_TYPE_J1772","EV_CONNECTOR_TYPE_TESLA"]
}
}' \
-H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \
-H "X-Goog-FieldMask: places.displayName,places.evChargeOptions" \
'https://places.googleapis.com/v1/places:searchText'
このリクエストは次のレスポンスを返します。
{ "places": [ { "displayName": { "text": "EVgo Charging Station", "languageCode": "en" }, "evChargeOptions": { "connectorCount": 16, "connectorAggregation": [ { "type": "EV_CONNECTOR_TYPE_CHADEMO", "maxChargeRateKw": 100, "count": 8, "availableCount": 5, "outOfServiceCount": 0, "availabilityLastUpdateTime": "2024-01-10T19:10:00Z" }, { "type": "EV_CONNECTOR_TYPE_CCS_COMBO_1", "maxChargeRateKw": 100, "count": 2, "availableCount": 2, "outOfServiceCount": 0, "availabilityLastUpdateTime": "2024-01-10T19:10:00Z" }, { "type": "EV_CONNECTOR_TYPE_CCS_COMBO_1", "maxChargeRateKw": 350, "count": 6, "availableCount": 3, "outOfServiceCount": 0, "availabilityLastUpdateTime": "2024-01-10T19:10:00Z" } ] } }, { "displayName": { "text": "EVgo Charging Station", "languageCode": "en" }, "evChargeOptions": { "connectorCount": 6, "connectorAggregation": [ { "type": "EV_CONNECTOR_TYPE_CCS_COMBO_1", "maxChargeRateKw": 100, "count": 4, "availableCount": 3, "outOfServiceCount": 0, "availabilityLastUpdateTime": "2024-01-10T19:10:00Z" }, { "type": "EV_CONNECTOR_TYPE_CCS_COMBO_1", "maxChargeRateKw": 350, "count": 2, "availableCount": 0, "outOfServiceCount": 2, "availabilityLastUpdateTime": "2024-01-10T19:10:00Z" } ] } }, { "displayName": { "text": "EVgo Charging Station", "languageCode": "en" }, "evChargeOptions": { "connectorCount": 5, "connectorAggregation": [ { "type": "EV_CONNECTOR_TYPE_J1772", "maxChargeRateKw": 3.5999999046325684, "count": 1, "availableCount": 0, "outOfServiceCount": 1, "availabilityLastUpdateTime": "2024-01-10T19:10:00Z" }, { "type": "EV_CONNECTOR_TYPE_CHADEMO", "maxChargeRateKw": 50, "count": 2, "availableCount": 0, "outOfServiceCount": 0, "availabilityLastUpdateTime": "2024-01-10T19:10:00Z" }, { "type": "EV_CONNECTOR_TYPE_CCS_COMBO_1", "maxChargeRateKw": 50, "count": 2, "availableCount": 0, "outOfServiceCount": 0, "availabilityLastUpdateTime": "2024-01-10T19:10:00Z" } ] } }, { "displayName": { "text": "Electric Vehicle Charging Station", "languageCode": "en" }, "evChargeOptions": { "connectorCount": 10, "connectorAggregation": [ { "type": "EV_CONNECTOR_TYPE_OTHER", "maxChargeRateKw": 210, "count": 10 } ] } } ] }
非店舗型ビジネスを検索する
includePureServiceAreaBusinesses パラメータを使用すると、物理的なサービス拠点がないビジネス（モバイルクリーニング サービスやフードトラックなど）を検索できます。
次の例は、サンフランシスコの配管工のリクエストを示しています。
curl -X POST -d '{
"textQuery" : "plumber San Francisco",
"includePureServiceAreaBusinesses": true
}' \
-H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \
-H 'X-Goog-FieldMask: places.displayName,places.formattedAddress' \
'https://places.googleapis.com/v1/places:searchText'
レスポンスでは、実店舗がないビジネスには formattedAddress フィールドが含まれません。
{ "places": [ { "formattedAddress": "3450 Sacramento St #204, San Francisco, CA 94118, USA", "displayName": { "text": "Advanced Plumbing & Drain", "languageCode": "en" } }, { "formattedAddress": "1455 Bancroft Ave, San Francisco, CA 94124, USA", "displayName": { "text": "Magic Plumbing Heating & Cooling", "languageCode": "en" } }, /.../ { "displayName": { "text": "Starboy Plumbing Inc.", "languageCode": "en" } }, { "formattedAddress": "78 Dorman Ave, San Francisco, CA 94124, USA", "displayName": { "text": "Cabrillo Plumbing, Heating & Air", "languageCode": "en" } }, { "formattedAddress": "540 Barneveld Ave # D, San Francisco, CA 94124, USA", "displayName": { "text": "Mr. Rooter Plumbing of San Francisco", "languageCode": "en" } }, /.../ { "displayName": { "text": "Pipeline Plumbing", "languageCode": "en" } }, { "formattedAddress": "350 Bay St #100-178, San Francisco, CA 94133, USA", "displayName": { "text": "One Source Plumbing and Rooter", "languageCode": "en" } }, /.../ ] }
ページごとに返す結果の数を指定します。
pageSize パラメータを使用して、ページごとに返す結果の数を指定します。レスポンス本文の nextPageToken パラメータは、後続の呼び出しで結果の次のページにアクセスするために使用できるトークンを提供します。
次の例は、「ニューヨークのピザ屋」のリクエストで、ページあたりの結果を 5 件に制限しています。
curl -X POST -d '{
"textQuery": "pizza in New York",
"pageSize": 5
}' \
-H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \
-H "X-Goog-FieldMask: places.id,nextPageToken" \
'https://places.googleapis.com/v1/places:searchText'
{ "places": [ { "id": "ChIJifIePKtZwokRVZ-UdRGkZzs" }, { "id": "ChIJPxPd_P1YwokRfzLhSiACEoU" }, { "id": "ChIJrXXKn5NZwokR78g0ipCnY60" }, { "id": "ChIJ6ySICVZYwokR9rIK8HjXhzE" }, { "id": "ChIJ6xvs94VZwokRnT1D2lX2OTw" } ], "nextPageToken": "AeCrKXsZWzNVbPzO-MRWPu52jWO_Xx8aKwOQ69_Je3DxRpfdjClq8Ekwh3UcF2h2Jn75kL6PtWLGV4ecQri-GEUKN_OFpJkdVc-JL4Q" }
結果の次のページにアクセスするには、pageToken を使用して、リクエスト本文で nextPageToken を渡します。
curl -X POST -d '{
"textQuery": "pizza in New York",
"pageSize": 5,
"pageToken": "AeCrKXsZWzNVbPzO-MRWPu52jWO_Xx8aKwOQ69_Je3DxRpfdjClq8Ekwh3UcF2h2Jn75kL6PtWLGV4ecQri-GEUKN_OFpJkdVc-JL4Q"
}' \
-H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \
-H "X-Goog-FieldMask: places.id,nextPageToken" \
'https://places.googleapis.com/v1/places:searchText'
{ "places": [ { "id": "ChIJL-LN1N1ZwokR8K2jACu6Ydw" }, { "id": "ChIJjaD94kFZwokR-20CXqlpy_4" }, { "id": "ChIJ6ffdpJNZwokRmcafdROM5q0" }, { "id": "ChIJ8Q2WSpJZwokRQz-bYYgEskM" }, { "id": "ChIJ8164qwFZwokRhplkmhvq1uE" } ], "nextPageToken": "AeCrKXvPd6uUy-oj96W2OaqEe2pUD8QTxOM8-sKfUcFsC9t2Wey5qivrKGoGSxcZnyc7RPmaFfAktslrKbUh31ZDTkL0upRmaxA7c_c" }
試してみよう:
API Explorer では、サンプル リクエストを実行して、API と API オプションを把握できます。
ページの右側にある API アイコン
を選択します。必要に応じて [標準パラメータを表示] を開き、
fieldsパラメータをフィールド マスクに設定します。必要に応じて、リクエスト本文を編集します。
[Execute] ボタンを選択します。ポップアップ ダイアログ ボックスで、リクエストに使用するアカウントを選択します。
API Explorer パネルで展開アイコン
を選択して、API Explorer ウィンドウを開きます。