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

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

  • 基本のポリライン（デフォルト）: ポリラインに交通情報は埋め込まれていないルートを表します。基本的なポリラインを返すリクエストは、Routes Basic のレートで課金されます。Routes API の課金の詳細をご覧ください。

  • 交通状況に対応するポリライン: ルートの交通状況に関する情報が含まれています。交通状況は、ポリラインの特定の区間に適用可能な速度カテゴリ（NORMAL、SLOW、TRAFFIC_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_@@_@?"
      }
    }
  ]
}

このリクエストには出発地と目的地のみが含まれているため、返されるルートには単一の区間のみ含まれます。そのため、区間とルートのポリラインは同じになります。

リクエストに中間地点を追加した場合、返されるルートには 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 メソッド（REST）と ComputeRoutes では、polylineEncoding によって制御されます。

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

    ポイントの数が多いほど、ポリラインは滑らかになります（特にカーブで）。

    computeRoutes メソッド（REST）と ComputeRoutes では、polylineQuality によって制御されます。

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

ポリラインのタイプを制御するには、polylineEncoding リクエスト オプションを使用します。polylineEncoding プロパティは、ポリラインを ENCODED_POLYLINE としてエンコードするか（デフォルト）、エンコード ポリライン アルゴリズム形式を使用するか、GEO_JSON_LINESTRING（GeoJSON LineString 形式を使用する）を使用するかを制御します。

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

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",
  ...
}

交通対応ポリラインをリクエストする

上記の例はすべて、基本的なポリライン（つまり、交通情報のないポリライン）を返します。また、ポリラインにルートおよびルートの各区間の交通情報を含めるようにリクエストすることもできます。

交通状況を考慮したポリラインには、ルート沿いの交通状況に関する情報が含まれます。交通状況は、レスポンス ポリラインの指定された間隔の速度カテゴリ（NORMAL、SLOW、TRAFFIC_JAM）で表現されます。間隔は、ポリラインの始点（始点を含む）と終点（終点を除く）のインデックスで定義します。

たとえば、次のレスポンスは、ポリラインの地点 2 と 4 の間の NORMAL のトラフィックを示しています。

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

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

  • トラフィック計算を有効にするには、extraComputations 配列フィールドを TRAFFIC_ON_POLYLINE に設定します。

  • travelMode を DRIVE または 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'

交通対応ポリラインのレスポンス例

レスポンスでは、交通データがポリラインでエンコードされ、RouteLegTravelAdvisory オブジェクト（各区間）と RouteTravelAdvisory オブジェクト（ルート）の travelAdvisory フィールドに格納されます。

例:

{
  "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"
          }
        ] 
      }
    }
  ]
}

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

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

すべての間隔は、startPolylinePointIndex、endPolylinePointIndex、および対応する速度カテゴリで記述します。区間の開始インデックスがないことは、proto3 のプラクティスに従ってインデックス 0 に対応しています。

startPolylinePointIndex と endPolylinePointIndex の値は必ずしも連続しているわけではありません。例:

{
  "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