返されるフィールドを選択する

ルートまたはルート マトリックスをリクエストする場合は、フィールド マスクを使用して、レスポンスで返す情報を指定する必要があります。返されるフィールドのデフォルト リストはありません。フィールドマスクを指定しないと、メソッドはエラーを返します。

フィールドマスクを使用すると、不要なデータをリクエストしないようにできます。これにより、レスポンスのレイテンシが短縮され、システムに不要な情報に対して不要な料金が発生するのを防ぐことができます。

必要なフィールドのリストをレスポンス フィールド マスクで指定します。次に、URL パラメータ $fields または fields を使用するか、HTTP または gRPC ヘッダー X-Goog-FieldMask を使用して、レスポンス フィールド マスクをいずれかのメソッドに渡します。

URL パラメータの詳細については、システム パラメータをご覧ください。

レスポンス フィールド マスクを定義する

レスポンス フィールド マスクは、パスのカンマ区切りのリストです。各パスは、レスポンス メッセージ内の一意のフィールドを指定します。パスは最上位のレスポンス メッセージから始まり、指定されたフィールドへのパスをドットで区切って使用します。

次のようにフィールドパスを作成して指定します。

  1. Routes API で必要な情報が含まれているフィールドを見つけます。詳細については、フィールドの参照をご覧ください。
  2. 必要なフィールドのパスを特定し、それらのフィールド マスクを作成します。詳細については、使用するフィールド マスクを決定するをご覧ください。

  3. 必要なすべてのフィールドのフィールド マスクを組み合わせ、フィールド マスクをカンマで区切ります。たとえば、ルート経路の distanceMeters と、ルート経路の各ステップの所要時間をリクエストするには、両方をカンマで区切って入力します（スペースは入力しないでください）。

    routes.legs.distanceMeters,routes.legs.steps.duration

  4. フィールドマスクを API リクエストとともに送信する。たとえば、cURL リクエストでは、-H と X-Goog-FieldMask を使用してフィールド マスクを指定します。

    -H X-Goog-FieldMask: routes.legs.distanceMeters,routes.legs.steps.duration
例と詳細については、以降のセクションをご覧ください。

フィールド参照

フィールド マスクを使用してレスポンスでリクエストできるフィールドについては、次のリストにリンクされている Routes API リファレンスをご覧ください。リファレンスに示すように、フィールドをキャメルケースで指定します。たとえば、routePreference です。

これらの参照には、使用可能なフィールドが含まれていますが、フィールドの階層を参照して、フィールド マスクの完全なパスを決定する必要があります。フィールドの階層を取得する方法については、使用するフィールド マスクを決定するをご覧ください。

  • ルート フィールド マスクを計算する
    • REST: 返されるレスポンスの Route オブジェクトのフィールドを指定します。接頭辞は routes. です（例: routes.distanceMeters）。
    • gRPC: 返すレスポンスの Route オブジェクトのフィールドを指定します。
  • Compute Route Matrix フィールド マスク

使用するフィールド マスクを決定する

使用するフィールドを決定し、それらのフィールドマスクを構築する方法は次のとおりです。

  1. * のフィールド マスクを使用してすべてのフィールドをリクエストします。
  2. レスポンスで、必要なフィールドのフィールドの階層を確認します。

  3. 次の形式で、前の手順で示したフィールドの階層を使用してフィールド マスクを作成します。

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

たとえば、ルートからの部分的なレスポンスは次のようになります。

"routes": [
    {
        "legs": [
            {  "steps": [
                    {"distanceMeters": 119},
                    {"distanceMeters": 41}  ]
            }
        ],
        "distanceMeters": 160
    }
]

ルート経路の distanceMeters フィールドのみ（上の例の最後の distanceMeters）を返す場合、フィールド マスクは次のようになります。

routes.legs.distanceMeters

代わりに、ルート経路の各ステップの distanceMeters フィールド（上記の例の steps の下の distanceMeters）を返す場合は、フィールド マスクは次のようになります。

routes.legs.steps.distanceMeters

上記の結果で両方を返す場合のフィールド マスクは次のようになります。

routes.legs.distanceMeters,routes.legs.steps.distanceMeters

フィールド マスクパスの例

このセクションでは、REST 呼び出しと gRPC 呼び出しでレスポンス項目マスクの一部として項目パスを指定する方法の例をいくつか示します。

computeRoutes への REST 呼び出し

最初の例では、computeRoutes メソッドへの REST 呼び出しを使用してルートを計算します。この例では、ヘッダーでフィールドマスクを指定して、レスポンスでルート distanceMeters フィールドと duration フィールドを返します。フィールド名の前に routes を付けてください。

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

computeRouteMatrix への REST 呼び出し

ルート マトリックスの計算に使用される REST computeRouteMatrix メソッドの場合、ヘッダーで、出発地と目的地の組み合わせごとに originIndex、destinationIndex、duration を返すように指定します。

X-Goog-FieldMask: originIndex,destinationIndex,duration

gRPC 呼び出し

gRPC の場合は、レスポンス フィールド マスクを含む変数を設定します。その変数をリクエストに渡すことができます。

const (
  fieldMask = "routes.distanceMeters,routes.duration,routes.polyline.encodedPolyline"
)

フィールドパスに関する考慮事項

必要なフィールドのみをレスポンスに含めて、必要なフィールドのみを返します。

  • 処理時間を短縮し、レイテンシを低くして結果を返します。
  • 安定したレイテンシ パフォーマンスを実現。すべてのフィールドを選択した場合、または最上位レベルですべてのフィールドを選択した場合、新しいフィールドが追加されてレスポンスに自動的に含まれると、パフォーマンスが低下する可能性があります。
  • レスポンス サイズが小さくなるため、ネットワーク スループットが向上します。
  • 不要なデータをリクエストしないようにすることで、不要な処理時間と請求額を回避できます。

フィールド マスクの作成の詳細については、field_mask.proto をご覧ください。