Introducción
Cuando llamas a los métodos Place Details (nuevo), Nearby Search (nuevo) o Text Search (nuevo), debes especificar qué campos deseas que se muestren en la respuesta. No hay una lista predeterminada de campos devueltos. Si omites esta lista, los métodos mostrarán un error.
Puedes encontrar una lista completa de los campos de datos admitidos y sus SKU correspondientes en Place Data Fields (New). Para obtener información sobre los campos específicos de cada API, consulta lo siguiente:
- Parámetros de FieldMask de Place Details (nuevo)
- Parámetros de FieldMask de Nearby Search (nuevo)
- Parámetros de FieldMask de Text Search (nuevo)
Para especificar la lista de campos, crea una máscara de campo de respuesta. Luego, pasa la máscara de campo de respuesta a cualquiera de los métodos con el parámetro $fields o fields, o bien con el encabezado HTTP o gRPC X-Goog-FieldMask.
El uso de campos enmascarados 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 adicionales.
Cómo definir una máscara de campo de respuesta
La máscara de campo de respuesta es una lista de rutas de acceso separadas por comas, en la que cada ruta especifica un campo único en el cuerpo de la respuesta. La ruta comienza desde el mensaje de respuesta de nivel superior y usa una ruta separada por puntos hasta el campo especificado.
Construye 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 field_mask.proto.
Determina qué máscaras de campo usar
Sigue estos pasos para 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 deseas.
- Crea 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 (nuevo) y Text Search (nuevo) devuelven un array de objetos Place en el campo places de la respuesta. En estas APIs, places es el campo de nivel superior de la respuesta.
Por ejemplo, para ver el objeto de respuesta completo de una búsqueda de texto (nuevo), haz lo siguiente:
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 solo deseas devolver los campos formattedAddress y displayName, configura tu máscara de campo de la siguiente manera:
places.formattedAddress,places.displayName
Si especificas displayName, se incluyen los campos text y language de displayName. Si solo quieres el campo text, configura 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 (nuevo) devuelve 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 indicando los campos del objeto Place que deseas devolver:
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 de gRPC
En el caso de gRPC, establece 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 sobre la ruta del campo
Incluye solo los campos que necesitas en la respuesta. Devuelve solo los campos que necesitas:
- Disminuye los tiempos de procesamiento, por lo que los 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 todos los campos 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 un mayor rendimiento de la red.
- Garantiza que no solicites datos innecesarios, lo que ayuda a evitar tiempos de procesamiento y cargos facturados innecesarios.