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

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 メソッド(REST)と ComputeRoutes では、polylineEncoding によって制御されます。

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

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

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

ポリラインのエンコード タイプを設定する

ポリラインのタイプを制御するには、polylineEncoding リクエスト オプションを使用します。polylineEncoding プロパティは、ポリラインを ENCODED_POLYLINE(デフォルト)としてエンコードするか(デフォルト)、エンコード ポリライン アルゴリズム形式を使用するか、GEO_JSON_LINESTRINGGeoJSON 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'

Poyline の品質を構成する

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