取得するフィールドの選択

ComputeRoutes() メソッドを呼び出すときに、レスポンスで返すフィールドを指定する必要があります。これは、URL パラメータ $fields または fields で指定するレスポンス フィールド マスクを使用するか、HTTP/gRPC ヘッダー X-Goog-FieldMask を使用するかによって行います。詳細については、システム パラメータをご覧ください。

フィールド マスク

フィールドマスクの値は、フィールドパスのカンマ区切りのリストです。各フィールドパスは、メッセージ階層を表すフィールド名のリストで、ドットで区切られています。フィールド名は、JSON オブジェクトのキーまたは protobuf フィールドタグ名です。フィールドパスは最上位のレスポンス メッセージ タイプから始まり、必要に応じて 1 つ以上のドットと次のレベルのフィールド名が続きます。一般に、フィールドパスは次の方法で作成されます。

topLevelField[.secondLevelField][.thirdLevelField][...]

特殊なケースのフィールド マスクはワイルドカード「*」で、ルートレベルのすべてのフィールドを選択します。

例

次の例は、ComputeRoutes() メソッドのフィールド マスクを設定する方法を示しています。

例 1

使用可能なすべてのフィールドのフィールド マスク（手動検査用）。

X-Goog-FieldMask: *

例 2

ルートレベルの所要時間、距離、ポリラインのフィールドマスク（本番環境の設定例）。

X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline

本番環境では、ワイルドカード（*）レスポンス フィールド マスクを使用するか、最上位（ルート）でフィールド マスクを指定することはおすすめしません。必要なフィールドのみを選択する:

  • サーバーの処理サイクルを節約できるため、低レイテンシで結果を返すことができます。

  • 安定したレイテンシのパフォーマンスを実現します。今後、レスポンス フィールドが追加される可能性があります。追加されたフィールドでは、追加の計算時間が必要な場合があります。すべてのフィールドを選択した場合、または最上位レベルですべてのフィールドを選択した場合、追加された新しいフィールドがレスポンスに自動的に含まれるため、パフォーマンスが低下する可能性があります。

  • レスポンス サイズが小さくなるため、ネットワーク スループットが向上します。

フィールドパスの作成方法については、field_mask.proto をご覧ください。