Elige los campos que quieres mostrar

Cuando solicitas una ruta o una matriz de rutas, debes usar una máscara de campo para especificar qué información debe mostrar la respuesta. No hay una lista predeterminada de campos que se muestran. Si no especificas una máscara de campo, los métodos mostrarán un error.

El uso de una máscara de campo también garantiza que no solicites datos innecesarios, lo que, a su vez, ayuda con la latencia de la respuesta y evita cargos innecesarios por información que tu sistema no necesita.

Especifica la lista de los campos que necesitas en una máscara de campo de respuesta. Luego, pasa la máscara del campo de respuesta a cualquiera de los métodos con el parámetro de URL $fields o fields, o con el encabezado HTTP o gRPC X-Goog-FieldMask.

Para obtener más información sobre los parámetros de URL, consulta Parámetros del sistema.

Define una máscara de campo de respuesta

La máscara de campo de respuesta es una lista de rutas separadas por comas, en la que cada ruta especifica un campo único en el mensaje de respuesta. La ruta de acceso comienza en el mensaje de respuesta de nivel superior y usa una ruta de acceso separada por puntos al campo especificado.

Crea y especifica una ruta de acceso de campo de la siguiente manera:

1. Busca los campos que contienen la información que necesitas en la API de Routes. Para obtener más detalles, consulta Referencias de campos.
2. Determina las rutas de los campos que necesitas y crea las máscaras de campo para ellos: Para obtener más información, consulta Determina qué máscara de campo quieres usar.

3. Combina las máscaras de campo de todos los campos que necesites y sepáralas con comas. Por ejemplo, para solicitar el distanceMeters del tramo de ruta, además de la duración de cada paso del tramo, ingresa ambos, separados por una coma, sin espacios:

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

4. Envía la máscara de campo con tu solicitud a la API. Por ejemplo, en una solicitud de cURL, especificarías la máscara de campo con -H y X-Goog-FieldMask:

   -H X-Goog-FieldMask: routes.legs.distanceMeters,routes.legs.steps.duration

Para ver ejemplos y más detalles, consulta las siguientes secciones.

Referencias de campos

Para ver los campos que puedes solicitar en una respuesta a través de máscaras de campo, consulta las referencias de la API de Routes vinculadas en la siguiente lista. Especifica los campos en mayúsculas y minúsculas, como se muestra en la referencia. Por ejemplo, routePreference.

En cambio, debes ingresar los valores de los parámetros como se muestra. Por ejemplo, para routingPreference, debes ingresar TRAFFIC_AWARE.

Estas referencias incluyen los campos que están disponibles. Sin embargo, debes consultar la jerarquía de los campos para determinar la ruta de acceso completa de la máscara de campo. Para obtener detalles sobre cómo obtener la jerarquía de los campos, consulta Determina qué máscara de campo deseas usar.

• Cómo calcular la máscara de campo de ruta
  • REST: Especifica los campos del objeto Route en la respuesta que se mostrará, con el prefijo routes., por ejemplo, routes.distanceMeters.
  • gRPC: Especifica los campos del objeto Route en la respuesta que se mostrará.
• Máscaras de campo de la matriz de rutas de Compute
  • REST: Especifica los campos del cuerpo de la respuesta que se mostrarán.
  • gRPC: Especifica los campos del objeto RouteMatrixElement en la respuesta que se mostrará.

Determina qué máscaras de campo usar

Sigue estos pasos para determinar qué campos deseas usar y construir las máscaras de campo para ellos:

1. Solicita todos los campos con una máscara de campo de *.
   Precaución: Si bien puedes usar esta máscara de campo de comodines durante el desarrollo para determinar qué campos necesitas, no la uses en producción. Solicitar todos los campos en producción genera costos más altos y tiempos de respuesta más largos. Es posible que tu costo también aumente de forma inesperada a medida que se agreguen más funciones avanzadas, ya que esta máscara de campo las incluirá automáticamente. En su lugar, solicita solo los campos que necesitas para minimizar los costos y el tiempo de respuesta.
2. Observa la jerarquía de los campos en la respuesta para los campos que deseas.

3. Crea tus máscaras de campo con la jerarquía de los campos que se muestra en el paso anterior, con este formato:

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

   Nota: No uses espacios en la lista de rutas de acceso de campo.

Por ejemplo, para esta respuesta parcial de una ruta:

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

Si deseas mostrar solo el campo distanceMeters para el tramo de la ruta, es decir, el último distanceMeters del ejemplo anterior, tu máscara de campo es la siguiente:

routes.legs.distanceMeters

Si, en cambio, deseas mostrar el campo distanceMeters para cada paso de la etapa de la ruta, es decir, el distanceMeters debajo de steps en el ejemplo anterior, tu máscara de campo es la siguiente:

routes.legs.steps.distanceMeters

Si deseas mostrar ambos, con el resultado anterior, tu máscara de campo es la siguiente:

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

Ejemplos de rutas de máscaras de campo

Esta sección contiene más ejemplos sobre cómo especificar una ruta de campo como parte de una máscara de campo de respuesta en llamadas REST y gRPC.

Llamada REST a computeRoutes

En el primer ejemplo, usas una llamada REST al método computeRoutes para calcular una ruta. En este ejemplo, en el encabezado, especificas máscaras de campo para mostrar los campos distanceMeters y duration de la ruta en la respuesta. Recuerda agregar el prefijo routes al nombre del campo.

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

Llamada REST a computeRouteMatrix

Para el método computeRouteMatrix de REST que se usa para calcular una matriz de rutas, en el encabezado, especifica que se devuelvan originIndex, destinationIndex y duration para cada combinación de origen y destino:

X-Goog-FieldMask: originIndex,destinationIndex,duration

Llamada a gRPC

Para gRPC, establece una variable que contenga la máscara de campo de respuesta. Luego, puedes pasar esa variable a la solicitud.

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

Consideraciones sobre las rutas de campo

Incluye solo los campos que necesitas en la respuesta para que se muestren solo los campos que necesitas:

• Disminuye los tiempos de procesamiento, por lo que los resultados se muestran con una latencia más baja.
• Garantiza un rendimiento de latencia estable. Si seleccionas todos los campos o todos los campos en el nivel superior, es posible que experimentes una degradación del rendimiento cuando se agreguen campos nuevos y, luego, se incluyan automáticamente en tu respuesta.
• Produce un tamaño de respuesta más pequeño, lo que se traduce en una mayor capacidad de procesamiento de red.
• Garantiza que no solicites datos innecesarios, lo que ayuda a evitar tiempos de procesamiento y cargos de facturación adicionales.

Nota: Cuando se analiza un mensaje de respuesta y un campo en el mensaje de respuesta contiene su valor predeterminado, es posible que se omita el campo de la respuesta, incluso si lo especificaste en la máscara de campo de respuesta. Para obtener más información, consulta la guía de lenguaje (proto3). Por ejemplo, cuando calculas una matriz de rutas, el campo distanceMeters de la respuesta puede contener un valor de 0, su valor predeterminado. Como 0 es el valor predeterminado de distanceMeters, se omite de la respuesta.

Para obtener más detalles sobre la construcción de una máscara de campo, consulta field_mask.proto.