ルート ポリラインをリクエストする

欧州経済領域(EEA)のデベロッパー

computeRoutes メソッド(REST)と ComputeRoutes メソッド(gRPC)はどちらも、レスポンスの 一部としてポリラインで表されるルートを返します。これらの API は、次の 2 種類のポリラインを返します。

  • 基本ポリライン(デフォルト)はルートを表しますが、ポリラインに交通情報 は埋め込まれていません。基本ポリラインを返すリクエストは、Routes Basic の料金で課金されます。Routes API の 課金について詳しくは、こちらをご覧ください。

  • 交通状況を考慮したポリラインには、ルート沿いの交通状況に関する情報が含まれています。交通状況は、ポリラインの特定の区間に適用される速度カテゴリ(NORMALSLOWTRAFFIC_JAM)で表されます。交通状況を考慮したポリラインのリクエストは、Routes Preferred の料金で課金されます。Routes API の課金について詳しくは、こちらをご覧ください 。詳細については、ポリラインの 品質を構成するをご覧ください。

ポリラインについて詳しくは、以下をご覧ください。

ルート、区間、ステップの基本ポリラインをリクエストする

ポリラインは、 Polyline(REST)オブジェクトまたは Polyline(gRPC)オブジェクトで表されます。レスポンスでポリラインを返すことができるのは、ルート、区間、ステップのレベルです。

レスポンス フィールド マスクを使用して、返すポリラインを指定します。

  • ルートレベル : レスポンス フィールド マスクに routes.polylineを含めて、レスポンスでポリラインを返します。

  • 区間レベル : ルートの各区間のレスポンスでポリラインを返します。routes.legs.polyline

  • ステップレベル : routes.legs.steps.polyline を含めて、 区間の各ステップのレスポンスでポリラインを返します。

たとえば、ルート全体、各区間、各区間の各ステップのポリラインを返すには、次のようにします。

curl -X POST -d '{
  "origin":{
    "address": "1600 Amphitheatre Parkway, Mountain View, CA"
  },
  "destination":{
    "address": "24 Willie Mays Plaza, San Francisco, CA 94107"
  },
  "travelMode": "DRIVE"
}' \
-H 'Content-Type: application/json' \
-H 'X-Goog-Api-Key: YOUR_API_KEY' \
-H 'X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline,routes.legs.polyline,routes.legs.steps.polyline' \
'https://routes.googleapis.com/directions/v2:computeRoutes'

このリクエストは、ルートのポリライン、ルートの各区間のポリライン、区間の各ステップのポリラインを含む次のレスポンスを返します。

{
  "routes": [
    {
      "legs": [
        {
          "polyline": {
              "encodedPolyline": "ipkcFfich...@Bs@?A?O?SD{A@o@B}@I?qA?_AA_@@_@?"
          }
        },
          "steps": [
              {
                  "polyline": {
                      "encodedPolyline": "kclcF...@sC@YIOKI"
                  }
              },
              {
                  "polyline": {
                      "encodedPolyline": "wblcF~...SZSF_@?"
                  }
              },
              ...
      ],
      "distanceMeters": 56901,
      "duration": "2420s",
      "polyline": {
        "encodedPolyline": "ipkcFfich...@Bs@?A?O?SD{A@o@B}@I?qA?_AA_@@_@?"
      }
    }
  ]
}

このリクエストには出発地と目的地のみが含まれているため、返されるルートには区間が 1 つしか含まれていません。したがって、区間とルートのポリラインは同じです。

リクエストに中間地点を追加すると、返されるルートには 2 つの区間が含まれます。

curl -X POST -d '{
  "origin":{
    "address": "1600 Amphitheatre Parkway, Mountain View, CA"
  },
  "destination":{
    "address": "24 Willie Mays Plaza, San Francisco, CA 94107"
  },
  "intermediates": [
    { "address": "450 Serra Mall, Stanford, CA 94305, USA"},
  ],
  "travelMode": "DRIVE",
}' \
-H 'Content-Type: application/json' \
-H 'X-Goog-Api-Key: YOUR_API_KEY' \
-H 'X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline,routes.legs.polyline' \
'https://routes.googleapis.com/directions/v2:computeRoutes'

