Cuando llamas a los métodos Place Details (New), Nearby Search (New) o Text Search (New), debes especificar qué campos deseas que se muestren en la respuesta. No hay una lista predeterminada de los campos mostrados. Si omites esta lista, los métodos mostrarán un error.
Para especificar la lista de campos, crea una máscara de campo de respuesta. Luego, debes pasar la máscara de campo de respuesta a cualquiera de los métodos con el parámetro $fields o fields, o con el encabezado HTTP o gRPC X-Goog-FieldMask.
El enmascaramiento de campo es una práctica de diseño recomendada para garantizar que no solicites datos innecesarios, lo que ayuda a evitar tiempos de procesamiento y cargos de facturación innecesarios.
Define una máscara de campo de respuesta
La máscara del campo de respuesta es una lista de rutas de acceso separadas por comas, en las 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 una ruta de campo de la siguiente manera:
topLevelField[.secondLevelField][.thirdLevelField][...]
Puedes solicitar todos los campos con una máscara de campo de *.
Para obtener más información sobre cómo construir máscaras de campo, consulta el field_mask.proto.
Determina qué máscaras de campo usar
A continuación, te mostramos cómo puedes determinar qué máscaras de campo deseas usar:
- Solicita todos los campos con una máscara de campo de "*".
- Observa la jerarquía de los campos en la respuesta y determina qué campos quieres.
- Compila tu máscara de campo con la jerarquía de campos.
Cómo definir una máscara de campo de respuesta para Nearby Search (nuevo) y Text Search (nuevo)
Nearby Search (nueva) y Text Search (nueva) muestran un array de objetos Place en el campo places de la respuesta. Para estas APIs, places es el campo de nivel superior de la respuesta.
Por ejemplo, para ver el objeto de respuesta completo de Text Search (nuevo), ejecuta el siguiente comando:
curl -X POST -d '{
"textQuery" : "Spicy Vegetarian Food in Sydney, Australia"
}' \
-H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \
-H 'X-Goog-FieldMask: *' \
'https://places.googleapis.com/v1/places:searchText'
El objeto de respuesta completo de una llamada a Text Search (nuevo) tiene el siguiente formato:
{
"places": [
{
"name": "places/ChIJs5ydyTiuEmsR0fRSlU0C7k0",
"id": "ChIJs5ydyTiuEmsR0fRSlU0C7k0",
"types": [
"vegetarian_restaurant",
"vegan_restaurant",
"meal_takeaway",
"restaurant",
"food",
"point_of_interest",
"establishment"
],
"nationalPhoneNumber": "0433 479 794",
"internationalPhoneNumber": "+61 433 479 794",
"formattedAddress": "29 King St, Sydney NSW 2000, Australia",
"displayName": {
"text": "Spiced @ Barangaroo",
"languageCode": "en"
}, ...
},
...
]
}
Por lo tanto, debes especificar una máscara de campo para estas APIs de la siguiente manera:
places[.secondLevelField][.thirdLevelField][...]
Si deseas mostrar solo los campos formattedAddress y displayName, establece la máscara de campo de la siguiente manera:
places.formattedAddress,places.displayName
La especificación de displayName incluye los campos text y language de displayName. Si solo quieres el campo text, establece la máscara de campo de la siguiente manera:
places.formattedAddress,places.displayName.text
Cómo definir una máscara de campo de respuesta para Place Details (nuevo)
Place Details muestra un solo objeto Place con el siguiente formato:
{
"name": "places/ChIJkR8FdQNB0VQRm64T_lv1g1g",
"id": "ChIJkR8FdQNB0VQRm64T_lv1g1g",
"types": [
"locality",
"political"
],
"formattedAddress": "Trinidad, CA 95570, USA",
"displayName": {
"text": "Trinidad",
"languageCode": "en"
}
...
}
Por lo tanto, debes especificar una máscara de campo para esta API. Para ello, especifica los campos del objeto Place que deseas mostrar:
curl -X GET -H 'Content-Type: application/json' \ -H "X-Goog-Api-Key: API_KEY" \ -H "X-Goog-FieldMask: formattedAddress,displayName" \ https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw
Llamada a gRPC
Para gRPC, configura una variable que contenga la máscara de campo de respuesta. Luego, puedes pasar esa variable a la solicitud.
const ( fieldMask = "places.formattedAddress,places.displayName" )
Consideraciones de las rutas de campo
Incluye solo los campos que necesites en la respuesta. Muestra solo los campos que necesitas:
- Reduce los tiempos de procesamiento, por lo que tus resultados se devuelven con una latencia más baja.
- Garantiza un rendimiento de latencia estable si la API agrega más campos de respuesta en el futuro, y esos campos nuevos requieren tiempo de procesamiento adicional. Si seleccionas todos los campos, o si lo haces en el nivel superior, es posible que experimentes una degradación del rendimiento cuando todos los campos nuevos se incluyan automáticamente en tu respuesta.
- Genera un tamaño de respuesta más pequeño, lo que se traduce en una mayor capacidad de procesamiento de la red.
- Se asegura de no solicitar datos innecesarios, lo que ayuda a evitar tiempos de procesamiento y cargos facturados innecesarios.