Method: places.searchText

テキストクエリに基づく場所の検索。

HTTP リクエスト

POST https://places.googleapis.com/v1/places:searchText

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

リクエストの本文

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

JSON 表現 
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "rankPreference": enum (RankPreference),
  "includedType": string,
  "openNow": boolean,
  "minRating": number,
  "maxResultCount": integer,
  "pageSize": integer,
  "pageToken": string,
  "priceLevels": [
    enum (PriceLevel)
  ],
  "strictTypeFiltering": boolean,
  "locationBias": {
    object (LocationBias)
  },
  "locationRestriction": {
    object (LocationRestriction)
  },
  "evOptions": {
    object (EVOptions)
  },
  "routingParameters": {
    object (RoutingParameters)
  },
  "searchAlongRouteParameters": {
    object (SearchAlongRouteParameters)
  },
  "includePureServiceAreaBusinesses": boolean
}
フィールド
textQuery

string

必須。テキスト検索用のテキストクエリ。
languageCode

string

場所の詳細が使用言語で表示されます（使用可能な場合）。言語コードが指定されていないか認識されない場合は、任意の言語の場所の詳細が返されます。そのような詳細が存在する場合は、英語が優先されます。

現在サポートされている言語の一覧: https://developers.google.com/maps/faq#languagesupport。
regionCode

string

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

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

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

enum (RankPreference)

回答内の検索結果のランク付け方法。
includedType

string

リクエストされたスポットタイプ。サポートされているタイプの一覧については、https://developers.google.com/maps/documentation/places/web-service/place-types をご覧ください。含めることができるのは 1 つのタイプのみです。
openNow

boolean

現在営業中のスポットだけを検索対象に絞り込むために使用します。デフォルトは false です。
minRating

number

平均ユーザー評価がこの上限を下回る結果を除外します。有効な値は、0.5 のケイデンスで 0 ～ 5 の範囲（0、0.5、1.0、...、5.0）の浮動小数点数である必要があります。入力評価は 0.5 の最も近い数値に切り上げられます（天井）。たとえば、評価が 0.6 の場合、評価が 1.0 未満の結果はすべて除外されます。
maxResultCount
(deprecated)

integer

非推奨: 代わりに pageSize を使用してください。

ページあたりに返される結果の最大数。使用可能な結果の数が maxResultCount より大きい場合、nextPageToken が返されます。これを pageToken に渡すと、後続のリクエストで結果の次のページを取得できます。0 または値が指定されていない場合、デフォルトの 20 が使用されます。最大値は 20 です。20 を超える値は 20 に強制変換されます。負の値を指定すると、INVALID_ARGUMENT エラーが返されます。

maxResultCount と pageSize の両方を指定すると、maxResultCount は無視されます。
pageSize

integer

省略可。ページあたりに返される結果の最大数。使用可能な結果の数が pageSize より大きい場合、nextPageToken が返されます。これを pageToken に渡すと、後続のリクエストで結果の次のページを取得できます。0 または値が指定されていない場合、デフォルトの 20 が使用されます。最大値は 20 で、20 より大きい値は 20 に設定されます。負の値を指定すると、INVALID_ARGUMENT エラーが返されます。

maxResultCount と pageSize の両方を指定すると、maxResultCount は無視されます。
pageToken

string

省略可。前回の TextSearch 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、TextSearch に指定する pageToken、pageSize、maxResultCount 以外のパラメータはすべて、ページトークンを提供した最初の呼び出しと一致する必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
priceLevels[]

enum (PriceLevel)

特定の価格帯としてマークされている宿泊施設に検索を限定するために使用します。料金レベルは自由に組み合わせて選択できます。デフォルトでは、すべての価格帯が選択されます。
strictTypeFiltering

boolean

includedType の厳格な型フィルタ設定に使用されます。true に設定すると、同じタイプの結果のみが返されます。デフォルトは false です。
locationBias

object (LocationBias)

検索する地域。この位置はバイアスとして機能し、指定された位置の周辺の結果が返される可能性があります。locationRestriction とともに設定することはできません。
locationRestriction

object (LocationRestriction)

検索するリージョン。この地域は制限として機能しており、指定された地域外の結果は返されません。locationBias とともに設定することはできません。
evOptions

object (EVOptions)

省略可。プレイス検索リクエストで検索可能な EV オプションを設定します。
routingParameters

object (RoutingParameters)

省略可。結果へのルーティング用の追加パラメータ。
searchAlongRouteParameters

object (SearchAlongRouteParameters)

