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,
  "includeFutureOpeningBusinesses": 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 などの位置情報関連フィールドを含むフィールドを返しません。
includeFutureOpeningBusinesses

boolean

省略可。true の場合、まだ開業していないが将来開業するビジネスを含めます。

レスポンスの本文

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 をご覧ください。

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

string

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

string

リンクを使用すると、リクエストで指定されたテキスト クエリと同じテキスト クエリで Google マップを検索できます。

認可スコープ

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

  • https://www.googleapis.com/auth/cloud-platform

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

イートインを提供しているかどうか。