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)
  }
}
フィールド
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

includeType の厳密なタイプのフィルタリングを設定するために使用します。true に設定すると、同じタイプの結果のみが返されます。デフォルトは false です。
locationBias

object (LocationBias)

検索するリージョン。この地域はバイアスとして機能し、指定された地域の周辺の検索結果が返される場合があります。locationRestriction とともに設定することはできません。
locationRestriction

object (LocationRestriction)

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

object (EVOptions)

省略可。Place Search リクエストの検索可能な EV オプションを設定します。

レスポンスの本文

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

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

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

object (Place)

ユーザーのテキスト検索条件を満たす場所のリスト。
contextualContents[]

object (ContextualContent)

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

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

string

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

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

Place Search リクエストの検索可能な EV オプション。

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

number

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

enum (EVConnectorType)

省略可。推奨の EV コネクタタイプのリスト。リストにあるコネクタのいずれもサポートしていない場所は除外されます。

ContextualContent

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

Place Query のコンテキストに即したコンテンツです。

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

object (Review)

Place クエリに関連する、この場所に関するクチコミのリストです。
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

イートインが可能なお店やスポット。