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