Package google.maps.routes.v1alpha

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

ワイルドカード（*）レスポンス フィールド マスクを使用するか、最上位レベルでフィールド マスクを指定することはおすすめしません。理由は次のとおりです。

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

認可スコープ

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

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

詳しくは、OAuth 2.0 の概要をご覧ください。

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 を含めることが重要です。含めないと、すべてのメッセージが OK と表示されます。以下の理由により、ワイルドカード（*）レスポンス フィールド マスクの使用はおすすめしません。

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

認可スコープ

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

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

詳しくは、OAuth 2.0 の概要をご覧ください。

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

ワイルドカード（*）レスポンス フィールド マスクを使用するか、最上位レベルでフィールド マスクを指定することはおすすめしません。理由は次のとおりです。

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

認可スコープ

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

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

詳しくは、OAuth 2.0 の概要をご覧ください。