このページは Cloud Translation API によって翻訳されました。

返す情報を選択する

ルートまたはルートマトリックスを計算するメソッドを呼び出すときは、レスポンスで返すフィールドをリストして、必要な情報を指定する必要があります。返されるフィールドのデフォルトリストはありません。このリストを省略すると、メソッドはエラーを返します。

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

フィールドマスクの使用は、不要なデータをリクエストしないようにするための優れた設計プラクティスです。これにより、不要な処理時間と課金を回避できます。

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

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

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

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

Routes API で必要な情報が含まれているフィールドを見つけます。詳細については、フィールドの参照をご覧ください。
必要なフィールドのパスを特定し、それらのフィールドマスクを作成します。詳細については、使用するフィールドマスクを決定するをご覧ください。
必要なすべてのフィールドのフィールドマスクを組み合わせ、フィールドマスクをカンマで区切ります。たとえば、ルートレグと各ルートレグステップの所要時間をリクエストするには、両方をカンマで区切って入力します（スペースは入力しないでください）。distanceMeters
```
routes.legs.distanceMeters,routes.legs.steps.duration
```
フィールドマスクを API リクエストとともに送信する。たとえば、cURL リクエストでは、-H と X-Goog-FieldMask を使用してフィールドマスクを指定します。
```
-H X-Goog-FieldMask: routes.legs.distanceMeters,routes.legs.steps.duration
```

例と詳細については、次のセクションをご覧ください。

フィールド参照

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

一方、パラメータの値は、次のように入力する必要があります。たとえば、routingPreference の場合は TRAFFIC_AWARE と入力する必要があります。

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

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

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

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

* のフィールドマスクを使用してすべてのフィールドをリクエストします。
注意: このワイルドカードフィールドマスクは、開発中は必要なフィールドを判断するために使用できますが、本番環境では使用しないでください。本番環境ですべてのフィールドをリクエストすると、コストが増加し、レスポンス時間が長くなります。また、このフィールドマスクには高度な機能が自動的に含まれるため、高度な機能が追加されると費用が想定外に増加する可能性があります。代わりに、費用とリクエスト応答時間を最小限に抑えるために必要なフィールドのみをリクエストします。
レスポンスで、必要なフィールドのフィールドの階層を確認します。
次の形式で、前の手順で示したフィールドの階層を使用してフィールドマスクを作成します。
```
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"
)

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

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

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

注: レスポンスメッセージが解析され、レスポンスメッセージ内のフィールドにデフォルト値が含まれている場合、レスポンスフィールドマスクで指定しても、そのフィールドがレスポンスから省略されることがあります。詳細については、言語ガイド（proto3）をご覧ください。たとえば、ルートマトリックスを計算する場合、レスポンスの distanceMeters フィールドにはデフォルト値の 0 を含めることができます。0 は distanceMeters のデフォルト値であるため、レスポンスから省略されます。

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

ルートトークンをリクエストする

Routes API が生成されたルートのルートトークンを返すようにリクエストする手順は次のとおりです。

ルートトークンを返すために必要な次のパラメータを設定します。
- travelMode を DRIVE に設定する。
- routingPreference を TRAFFIC_AWARE または TRAFFIC_AWARE_OPTIMAL に設定します。
ルートのいずれの地点も via 地点でないことを確認します。
ルートトークンを返すように routes.routeToken フィールドマスクを指定します。
```
X-Goog-FieldMask: routes.routeToken
```

計画したルートのルートトークンは、Navigation SDK で使用できます。詳細については、ルートを計画する（Android）またはルートを計画する（iOS）をご覧ください。

ルートトークンの例

以下は、1 つの出発地、1 つの目的地のルートに対する cURL リクエスト本文の例です。フィールドマスクを使用してルートトークンと、ルートの所要時間、距離、ルートのポリラインをリクエストします。

curl -X POST -d
{"origin":{
    "location": {
        "latLng":{
            "latitude":  -37.8167,
            "longitude": 144.9619
        }
    }
},
"destination":{
    "location": {
        "latLng":{
            "latitude":-37.8155,
            "longitude": 144.9663
        }
    }
},
"routingPreference":"TRAFFIC_AWARE",
"travelMode":"DRIVE"
}
-H 'X-Goog-Api-Key: YOUR_API_KEY' \
-H X-Goog-FieldMask: routes.routeToken,routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline
'https://routes.googleapis.com/directions/v2:computeRoutes'

詳細については、Compute Routes API リファレンスをご覧ください。

返す情報を選択する

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

フィールド参照

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

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

computeRoutes への REST 呼び出し

computeRouteMatrix への REST 呼び出し

gRPC 呼び出し

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

ルートトークンをリクエストする

ルートトークンの例

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

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

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

`computeRoutes` への REST 呼び出し

`computeRouteMatrix` への REST 呼び出し