このリクエストは、それぞれに一意のポリラインを持つ 2 つの区間と、ルート全体のポリラインを返します。

{
  "routes": [
    {
      "legs": [
        {
          "polyline": {
            "encodedPolyline": "kclcFfqchV?A...?I@G?GAECCCEKICBAFG"
          }
          "steps": [
            {
                "polyline": {
                    "encodedPolyline": "kclcFfqch...YIOKI"
                }
            },
        ...
        },
        {
          "polyline": {
            "encodedPolyline": "ojmcFtethV?K...QOYQOGA?_@MUG[Ga@G"
          }
          "steps": [
            {
                "polyline": {
                    "encodedPolyline": "uypeFbo`jVgJq...PoBiC"
                }
            },
        ...
        }
      ],
      "distanceMeters": 68403,
      "duration": "3759s",
      "polyline": {
          "encodedPolyline": "kclcFfqchV?A?CBKF[Ha...?GAECCCEKICBAFGJEBE"
      }
    }
  ]
}

ポリラインの品質

ポリラインの品質は、次の用語で説明できます。

  • ポイントの浮動小数点精度

    ポイントは、単精度浮動小数点形式で表される緯度と経度の値として指定されます。これは小さい値に対してはうまく機能し、正確に表すことができますが、値が増加すると浮動小数点丸め誤差のために精度が低下します。

    ComputeRoutes

  • ポリラインを構成するポイントの数

    ポイントが多いほど、ポリラインは滑らかになります(特に曲線の場合)。

    ComputeRoutes

ポリラインのエンコード タイプを構成する

ポリラインのタイプを制御するには、polylineEncoding リクエスト オプションを使用します。 polylineEncoding プロパティは、ポリラインを ENCODED_POLYLINE(デフォルト)としてエンコードするかどうかを制御します。つまり、Encoded Polyline Algorithm Format が使用されます。または GEO_JSON_LINESTRINGGeoJSON LineString format が使用されます)。

たとえば、リクエスト本文は次のようになります。

curl -X POST -d '{
  "origin":{
    "address": "1600 Amphitheatre Parkway, Mountain View, CA"
  },
  "destination":{
    "address": "24 Willie Mays Plaza, San Francisco, CA 94107"
  },
  "travelMode": "DRIVE",
  "polylineEncoding": "ENCODED_POLYLINE"
}' \
-H 'Content-Type: application/json' \
-H 'X-Goog-Api-Key: YOUR_API_KEY' \
-H 'X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline,routes.legs.polyline' \
'https://routes.googleapis.com/directions/v2:computeRoutes'

ポリラインの品質を構成する

polylineQuality は、ポリラインの品質を HIGH_QUALITY または OVERVIEW(デフォルト)として指定します。OVERVIEW の場合、ポリラインは少数のポイントを使用して構成され、リクエストのレイテンシは HIGH_QUALITY よりも低くなります。

たとえば、リクエスト本文は次のようになります。

{
  "origin":{
    "location":{
      "latLng":{
        "latitude": 37.419734,
        "longitude": -122.0827784
      }
    }
  },
  "destination":{
    "location":{
      "latLng":{
        "latitude": 37.417670,
        "longitude": -122.079595
      }
    }
  },
  "travelMode": "DRIVE",
  "routingPreference": "TRAFFIC_AWARE",
  "polylineQuality": "HIGH_QUALITY",
  "polylineEncoding": "ENCODED_POLYLINE",
  "departureTime": "2023-10-15T15:01:23.045123456Z",
  ...
}

交通状況を考慮したポリラインをリクエストする

上記の例では、すべて基本ポリライン(交通情報のないポリライン)が返されます。また、ルートとルートの各区間の交通情報をポリラインに含めるようにリクエストすることもできます。

交通状況を考慮したポリラインには、ルート沿いの交通状況に関する情報が含まれています。交通状況は、レスポンス ポリラインの特定の区間の速度カテゴリ(NORMALSLOWTRAFFIC_JAM)で表されます。 区間は、開始(包括的)と終了(排他的)のポリライン ポイントのインデックスで定義されます。

たとえば、次のレスポンスは、ポリライン ポイント 2 と 4 の間の交通状況が NORMAL であることを示しています。

{
  "startPolylinePointIndex": 2,
  "endPolylinePointIndex": 4,
  "speed": "NORMAL"
}