省略可。ルート沿いの検索用の追加パラメータ proto。
includePureServiceAreaBusinesses

boolean

省略可。フィールドが true に設定されている場合は、純粋な非店舗型ビジネスを含めます。純粋な非店舗型ビジネスは、客先に出向いてサービスを提供し、ビジネス拠点の住所では接客しないビジネスです。清掃サービスや配管工事などのビジネスが該当します。これらのビジネスの実際の住所や場所が Google マップに掲載されていません。これらのビジネス拠点については、Places から location、plusCode などの位置情報関連のフィールドが返されません。

レスポンスの本文

places.searchText のレスポンス プロトコル。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "places": [
    {
      object (Place)
    }
  ],
  "routingSummaries": [
    {
      object (RoutingSummary)
    }
  ],
  "contextualContents": [
    {
      object (ContextualContent)
    }
  ],
  "nextPageToken": string,
  "searchUri": string
}
フィールド
places[]

object (Place)

ユーザーのテキスト検索条件に一致するプレイスのリスト。
routingSummaries[]

object (RoutingSummary)

ルーティングの概要のリスト。各エントリは、places フィールドの同じインデックス内の対応するプレイスに関連付けられます。いずれかの場所でルーティングの概要が利用できない場合は、空のエントリが含まれます。このリストには、リクエストされた場合、プレイスのリストと同じ数のエントリが含まれます。
contextualContents[]

object (ContextualContent)

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。

コンテキスト コンテンツのリスト。各エントリは、プレイスフィールドの同じインデックス内の対応するプレイスに関連付けられています。リクエスト内の textQuery に関連するコンテンツが優先されます。いずれかの場所でコンテキスト コンテンツを利用できない場合は、コンテキスト コンテンツ以外のコンテンツが返されます。この場所でコンテンツを利用できない場合にのみ空になります。リクエストに応じて、このリストには場所のリストと同じ数のエントリが含まれます。
nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドが省略されるか空の場合、後続のページはありません。
searchUri

string

リンクを使用すると、ユーザーはリクエストで指定したテキスト クエリを使用して Google マップで検索できます。

RankPreference

レスポンスで結果をランク付けする方法。

列挙型
RANK_PREFERENCE_UNSPECIFIED 「ニューヨークのレストラン」などのカテゴリ検索の場合、デフォルトは RELEVANCE です。「Mountain View, CA」のようなカテゴリ以外のクエリでは、rankPreference を未設定のままにすることをおすすめします。
DISTANCE 距離順に結果を並べ替えます。
RELEVANCE 結果は関連性に基づいてランク付けされます。並べ替え順序は通常のランキング スタックによって決定されます。

LocationBias

検索するリージョン。この位置はバイアスとして機能し、指定された位置の周辺の結果が返される可能性があります。

JSON 表現 
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  },
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
フィールド

共用体フィールド type。

type は次のいずれかになります。
rectangle

object (Viewport)

北東と南西の角で定義された長方形のボックス。rectangle.high() は、長方形のビューポートの北東にする必要があります。rectangle.low() は長方形ビューポートの南西の端である必要があります。rectangle.low().latitude()は rectangle.high().latitude() 以下にしてください。この場合、緯度の範囲は空になります。長方形ビューポートの幅は 180 度以下にする必要があります。
circle

object (Circle)

中心点と半径で定義された円。

LocationRestriction

検索する地域。この場所は制限として機能し、指定された場所外の結果は返されません。

JSON 表現 
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  }
  // End of list of possible types for union field type.
}
フィールド

共用体フィールド type。

type は次のいずれかになります。
rectangle

object (Viewport)

北東と南西の隅によって定義される長方形のボックス。rectangle.high() は長方形ビューポートの北東の点である必要があります。rectangle.low() は、長方形のビューポートの南西の点にする必要があります。rectangle.low().latitude() は rectangle.high().latitude() より大きくすることはできません。この場合、緯度の範囲は空になります。長方形のビューポートの幅は 180 度以下にする必要があります。

EVOptions

プレイス検索リクエストで検索可能な EV オプション。

JSON 表現 
{
  "minimumChargingRateKw": number,
  "connectorTypes": [
    enum (EVConnectorType)
  ]
}
フィールド
minimumChargingRateKw

number

省略可。最低限必要な充電速度（キロワット）。指定した料金より低い充電料金の場所は除外されます。
connectorTypes[]

enum (EVConnectorType)

省略可。優先される EV コネクタの種類のリスト。リストされているコネクタの種類に対応していない場所は除外されます。

SearchAlongRouteParameters

