Quando chiami i metodi Place Details (New), Nearby Search (New) o Text Search (New), devi specificare quali campi vuoi che vengano restituiti nella risposta. Non esiste un elenco predefinito dei campi restituiti. Se ometti questo elenco, i metodi restituiscono un errore.
L'elenco dei campi viene specificato creando una maschera del campo di risposta. Successivamente, passi la maschera del campo di risposta a uno dei due metodi utilizzando il parametro $fields o fields oppure l'intestazione HTTP o gRPC X-Goog-FieldMask.
Il mascheramento dei campi è una buona pratica di progettazione per garantire di non richiedere dati superflui, il che contribuisce a evitare tempi di elaborazione e addebiti di fatturazione superflui.
Definisci una maschera per il campo della risposta
La maschera del campo della risposta è un elenco di percorsi separati da virgole, in cui ogni percorso specifica un campo univoco nel messaggio di risposta. Il percorso inizia dal messaggio di risposta di primo livello e utilizza un percorso separato da punti per il campo specificato.
Crea un percorso di campo nel seguente modo:
topLevelField[.secondLevelField][.thirdLevelField][...]
Puoi richiedere tutti i campi utilizzando una maschera di campo *.
Per ulteriori informazioni su come creare le maschere dei campi, consulta field_mask.proto.
Stabilire quali maschere di campo utilizzare
Per determinare quali maschere per i campi vuoi utilizzare:
- Richiedi tutti i campi utilizzando una maschera di campo "*".
- Osserva la gerarchia dei campi nella risposta e determina quali campi vuoi.
- Crea la maschera del campo utilizzando la gerarchia dei campi.
Definisci una maschera del campo della risposta per la ricerca nelle vicinanze (nuova) e la ricerca testuale (nuova)
Nearby Search (new) e Text Search (New) restituiscono un array di oggetti Place nel campo places della risposta. Per queste API, places è il campo di primo livello della risposta.
Ad esempio, per visualizzare l'oggetto di risposta completo da una Ricerca testuale (Nuovo):
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'
L'oggetto di risposta completo da una chiamata di ricerca testuale (nuova) è nel 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"
}, ...
},
...
]
}
Di conseguenza, devi specificare una maschera di campo per queste API nel formato:
places[.secondLevelField][.thirdLevelField][...]
Se vuoi restituire solo i campi formattedAddress e displayName, imposta
la maschera del campo su:
places.formattedAddress,places.displayName
Se specifichi displayName, vengono inclusi entrambi i campi text e language di
displayName. Se vuoi solo il campo text, imposta la maschera del campo come:
places.formattedAddress,places.displayName.text
Definisci una maschera del campo di risposta per i dettagli del luogo (novità)
Place Details restituisce un singolo oggetto Place nel formato:
{
"name": "places/ChIJkR8FdQNB0VQRm64T_lv1g1g",
"id": "ChIJkR8FdQNB0VQRm64T_lv1g1g",
"types": [
"locality",
"political"
],
"formattedAddress": "Trinidad, CA 95570, USA",
"displayName": {
"text": "Trinidad",
"languageCode": "en"
}
...
}
Di conseguenza, devi specificare una maschera di campo per questa API specificando i campi dell'oggetto Place che vuoi restituire:
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
Chiamata gRPC
Per gRPC, imposta una variabile contenente la maschera del campo di risposta. Puoi quindi passare questa variabile alla richiesta.
const ( fieldMask = "places.formattedAddress,places.displayName" )
Considerazioni sui percorsi dei campi
Includi nella risposta solo i campi obbligatori. Per restituire solo i campi che ti servono:
- Riduce i tempi di elaborazione, in modo che i risultati vengano restituiti con una latenza inferiore.
- Garantisce prestazioni di latenza stabili se l'API aggiunge altri campi di risposta in futuro e questi nuovi campi richiedono tempo di calcolo aggiuntivo. Se selezioni tutti i campi o tutti i campi al livello superiore, potresti riscontrare un peggioramento delle prestazioni quando tutti i nuovi campi vengono inclusi automaticamente nella risposta.
- Genera una risposta di dimensioni inferiori, che si traduce in una velocità effettiva di rete maggiore.
- Garantisce di non richiedere dati inutili, il che contribuisce a evitare tempi di elaborazione e addebiti fatturati inutili.