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)
  },
  "routingParameters": {
    object (RoutingParameters)
  },
  "searchAlongRouteParameters": {
    object (SearchAlongRouteParameters)
  },
  "includePureServiceAreaBusinesses": boolean,
  "includeFutureOpeningBusinesses": boolean
}
フィールド
textQuery

string

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

languageCode

string

Place Details は、可能であれば優先言語で表示されます。言語コードが指定されていないか、認識されない場合は、任意の言語の Place Details が返されることがあります。そのような詳細が存在する場合は、英語が優先されます。

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

regionCode

string

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

詳しくは、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 を使用してください。

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

maxResultCount と pageSize の両方が指定されている場合、maxResultCount は無視されます。

pageSize

integer

省略可。1 ページあたりに返される結果の最大数。利用可能な結果の数が 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)

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

routingParameters

object (RoutingParameters)

省略可。結果へのルーティングに関する追加パラメータ。

searchAlongRouteParameters

object (SearchAlongRouteParameters)

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

includePureServiceAreaBusinesses

boolean

省略可。フィールドが true に設定されている場合は、非店舗型ビジネスのみを含めます。非店舗型ビジネスは、客先に出向いてサービスを提供し、ビジネス拠点の住所では接客しないビジネスです。清掃サービスや配管工事などのビジネスが該当します。これらのビジネスには、Google マップに表示される住所や所在地がありません。Places は、これらのビジネスの location、plusCode、その他の場所関連のフィールドを含むフィールドを返しません。

includeFutureOpeningBusinesses

boolean

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

レスポンスの本文

places.searchText のレスポンス proto。

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

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/maps-platform.places.textsearch
  • https://www.googleapis.com/auth/maps-platform.places
  • https://www.googleapis.com/auth/cloud-platform

RankPreference

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

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

LocationBias

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

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "rectangle": {
    object (Viewport)
  },
  "circle": {
    object (Circle)
  }
  // End of mutually exclusive fields.
}
フィールド
相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
rectangle

object (Viewport)

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

circle

object (Circle)

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

相互に排他的なフィールドの終了。

LocationRestriction

検索するリージョン。この場所は制限として機能します。つまり、指定された場所の外の結果は返されません。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "rectangle": {
    object (Viewport)
  }
  // End of mutually exclusive fields.
}
フィールド
相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
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

省略可。必要な最小充電速度(kW)。充電速度が指定した速度未満の場所は除外されます。

connectorTypes[]

enum (EVConnectorType)

省略可。優先する EV コネクタの種類のリスト。リストされているコネクタタイプをサポートしていない場所は除外されます。

SearchAlongRouteParameters

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

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

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

object (Polyline)

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

ポリライン

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

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "encodedPolyline": string
  // End of mutually exclusive fields.
}
フィールド
ポリラインのタイプをカプセル化します。Routes API の出力は、デフォルトで encoded_polyline になります。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
encodedPolyline

string

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

相互に排他的なフィールドの終了。

ContextualContent

場所クエリのコンテキストに沿ったコンテンツ。

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

object (Review)

この場所に関するクチコミのリスト。場所のクエリに関連するものです。

photos[]

object (Photo)

この場所の写真に関する情報(参照を含む)。場所のクエリに関連する情報です。

justifications[]

object (Justification)

場所の推奨理由。

理由

場所の推奨理由。理由付けは、エンドユーザーがその場所に興味を持つ理由を説明するものです。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "reviewJustification": {
    object (ReviewJustification)
  },
  "businessAvailabilityAttributesJustification": {
    object (BusinessAvailabilityAttributesJustification)
  }
  // End of mutually exclusive fields.
}
フィールド
相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
reviewJustification

object (ReviewJustification)

businessAvailabilityAttributesJustification

object (BusinessAvailabilityAttributesJustification)

相互に排他的なフィールドの終了。

ReviewJustification

ユーザー レビューの理由。これにより、エンドユーザーが興味を持つ可能性のあるユーザー レビューのセクションがハイライト表示されます。たとえば、検索クエリが「薪ピザ」の場合、クチコミの理由付けでは、検索クエリに関連するテキストがハイライト表示されます。

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

BusinessAvailabilityAttributes の理由。エンドユーザーが関心を持つ可能性のあるビジネスの属性が表示されます。

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

boolean

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

delivery

boolean

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

dineIn

boolean

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