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

ポリラインのエンコードは、ルートなどの一連の座標を 1 つの文字列として保存できる非可逆圧縮アルゴリズムです。エンコード プロセスは、base64 エンコード スキームを使用してバイナリ値を一連の ASCII 文字コードに変換します。エンコード プロセスの詳細については、エンコード ポリライン アルゴリズム形式をご覧ください。

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

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

  • 交通状況を認識するポリラインには、ルートに沿った交通状況が含まれています。交通状況は、ポリラインの所定の間隔に適用される速度カテゴリ（NORMAL、SLOW、TRAFFIC_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"
      }
    }
  ]
}

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

ポリライン タイプを制御するには、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'

交通状況に対応したポリラインをリクエストする

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

交通状況を認識するポリラインには、ルートの交通状況に関する情報が含まれています。交通状況は、レスポンスのポリラインの所定の間隔で、速度カテゴリ（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 のユーザーは、速度カテゴリとポリライン レンダリング スキーマの間でカスタマイズされたマッピング ロジックを定義できます。たとえば、「正常」の速度を青い線で太く表示し、「遅い」速度を濃いオレンジ色の線で表示するとします。

次のスニペットは、メルボルンからパースへの測地線セグメントを含む青い太いポリラインを追加します。詳細については、外観のカスタマイズ（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