交通状況を考慮したポリラインを計算するリクエストを行うには、リクエストで次のプロパティを設定します。

  • extraComputations 配列フィールドを TRAFFIC_ON_POLYLINE に設定して、交通状況の計算を有効にします。

  • travelModeDRIVE または TWO_WHEELER に設定します。他の移動手段のリクエストはエラーを返します。

  • リクエストで TRAFFIC_AWARE または TRAFFIC_AWARE_OPTIMAL のいずれかのルーティング 設定を指定します。詳細については、品質 とレイテンシの構成をご覧ください。

  • レスポンス プロパティを返すように指定するレスポンス フィールド マスクを設定します。

    • ルートレベル : レスポンス フィールド マスクに routes.travelAdvisory を含めて、レスポンスですべての移動情報を返します。交通情報のみを返すには、routes.travelAdvisory.speedReadingIntervals を指定します。

    • 区間レベル : routes.legs.travelAdvisory を含めて、ルートの 各区間のレスポンスですべての移動情報を返します。交通情報のみを返すには、routes.legs.travelAdvisory.speedReadingIntervals を指定します。

curl -X POST -d '{
  "origin":{
    "address": "1600 Amphitheatre Parkway, Mountain View, CA"
  },
  "destination":{
    "address": "24 Willie Mays Plaza, San Francisco, CA 94107"
  },
  "travelMode": "DRIVE",
  "extraComputations": ["TRAFFIC_ON_POLYLINE"],
  "routingPreference": "TRAFFIC_AWARE_OPTIMAL"
}' \
-H 'Content-Type: application/json' \
-H 'X-Goog-Api-Key: YOUR_API_KEY' \
-H 'X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline,routes.legs.polyline,routes.travelAdvisory,routes.legs.travelAdvisory' \
'https://routes.googleapis.com/directions/v2:computeRoutes'

交通状況を考慮したポリラインのレスポンス例

レスポンスでは、交通データはポリラインでエンコードされ、 travelAdvisory フィールドに、 RouteLegTravelAdvisory オブジェクト(各区間)と RouteTravelAdvisory オブジェクト(ルート)のタイプで含まれています。

次に例を示します。

{
  "routes": [
    {
      "legs": {
        "polyline": {
          "encodedPolyline": "}boeF~zbjVAg@EmB`GWHlD"
        },
        // Traffic data for the leg.
        "travelAdvisory": {
          "speedReadingIntervals": [
            {
              "endPolylinePointIndex": 1,
              "speed": "NORMAL"
            },
            {
              "startPolylinePointIndex": 1,
              "endPolylinePointIndex": 2,
              "speed": "SLOW"
            },
            {
              "startPolylinePointIndex": 2,
              "endPolylinePointIndex": 4,
              "speed": "NORMAL"
            }
          ] 
        }
      },
      "polyline": {
        "encodedPolyline": "}boeF~zbjVAg@EmB`GWHlD"
      },
      // Traffic data for the route.
      "travelAdvisory": {
        "speedReadingIntervals": [
          {
            "endPolylinePointIndex": 1,
            "speed": "NORMAL"
          },
          {
            "startPolylinePointIndex": 1,
            "endPolylinePointIndex": 2,
            "speed": "SLOW"
          },
          {
            "startPolylinePointIndex": 2,
            "endPolylinePointIndex": 4,
            "speed": "NORMAL"
          }
        ] 
      }
    }
  ]
}

RouteTravelAdvisoryRouteLegTravelAdvisory の両方に、交通速度情報を含む speedReadingIntervals という配列フィールドが含まれています。配列内の各 オブジェクトは、 SpeedReadingInterval(REST)オブジェクトまたは SpeedReadingInterval (gRPC)オブジェクトで表されます。

SpeedReadingInterval オブジェクトには、NORMALSLOWTRAFFIC_JAM などのルート区間の速度読み取りが含まれます。オブジェクトの配列全体は、重複することなくルートのポリライン全体をカバーします。指定された区間の開始点は、前の区間の終了点と同じです。

各区間は、startPolylinePointIndexendPolylinePointIndex、対応する速度カテゴリで表されます。区間内に開始インデックスがない場合は、proto3 の慣例に従ってインデックス 0 に対応します。

