Method: searchAlongRoute

移動ルート沿いの場所を検索する。

HTTP リクエスト

POST https://mapstools.googleapis.com/v1:searchAlongRoute

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

リクエストの本文

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

JSON 表現 
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "routingPreference": enum (RoutingPreference),
  "includeExtendedDetails": boolean,
  "travelMode": enum (RouteTravelMode),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "encodedPolyline": string,
  "retrievalToken": string,
  "routeEndpoints": {
    object (RouteEndpoints)
  }
  // End of mutually exclusive fields.
}
フィールド
textQuery

string

必須。自然言語検索クエリ（例: 「EV 充電器」、「コーヒー」）。
languageCode

string

省略可。要約と Place Details の言語。デフォルトは「en-US」です。
regionCode

string

省略可。地域の国 / 地域コード（CLDR）（例: 「US」）。
routingPreference

enum (RoutingPreference)

省略可。交通状況データの使用方法を指定する、オプションのルーティング設定。デフォルトは TRAFFIC_UNAWARE です。
includeExtendedDetails

boolean

省略可。レスポンスに拡張された Place Details が含まれます。

ユーザー リクエストに、豊富な定性的分析情報、リアルタイムの動向、または特殊なエンティティ属性（定性的なレビュー、顧客の感情、フィードバックなど）が必要な場合は、このフィールドを true に設定します。- メニュー項目、料理、名物料理、飲み物、ビジネスのハイライトなどの具体的な提供内容。- 雰囲気、インテリア、美観、ムードなどの質的な要素。- リアルタイムのデータと、専門施設の仕様、訪問者向けのポリシー / ヒント、待ち時間。

標準の検索（料理、店舗の種類など）、場所 / 住所の検索、連絡先情報、営業時間、標準のメタデータ / 設備については、false（デフォルト）のままにします。

このフィールドを有効にすると、レイテンシが増加する可能性があります。
travelMode

enum (RouteTravelMode)

省略可。ルートと迂回路の計算に使用する移動手段を指定します。デフォルトは DRIVE です。WALK と BICYCLE は routeEndpoints でのみサポートされています。TRANSIT はサポートされていません。
ルート仕様: 既存のルート、ルートトークン、または出発地 / 目的地のいずれか。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
encodedPolyline

string

ルートを表すエンコードされたポリライン文字列。https://developers.google.com/maps/documentation/utilities/polylinealgorithm をご覧ください。
retrievalToken

string

ルートを表す、以前の v1.computeRoutes 呼び出しから返された取得トークン。
routeEndpoints

object (RouteEndpoints)

明示的なルート エンドポイント（出発地と目的地）。
相互に排他的なフィールドの終了。

レスポンスの本文

成功した場合、レスポンスの本文には SearchAlongRouteResponse のインスタンスが含まれます。

認可スコープ

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

  • https://www.googleapis.com/auth/maps-platform.mapstools