選擇要傳回的欄位

呼叫 ComputeRoutes() 方法時，您必須指定要在回應中傳回的欄位。方法是使用回應欄位遮罩，並透過網址參數 $fields 或 fields 提供，或是使用 HTTP/gRPC 標頭 X-Goog-FieldMask。詳情請參閱「系統參數」。

欄位遮罩

欄位遮罩值是以半形逗號分隔的欄位路徑清單。每個欄位路徑都是以半形句號分隔的欄位名稱清單，代表訊息階層。欄位名稱可以是 JSON 物件鍵，也可以是 protobuf 欄位標記名稱。欄位路徑從頂層回應訊息型別開始，後面可選擇性加上一或多個半形句號，然後是下一層的欄位名稱。一般來說，欄位路徑的建構方式如下：

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

特殊情況的欄位遮罩是萬用字元「*」，會選取所有根層級欄位。

範例

以下範例說明如何為 ComputeRoutes() 方法設定欄位遮罩。

範例 1

所有可用欄位的欄位遮罩 (適用於手動檢查)。

X-Goog-FieldMask: *

範例 2

路線層級時間長度、距離和折線的欄位遮罩 (實際工作環境設定範例)。

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

我們不建議在實際工作環境中使用萬用字元 (*) 回應欄位遮罩，或在頂層 (路徑) 指定欄位遮罩。只選取需要的欄位：

  • 讓伺服器節省處理週期，進而以較低的延遲時間傳回結果。

  • 確保延遲效能穩定。我們日後可能會新增更多回應欄位，而這些新欄位可能需要額外的運算時間。如果您選取所有欄位，或是在頂層選取所有欄位，系統可能會自動將我們新增的任何欄位納入回應，導致效能降低。

  • 縮減回應大小，進而提高網路輸送量。

如要進一步瞭解如何建構欄位路徑，請參閱 field_mask.proto。