検索するルートを定義する、Routes API から事前に計算されたポリラインを指定します。ルート沿いの検索は、locationBias リクエスト オプションまたは locationRestriction リクエスト オプションを使用して検索結果をバイアスする方法と似ています。ただし、locationBias オプションと locationRestriction オプションでは地域を指定して検索結果に偏りをもたせることができますが、このオプションではルート沿いに偏りをもたせることができます。

結果は指定されたルート上にあるとは限りません。ポリラインで定義された検索エリア内で、出発地から目的地までの最小迂回時間に基づいて、locationBias または locationRestriction でランク付けされます。特に、指定されたポリラインで出発地から目的地までの最適なルートが定義されていない場合、結果は代替ルート上にある可能性があります。

JSON 表現 
{
  "polyline": {
    object (Polyline)
  }
}
フィールド
polyline

object (Polyline)

必須。ルートのポリライン。

ポリライン

ルート ポリライン。エンコードされたポリラインのみがサポートされます。これは文字列として渡され、損失を最小限に抑えながら圧縮できます。これは Routes API のデフォルト出力です。

JSON 表現 
{

  // Union field polyline_type can be only one of the following:
  "encodedPolyline": string
  // End of list of possible types for union field polyline_type.
}
フィールド
共用体フィールド polyline_type。ポリラインのタイプをカプセル化します。Routes API の出力はデフォルトで encoded_polyline になります。polyline_type は次のいずれかになります。
encodedPolyline

string

Routes API のデフォルトで返されるエンコードされたポリライン。エンコーダとデコーダのツールをご覧ください。

ContextualContent

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。

場所のクエリに関連するコンテンツ。

JSON 表現 
{
  "reviews": [
    {
      object (Review)
    }
  ],
  "photos": [
    {
      object (Photo)
    }
  ],
  "justifications": [
    {
      object (Justification)
    }
  ]
}
フィールド
reviews[]

object (Review)

この場所に関するクチコミのリスト（場所のクエリに関連するもの）。
photos[]

object (Photo)

この場所の写真に関する情報（参照を含む）で、プレイスクエリの文脈に沿ったもの。
justifications[]

object (Justification)

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。

場所の理由。

理由

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。

場所の正当性。理由とは、ある場所がなぜエンドユーザーの興味を引く可能性があるのかという問いの答えです。

JSON 表現 
{

  // Union field justification can be only one of the following:
  "reviewJustification": {
    object (ReviewJustification)
  },
  "businessAvailabilityAttributesJustification": {
    object (BusinessAvailabilityAttributesJustification)
  }
  // End of list of possible types for union field justification.
}
フィールド

共用体フィールド justification。

justification は次のいずれかになります。
reviewJustification

object (ReviewJustification)

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。
businessAvailabilityAttributesJustification

object (BusinessAvailabilityAttributesJustification)

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。

ReviewJustification

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。

ユーザー レビューの理由。これにより、エンドユーザーの関心を引くユーザー レビューの部分がハイライト表示されます。たとえば、検索クエリが「薪 ピザ」の場合、審査理由によって検索クエリに関連するテキストがハイライト表示されます。

JSON 表現 
{
  "highlightedText": {
    object (HighlightedText)
  },
  "review": {
    object (Review)
  }
}
フィールド
highlightedText

object (HighlightedText)
review

object (Review)

ハイライト表示されたテキストが生成されたレビュー。

HighlightedText

配置によってハイライト表示されたテキスト。これはレビュー自体のサブセットです。ハイライトする単語は HighlightedTextRange でマークされます。テキスト内の複数の単語がハイライト表示される場合があります。

JSON 表現 
{
  "text": string,
  "highlightedTextRanges": [
    {
      object (HighlightedTextRange)
    }
  ]
}
フィールド
text

string
highlightedTextRanges[]

object (HighlightedTextRange)

ハイライト表示されたテキストの範囲のリスト。

HighlightedTextRange

ハイライト表示されたテキストの範囲。

JSON 表現 
{
  "startIndex": integer,
  "endIndex": integer
}
フィールド
startIndex

integer
endIndex

integer

BusinessAvailabilityAttributesJustification

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。BusinessAvailabilityAttributes の理由。エンドユーザーの関心を引く可能性のあるビジネスの属性がいくつか表示されます。

JSON 表現 
{
  "takeout": boolean,
  "delivery": boolean,
  "dineIn": boolean
}
フィールド
takeout

boolean

テイクアウトを提供しているかどうか。
delivery

boolean

配送サービスを提供しているかどうか。
dineIn

boolean

店内での飲食が可能かどうか。