Method: places.searchText

テキストクエリベースの Place Search。

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, 0.5, 1.0, ... , 5.0）の 0 ～ 5（両端を含む）の浮動小数点数でなければなりません。入力レーティングは、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 をご覧ください。

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

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

イートインに対応しているかどうか。