startPolylinePointIndexendPolylinePointIndex の値は必ずしも連続していません。次に例を示します。

{
  "startPolylinePointIndex": 2,
  "endPolylinePointIndex": 4,
  "speed": "NORMAL"
}

この場合、インデックス 2 からインデックス 4 までの交通状況は同じでした。

Maps SDK で交通状況を考慮したポリラインをレンダリングする

ポリラインの長さに沿ったカスタムカラー、ストローク、パターンなど、Google Maps SDK が提供するさまざまな機能を使用して、交通状況を考慮したポリラインを地図に表示することをおすすめします。ポリラインの使用について詳しくは、 Android のポリライン機能と iOS のポリライン機能をご覧ください。

ポリラインのレンダリング例

Maps SDK のユーザーは、速度カテゴリとポリライン レンダリング スキーマ間のカスタム マッピング ロジックを定義できます。たとえば、「NORMAL」速度を地図上に太い青色の線で表示し、「SLOW」速度を太いオレンジ色の線で表示するとします。

次のスニペットでは、メルボルンからパースへの測地線セグメントを持つ濃い青色のポリラインが追加されます。詳細については、外観の カスタマイズ (Android の場合)とポリラインの カスタマイズ(iOS の場合)をご覧ください。

Android

Java

Polyline line = map.addPolyline(new PolylineOptions()
    .add(new LatLng(-37.81319, 144.96298), new LatLng(-31.95285, 115.85734))
    .width(25)
    .color(Color.BLUE)
    .geodesic(true));

Kotlin

val line: Polyline = map.addPolyline(
  PolylineOptions()
    .add(LatLng(-37.81319, 144.96298), LatLng(-31.95285, 115.85734))
    .width(25f)
    .color(Color.BLUE)
    .geodesic(true)
)

iOS

Objective-C

GMSMutablePath *path = [GMSMutablePath path];
[path addLatitude:-37.81319 longitude:144.96298];
[path addLatitude:-31.95285 longitude:115.85734];
GMSPolyline *polyline = [GMSPolyline polylineWithPath:path];
polyline.strokeWidth = 10.f;
polyline.strokeColor = .blue;
polyline.geodesic = YES;
polyline.map = mapView;

Swift

let path = GMSMutablePath()
path.addLatitude(-37.81319, longitude: 144.96298)
path.addLatitude(-31.95285, longitude: 115.85734)
let polyline = GMSPolyline(path: path)
polyline.strokeWidth = 10.0
polyline.geodesic = true
polyline.map = mapView

ルート沿いの検索でエンコードされたポリラインを使用する

Places API のテキスト検索を使用して、計算されたルートに沿って検索します。Routes API の Compute Routes から、事前に計算されたルートのエンコードされたポリラインをテキスト検索リクエストに渡します。レスポンスには、検索条件に一致し、指定されたルートの近くにある場所が含まれます。詳細については、ルート沿いの検索 をご覧ください

たとえば、出発地と目的地の間のルート沿いのカフェを返すには、次のようにします。

Node.js

const API_KEY = 'YOUR_API_KEY';
const routes_service = 'https://routes.googleapis.com/directions/v2:computeRoutes';
const textSearch_service = 'https://places.googleapis.com/v1/places:searchText';

function init(){ const routes_request = { "origin":{ "address": "1600 Amphitheatre Parkway, Mountain View, CA" }, "destination":{ "address": "24 Willie Mays Plaza, San Francisco, CA 94107" }, "travelMode": "DRIVE" }; const textSearch_request = { "textQuery": "cafe", "searchAlongRouteParameters": { "polyline": { "encodedPolyline": "" } } }; fetchResources(routes_service,routes_request).then(routes => { textSearch_request.searchAlongRouteParameters.polyline.encodedPolyline = routes.routes[0].polyline.encodedPolyline; fetchResources(textSearch_service,textSearch_request).then(places => { console.log(places); }); }); } async function fetchResources(resource,reqBody){ const response = await fetch(resource, { method: 'POST', body: JSON.stringify(reqBody), headers: { 'Content-Type': 'application/json', 'X-Goog-Api-Key': API_KEY, 'X-Goog-FieldMask': '*' } }); const responseJSON = await response.json(); return responseJSON; } init();