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
本番環境では、ワイルドカード(*)レスポンス フィールド マスクを使用することや、トップレベル(ルート)でフィールド マスクを指定することはおすすめしません。必要なフィールドのみを選択します。
サーバーの処理サイクルが短縮されるため、低レイテンシで結果を返すことができます。
安定したレイテンシ パフォーマンスを確保します。レスポンス フィールドが今後追加される可能性があり、それらの新しいフィールドでは計算時間が増加する可能性があります。すべてのフィールドを選択した場合や、最上位のフィールドをすべて選択すると、Google が追加した新しいフィールドが自動的にレスポンスに含まれるため、パフォーマンスが低下する可能性があります。
レスポンス サイズが小さくなり、ネットワーク スループットが向上します。
フィールドパスの作成方法の詳細については、field_mask.proto をご覧ください。