テキストクエリによる場所の検索。
HTTP リクエスト
POST https://places.googleapis.com/v1/places:searchText
この URL は gRPC Transcoding 構文を使用します。
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "textQuery": string, "languageCode": string, "regionCode": string, "rankPreference": enum ( |
フィールド | |
---|---|
textQuery |
必須。テキスト検索用のテキストクエリ。 |
languageCode |
場所の詳細が使用言語で表示されます(選択可能な場合)。言語コードが指定されていないか認識できない場合は、任意の言語のプレイスの詳細が返され、そのような詳細が存在する場合は英語が優先されます。 現在サポートされている言語については、https://developers.google.com/maps/faq#languagesupport をご覧ください。 |
regionCode |
リクエストの送信元であるロケーションの Unicode 国/地域コード(CLDR)。このパラメータは、地域ごとの場所の名前(利用可能な場合)など、場所の詳細を表示するために使用されます。パラメータは、適用される法律に基づいて結果に影響を与える可能性があります。 詳しくは、https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html をご覧ください。 現在、3 桁の地域コードはサポートされていません。 |
rankPreference |
回答での結果がどのようにランク付けされるか。 |
includedType |
リクエストされた場所のタイプ。サポートされているタイプの一覧については、https://developers.google.com/maps/documentation/places/web-service/place-types をご覧ください。含まれる 1 つのタイプのみがサポートされます。 |
openNow |
現在営業中の場所のみに検索対象を限定するために使用します。デフォルト値は false です。 |
minRating |
ユーザーの平均評価がこの上限に厳密に満たない結果を除外します。有効な値は、0 ~ 5(両端を含む)の浮動小数点数で、0.5 の間隔(0, 0.5, 1.0, ... 5.0)にする必要があります。入力された評価は、最も近い 0.5(天井)に切り上げられます。たとえば、レーティングが 0.6 の場合、1.0 未満のすべての検索結果が除外されます。 |
maxResultCount |
返される結果の最大数。1 ~ 20 の値にする必要があります。デフォルト値は 20 です。番号が設定されていない場合は、上限にフォールバックします。数値が負の値に設定されているか、上限を超えると、INVALID_ARGUMENT エラーが返されます。 |
priceLevels[] |
特定の価格帯としてマークされている場所のみに検索を制限します。ユーザーは価格レベルの組み合わせを選択できます。デフォルトですべての価格レベルが選択されます。 |
strictTypeFiltering |
includeType の厳密なタイプのフィルタリングを設定するために使用します。true に設定すると、同じタイプの結果のみが返されます。デフォルトは false です。 |
locationBias |
検索するリージョン。この地域はバイアスとして機能し、指定された地域の周辺の検索結果が返される場合があります。locationRestriction とともに設定することはできません。 |
locationRestriction |
検索するリージョン。この地域は制限機能として機能し、指定された地域外の結果は返されません。locationBias と同時に設定することはできません。 |
evOptions |
省略可。Place Search リクエストの検索可能な EV オプションを設定します。 |
レスポンスの本文
Places.searchText のレスポンス プロトコル。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"places": [
{
object ( |
フィールド | |
---|---|
places[] |
ユーザーのテキスト検索条件を満たす場所のリスト。 |
RankPreference
回答での結果がどのようにランク付けされるか。
列挙型 | |
---|---|
RANK_PREFERENCE_UNSPECIFIED |
「ニューヨークのレストラン」のようなカテゴリクエリの場合、RELEVANCE がデフォルトです。「Mountain View, CA」などのカテゴリ以外のクエリについては、rankPreference を未設定のままにすることをおすすめします。 |
DISTANCE |
距離で結果をランク付けします。 |
RELEVANCE |
関連性によって結果をランク付けします。通常のランキング スタックによって決定される並べ替え順。 |
LocationBias
検索するリージョン。この地域はバイアスとして機能し、指定された地域の周辺の検索結果が返される場合があります。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド
|
|
rectangle |
北東と南西の角によって定義される長方形のボックス。 |
circle |
中心点と半径で定義される円。 |
LocationRestriction
検索するリージョン。この地域は制限機能として機能し、指定された地域外の結果は返されません。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド
|
|
rectangle |
北東と南西の角によって定義される長方形のボックス。 |
EVOptions
Place Search リクエストの検索可能な EV オプション。
JSON 表現 |
---|
{
"minimumChargingRateKw": number,
"connectorTypes": [
enum ( |
フィールド | |
---|---|
minimumChargingRateKw |
省略可。必要な最小充電速度(キロワット)。充電料金が指定した料金よりも低い場所は除外されます。 |
connectorTypes[] |
省略可。推奨の EV コネクタタイプのリスト。リストにあるコネクタのいずれもサポートしていない場所は除外されます。 |