Package google.maps.routes.v1alpha

索引

RoutesAlpha

Routes Preferred API

ComputeCustomRoutes

rpc ComputeCustomRoutes(ComputeCustomRoutesRequest) returns (ComputeCustomRoutesResponse)

終点と中間地点のセット、および経路の目標を指定すると、その経路の目標に最適な経路が計算されます。最速ルートと最短ルートを参照ルートとして返します。

注: この方法では、入力のレスポンス フィールド マスクを指定する必要があります。レスポンス フィールド マスクを指定するには、URL パラメータ $fields または fields を使用するか、HTTP/gRPC ヘッダー X-Goog-FieldMask を使用します（使用可能な URL パラメータとヘッダーをご覧ください）。値は、フィールドパスのカンマ区切りのリストです。詳しくは、フィールドパスの作成方法に関するドキュメントをご覧ください。

たとえば、このメソッドでは次のようになります。

  • 使用可能なすべてのフィールドのフィールド マスク（手動検査の場合）: X-Goog-FieldMask: *
  • ルートの距離、所要時間、トークン、通行料金情報のフィールド マスク: X-Goog-FieldMask: routes.route.distanceMeters,routes.route.duration,routes.token,routes.route.travelAdvisory.tollInfo

ワイルドカード（*）レスポンス フィールド マスクの使用や、トップレベルでのフィールド マスク（routes）の指定は、次の理由からおすすめしません。

  • 必要なフィールドのみを選択することで、サーバーの計算サイクルが節約され、低レイテンシで結果が返されるようになります。
  • 本番環境ジョブで必要なフィールドのみを選択することで、安定したレイテンシ パフォーマンスが保証されます。今後、レスポンス フィールドがさらに追加される可能性があります。また、それらの新しいフィールドでは、余分な計算時間が必要になる可能性があります。すべてのフィールドを選択した場合、または上位レベルですべてのフィールドを選択した場合、新しいフィールドが自動的にレスポンスに含まれるため、パフォーマンスが低下する可能性があります。
  • 必要なフィールドのみを選択すると、レスポンス サイズが小さくなり、ネットワーク スループットが高くなります。
認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/maps-platform.routespreferred

詳細については、OAuth 2.0 の概要をご覧ください。
ComputeRouteMatrix

rpc ComputeRouteMatrix(ComputeRouteMatrixRequest) returns (RouteMatrixElement)

出発地と目的地のリストを受け取り、出発地と目的地の各組み合わせのルート情報を含むストリームを返します。

注: この方法では、入力のレスポンス フィールド マスクを指定する必要があります。レスポンス フィールド マスクを指定するには、URL パラメータ $fields または fields を使用するか、HTTP/gRPC ヘッダー X-Goog-FieldMask を使用します（使用可能な URL パラメータとヘッダーをご覧ください）。値は、フィールドパスのカンマ区切りのリストです。詳しくは、フィールドパスの作成方法に関するドキュメントをご覧ください。

たとえば、このメソッドでは次のようになります。

  • 使用可能なすべてのフィールドのフィールド マスク（手動検査の場合）: X-Goog-FieldMask: *
  • ルートの所要時間、距離、要素のステータス、条件、要素インデックスのフィールド マスク（本番環境の設定例）: X-Goog-FieldMask: originIndex,destinationIndex,status,condition,distanceMeters,duration

フィールド マスクには必ず status を含めてください。そうしないと、すべてのメッセージに問題がないように見えます。ワイルドカード（*）レスポンス フィールド マスクの使用は、次の理由からおすすめしません。

  • 必要なフィールドのみを選択することで、サーバーの計算サイクルが節約され、低レイテンシで結果が返されるようになります。
  • 本番環境ジョブで必要なフィールドのみを選択することで、安定したレイテンシ パフォーマンスが保証されます。今後、レスポンス フィールドがさらに追加される可能性があります。また、それらの新しいフィールドでは、余分な計算時間が必要になる可能性があります。すべてのフィールドを選択した場合、または上位レベルですべてのフィールドを選択した場合、新しいフィールドが自動的にレスポンスに含まれるため、パフォーマンスが低下する可能性があります。
  • 必要なフィールドのみを選択すると、レスポンス サイズが小さくなり、ネットワーク スループットが高くなります。
認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/maps-platform.routespreferred

詳細については、OAuth 2.0 の概要をご覧ください。
ComputeRoutes

rpc ComputeRoutes(ComputeRoutesRequest) returns (ComputeRoutesResponse)

指定された終点と中間のウェイポイントのセットを基に、基本ルートと代替ルート（省略可）を返します。

注: この方法では、入力のレスポンス フィールド マスクを指定する必要があります。レスポンス フィールド マスクを指定するには、URL パラメータ $fields または fields を使用するか、HTTP/gRPC ヘッダー X-Goog-FieldMask を使用します（使用可能な URL パラメータとヘッダーをご覧ください）。値は、フィールドパスのカンマ区切りのリストです。詳しくは、フィールドパスの作成方法に関するドキュメントをご覧ください。

たとえば、このメソッドでは次のようになります。

  • 使用可能なすべてのフィールドのフィールド マスク（手動検査の場合）: X-Goog-FieldMask: *
  • ルートレベルの所要時間、距離、ポリラインのフィールド マスク（本番環境設定の例）: X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline

ワイルドカード（*）レスポンス フィールド マスクの使用や、トップレベルでのフィールド マスク（routes）の指定は、次の理由からおすすめしません。

  • 必要なフィールドのみを選択することで、サーバーの計算サイクルが節約され、低レイテンシで結果が返されるようになります。
  • 本番環境ジョブで必要なフィールドのみを選択することで、安定したレイテンシ パフォーマンスが保証されます。今後、レスポンス フィールドがさらに追加される可能性があります。また、それらの新しいフィールドでは、余分な計算時間が必要になる可能性があります。すべてのフィールドを選択した場合、または上位レベルですべてのフィールドを選択した場合、新しいフィールドが自動的にレスポンスに含まれるため、パフォーマンスが低下する可能性があります。
  • 必要なフィールドのみを選択すると、レスポンス サイズが小さくなり、ネットワーク スループットが高くなります。
認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/maps-platform.routespreferred

詳細については、OAuth 2.0 の概要をご覧ください。