Method: searchText

テキストクエリで場所を検索します。

HTTP リクエスト

POST https://mapstools.googleapis.com/v1alpha:searchText

この URL は gRPC Transcoding 構文を使用します。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "pageSize": integer,
  "includeExtendedDetails": boolean,
  "locationBias": {
    object (LocationBias)
  }
}
フィールド
textQuery

string

必須。テキストクエリ。
languageCode

string

省略可。要約を返す言語。言語コードが指定されていないか、認識されない場合は、英語を優先した要約が返されます。

たとえば、英語の場合は「en」です。

サポートされている言語の最新リスト: https://developers.google.com/maps/faq#languagesupport
regionCode

string

省略可。リクエストの送信元のロケーションの Unicode 国 / リージョン コード（CLDR）。このパラメータは、地域固有の場所名など、Place Details を表示するために使用されます（利用可能な場合）。このパラメータは、適用される法律に基づいて結果に影響する可能性があります。

たとえば、米国の場合は「US」です。

詳しくは、https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html をご覧ください。

なお、3 桁の地域コードは現在サポートされていません。
pageSize

integer

省略可。返される場所の最大数（最大 10）。サービスが返す値はこれよりも少ないことがあります。デフォルト値は 5 です。

5 つを超える場所をリクエストすると、Pro ティアがトリガーされ、請求額とレイテンシが増加します。
includeExtendedDetails

boolean

省略可。レスポンスに拡張された Place Details が含まれます。

ユーザー リクエストに、豊富な定性的分析情報、リアルタイムの動向、または特殊なエンティティ属性（定性的なレビュー、顧客の感情、フィードバックなど）が必要な場合は、このフィールドを true に設定します。- メニュー項目、料理、名物料理、飲み物、ビジネスのハイライトなどの具体的な提供内容。- 雰囲気、インテリア、美観、ムードなどの質的な要素。- リアルタイムのデータと、専門施設の仕様、訪問者向けのポリシー / ヒント、待ち時間。

標準の検索（料理、店舗の種類など）、場所 / 住所の検索、連絡先情報、営業時間、標準のメタデータ / 設備については、false（デフォルト）のままにします。

このフィールドを有効にすると、Pro ティアがトリガーされ、請求額とレイテンシが増加します。
locationBias

object (LocationBias)

検索結果を優先するオプションの地域。textQuery に明示的な場所が指定されている場合、このフィールドの代わりに、その場所を使用して検索結果がバイアスされます。

レスポンスの本文

成功した場合、レスポンスの本文には SearchTextResponse のインスタンスが含まれます。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/maps-platform.mapstools