Find Place(従来版)リクエストは、テキスト入力を受け取り、場所を返します。入力には、名前、住所、電話番号など、あらゆる種類の Places テキストデータを使用できます。リクエストは文字列にする必要があります。緯度/経度座標や Plus Code などの文字列以外のデータを使用した Find Place(従来版)リクエストは、エラーになります。
Find Place(従来版)リクエスト
Find Place(従来版)リクエストは、次の形式の HTTP URL です。
https://maps.googleapis.com/maps/api/place/findplacefromtext/output?parameters
ここで、output には次のいずれかの値を指定できます。
json(推奨)は、JavaScript Object Notation(JSON)での出力を示します。xmlは、XML としての出力を示します。
Find Place(従来版)リクエストを開始するには、特定のパラメータが必要です。URL の標準規則と同様に、すべてのパラメータはアンパサンド(&)文字を使用して区切ります。
必須パラメータ
-
入力
検索するテキスト文字列。地名、住所、電話番号のいずれかを入力する必要があります(例: 「123 Main Street」、「City Hall」)。
-
inputtype
入力のタイプ。
textqueryまたはphonenumberのいずれかになります。電話番号は、国際電話形式(先頭にプラス記号(+)、国コード、電話番号の順)にする必要があります。詳しくは、ITU 勧告 E.164 を参照してください。
オプション パラメータ
-
fields
注: Place Search(従来版)リクエストと Place Details(従来版)リクエストで、同じフィールドが返されることはありません。Place Search(従来版)リクエストでは、Place Details(従来版)リクエストで返されるフィールドのサブセットが返されます。目的のフィールドが Place Search(従来版)で返されない場合は、Place Search(従来版)を使用してplace_idを取得してから、そのプレイス ID を使用して Place Details(従来版)リクエストを実行します。Place Search(従来版)リクエストで使用できないフィールドの詳細については、Places API のフィールド サポートをご覧ください。fields パラメータを使用して、返す場所データのタイプのカンマ区切りのリストを指定します。例:
fields=formatted_address,name,geometry。複合的な値を指定する場合はスラッシュを使用します。例:opening_hours/open_now。フィールドは、Basic、Contact、Atmosphere の 3 つの請求カテゴリに分けられます。Basic フィールドは基本レートで課金され、Contact フィールドと Atmosphere フィールドはより高いレートで課金されます。Basic、Contact、Atmosphere の各 SKU は、それらをトリガーしたリクエストのベース SKU(Place Details、Find Place、Nearby Search、テキスト検索)に加えて課金されます。詳細については、価格表をご覧ください。
Basic
Basic カテゴリには次のフィールドが含まれます。
address_components、adr_address、business_status、formatted_address、geometry、icon、icon_mask_base_uri、icon_background_color、name、permanently_closed(サポート終了)、photo、place_id、plus_code、type、url、utc_offset、vicinity、wheelchair_accessible_entrance。連絡先
Contact カテゴリには、次のフィールドがあります。
current_opening_hours、formatted_phone_number、international_phone_number、opening_hours、secondary_opening_hours、websiteAtmosphere
Atmosphere カテゴリには、次のフィールドが含まれます。
curbside_pickup、delivery、dine_in、editorial_summary、price_level、rating、reservable、reviews、serves_beer、serves_breakfast、serves_brunch、serves_dinner、serves_lunch、serves_vegetarian_food、serves_wine、takeout、user_ratings_total。注: アトリビューション(html_attributions)は、このフィールドがリクエストされているかどうかにかかわらず、呼び出しのたびに必ず返されます。 -
言語
結果を返す言語。
- サポートされている言語の一覧をご覧ください。サポート対象の言語は頻繁に更新されるため、このリストで網羅されていない場合があります。
-
languageが指定されていない場合、API はAccept-Languageヘッダーで指定された優先言語を使用しようとします。 - API は、ユーザーと現地の人の両方が読み取れる番地を提供するように最善を尽くします。この目標を達成するため、住所は現地語で返されます。必要に応じて、ユーザーが読み取れる文字に変換され、優先言語が考慮されます。その他の住所はすべて、優先言語で返されます。住所コンポーネントはすべて同じ言語で返されます。この言語は、最初のコンポーネントから選択されます。
- 優先言語で名前が利用できない場合、API は最も近い一致を使用します。
- 優先言語は、API が返す結果のセットと、それらが返される順序にわずかに影響します。ジオコーダは、言語に応じて略語を異なる方法で解釈します。たとえば、道路タイプの略語や、ある言語では有効でも別の言語では有効でない類義語などです。たとえば、utca と tér は、ハンガリー語で「通り」の同義語です。
-
locationbias
半径と緯度/経度、または長方形の点を表す 2 つの緯度/経度のペアを指定して、指定したエリアの結果を優先します。このパラメータが指定されていない場合、API はデフォルトで IP アドレス バイアスを使用します。
-
IP バイアス: IP アドレス バイアスを使用するよう API に指示します。文字列
ipbiasを渡します(このオプションには追加のパラメータはありません)。 -
円形: 半径(メートル単位)と緯度/経度(10 進数)を指定する文字列。形式は次のようにします:
circle:radius@lat,lng。 -
矩形: 矩形の南西と北東のポイントを表す、緯度と経度のペアを 10 進数で 2 つ指定する文字列。
rectangle:south,west|north,eastの形式を使用します。なお、東西の値は -180 ~ 180 の範囲にラップされ、南北の値は -90 ~ 90 の範囲にクランプされます。
-
IP バイアス: IP アドレス バイアスを使用するよう API に指示します。文字列
Find Place(従来版)の例
次の例は、「Museum of Contemporary Art Australia」の Find Place(従来版)リクエストを示しています。このリクエストには、photos、formatted_address、name、rating、opening_hours、geometry フィールドが含まれています。
curl
curl -L -X GET 'https://maps.googleapis.com/maps/api/place/findplacefromtext/json?input=Museum%20of%20Contemporary%20Art%20Australia&inputtype=textquery&fields=formatted_address%2Cname%2Crating%2Copening_hours%2Cgeometry&key=YOUR_API_KEY'HTTP
https://maps.googleapis.com/maps/api/place/findplacefromtext/json ?fields=formatted_address%2Cname%2Crating%2Copening_hours%2Cgeometry &input=Museum%20of%20Contemporary%20Art%20Australia &inputtype=textquery &key=YOUR_API_KEY
次の例は、「Mongolian Grill」を検索する Find Place(従来版)リクエストです。locationbias パラメータを使用して、指定した座標から 2,000 m 以内の結果を優先的に表示します。
curl
curl -L -X GET 'https://maps.googleapis.com/maps/api/place/findplacefromtext/json?input=Mongolian%20Grill&inputtype=textquery&fields=formatted_address%2Cname%2Crating%2Copening_hours%2Cgeometry&locationbias=circle:2000@−33.866,151.216&key=YOUR_API_KEY'HTTP
https://maps.googleapis.com/maps/api/place/findplacefromtext/json ?fields=formatted_address%2Cname%2Crating%2Copening_hours%2Cgeometry &input=Mongolian%20Grill &inputtype=textquery &locationbias=circle:2000@−33.866,151.216 &key=YOUR_API_KEY
次の例は、電話番号の Find Place(従来版)リクエストを示しています。このリクエストが準拠 URL になるように、国際電話のプレフィックス「+」が %2B にエンコードされていることに注意してください。エンコードされていない場合、+ プレフィックスはサーバー上でスペースにデコードされ、無効な電話番号の検索になります。
curl
curl -L -X GET 'https://maps.googleapis.com/maps/api/place/findplacefromtext/json?input=%2B16502530000&inputtype=phonenumber&fields=formatted_address%2Cname%2Crating%2Copening_hours%2Cgeometry&key=YOUR_API_KEY'HTTP
https://maps.googleapis.com/maps/api/place/findplacefromtext/json ?fields=formatted_address%2Cname%2Crating%2Copening_hours%2Cgeometry &input=%2B16502530000 &inputtype=phonenumber &key=YOUR_API_KEY
Find Place(従来版)のレスポンス
Find Place(従来版)のレスポンスには、fields パラメータを使用して指定されたデータタイプと html_attributions のみが含まれます。次の例は、「Museum of Contemporary Art Australia」の Find Place(従来版)リクエストに対するレスポンスを示しています。formatted_address、geometry、name、opening_hours、photos、rating フィールドが含まれています。
JSON
{ "candidates": [ { "formatted_address": "140 George St, The Rocks NSW 2000, Australia", "geometry": { "location": { "lat": -33.8599358, "lng": 151.2090295 }, "viewport": { "northeast": { "lat": -33.85824377010728, "lng": 151.2104386798927 }, "southwest": { "lat": -33.86094342989272, "lng": 151.2077390201073 }, }, }, "name": "Museum of Contemporary Art Australia", "opening_hours": { "open_now": false }, "rating": 4.4, }, ], "status": "OK", }
XML
<?xml version="1.0" encoding="UTF-8"?> <FindPlaceFromTextResponse> <candidates> <name>Museum of Contemporary Art Australia</name> <formatted_address>140 George St, The Rocks NSW 2000, Australia</formatted_address> <geometry> <location> <lat>-33.8599358</lat> <lng>151.2090295</lng> </location> <viewport> <southwest> <lat>-33.8609434</lat> <lng>151.2077390</lng> </southwest> <northeast> <lat>-33.8582438</lat> <lng>151.2104387</lng> </northeast> </viewport> </geometry> <rating>4.4</rating> <opening_hours> <open_now>false</open_now> </opening_hours> </candidates> <status>OK</status> </FindPlaceFromTextResponse>
PlacesFindPlaceFromTextResponse
| フィールド | 必須 | タイプ | 説明 |
|---|---|---|---|
|
required | Array<Place> |
Place 候補の配列が含まれます。
Place Search(従来版)リクエストでは、Place Details(従来版)リクエストで返されるフィールドのサブセットが返されます。目的のフィールドが Place Search(従来版)で返されない場合は、Place Search(従来版)を使用して place_id を取得してから、そのプレイス ID を使用して Place Details(従来版)リクエストを実行します。
詳細については、Place をご覧ください。 |
|
required | PlacesSearchStatus |
リクエストのステータスが格納されます。リクエストが失敗した原因を追跡できるようにデバッグ情報が格納される場合もあります。 詳細については、PlacesSearchStatus をご覧ください。 |
|
省略可 | 文字列 |
サービスが |
|
省略可 | Array<string> |
サービスがリクエスト仕様に関する追加情報を返す場合、レスポンス オブジェクト内に追加の |
PlacesSearchStatus
サービスから返されるステータス コード。
OKは、API リクエストが成功したことを示します。-
ZERO_RESULTSは、検索は成功したものの結果が返されなかったことを示します。これは、遠隔地のlatlngが検索に渡された場合に発生することがあります。 -
INVALID_REQUESTは、API リクエストの形式が正しくないことを示します。通常は、必須のクエリ パラメータ(locationまたはradius)が不足していることが原因です。 -
OVER_QUERY_LIMIT。次のいずれかを示します。- QPS の上限を超えている。
- アカウントで課金が有効になっていない。
- 毎月 200 ドル分のクレジット、またはご自身で設定した使用量の上限を超えている。
- 設定したお支払い方法が無効になっている(クレジット カードの期限切れなど)
-
REQUEST_DENIEDは、リクエストが拒否されたことを示します。一般的には、次の理由が考えられます。- リクエストに API キーがありません。
keyパラメータが無効です。
UNKNOWN_ERRORは、不明なエラーが発生したことを示します。
場所
Place Search のレスポンスでは、Place フィールドの次のサブセットが返されます。すべての属性がすべての場所タイプで使用できるわけではありません。Place Search で返されないフィールド(address_components、formatted_phone_number、reviews、website など)を取得するには、返された place_id を Place Details(従来版)リクエストで渡します。エンドポイント全体のフィールドの可用性と料金階層については、プレイスデータ フィールド(レガシー)をご覧ください。
| フィールド | タイプ | 説明 |
|---|---|---|
business_status |
string |
その場所の営業状況を示します(場所がお店やサービスの場合)。OPERATIONAL、CLOSED_TEMPORARILY、CLOSED_PERMANENTLY のいずれかです。ステータス データが存在しない場合は省略されます。
|
formatted_address |
string |
この場所の人が読める形式の住所。テキスト検索(従来版)と Find Place(従来版)によって返されます。フォーマット済み住所は、プログラムで解析しないでください。代わりに、Place Details(従来版)で address_components をリクエストしてください。 |
geometry |
Geometry
|
lat 座標と lng 座標を持つジオコーディングされた location と、northeast 境界と southwest 境界を持つ優先 viewport が含まれます。
|
icon |
string |
この結果を地図上に表示する際に使用できる、推奨アイコンの URL。 |
icon_background_color
|
string |
場所のカテゴリのデフォルトの 16 進数色コード。 |
icon_mask_base_uri |
string |
推奨アイコンのベース URL。SVG または PNG のファイル形式の拡張子は含まれません。 |
name |
string |
返された結果の人が読める形式の名前。establishment の結果の場合、この値は通常、正規化されたビジネス名です。 |
opening_hours |
PlaceOpeningHours
|
営業時間に関する情報。Place Search エンドポイントは、open_now ブール値サブフィールドのみを返します。periods と weekday_text については、Place Details(従来版)で opening_hours をリクエストします。 |
permanently_closed |
boolean |
非推奨: business_status を使用してお店やサービスの営業状況を確認してください。
|
photos |
Array<PlacePhoto>
|
PlacePhoto オブジェクトの配列。各オブジェクトには、photo_reference、height、width、html_attributions が含まれます。使用方法の詳細については、Place Photos(従来版)をご覧ください。 |
place_id |
string |
場所を一意に識別するテキスト表記の ID。この ID を Place Details(従来版)リクエストの place_id パラメータに渡します。プレイス ID の概要をご覧ください。 |
plus_code |
PlusCode
|
緯度と経度の座標から派生したエンコードされた場所の参照。global_code とオプションの compound_code が含まれます。 |
price_level |
integer |
場所の価格レベル。0 から 4 の範囲で、最も安いものから最も高いものまでを表します。price_level をご覧ください。 |
rating |
number |
ユーザーのクチコミの集計に基づく場所の評価(1.0~5.0)。 |
reference |
string |
非推奨: 代わりに place_id を使用してください。 |
scope |
string |
非推奨: place_id のスコープを示します。これは常に GOOGLE です。Nearby Search(従来版)によって返されます。 |
types |
Array<string> |
指定された結果を記述する特徴タイプの配列。プレイスタイプ(従来版)をご覧ください。 |
user_ratings_total |
integer |
この場所の評価の合計数(レビュー テキストの有無にかかわらず)。 |
vicinity |
string |
場所の簡単な住所です。番地や市町村などが含まれ、州、都道府県、郵便番号、国などは含まれません。Nearby Search(従来版)によって返されます。 |