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

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

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

  • 交通状況に対応するポリライン: ルートの交通状況に関する情報が含まれています。交通状況は、ポリラインの特定の区間に適用可能な速度カテゴリ(NORMALSLOWTRAFFIC_JAM)で表現されます。交通状況に対応するポリラインのリクエストは、Routes Preferred のレートで課金されます。Routes API の課金の詳細をご覧ください。詳しくは、ポリラインの品質を設定するをご覧ください。

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

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

ポリラインは、ポリライン(REST)またはポリライン(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'

ポリラインの品質を設定する

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'

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

レスポンスでは、交通データがポリラインでエンコードされ、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"
          }
        ] 
      }
    }
  ]
}

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