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

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

  • 基本的なポリライン（デフォルト）: ルートを表しますが、ポリラインに交通情報が埋め込まれていません。基本的なポリラインを返すリクエストは、ルートの基本料金で課金されます。Routes API の課金について

  • 交通状況を考慮したポリライン: ルート上の交通状況に関する情報が含まれます。交通状況は、ポリラインの特定の区間に適用される速度カテゴリ（NORMAL、SLOW、TRAFFIC_JAM）で表されます。交通状況を考慮したポリラインのリクエストは、ルート優先料金で課金されます。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'

交通状況に応じたポリラインのレスポンスの例

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

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

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

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

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

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();