Utiliser des jetons de session
Les jetons de session regroupent les phases de requête et de sélection d'une recherche de saisie semi-automatique d'un utilisateur dans une session distincte à des fins de facturation. Les exemples suivants montrent comment utiliser des jetons de session dans les appels Autocomplete (New) et Place Details (New).
Créer un jeton de session
Les utilisateurs sont responsables de la génération de jetons de session uniques pour chaque session. Nous vous recommandons d'utiliser la version 4 des UUID.
Envoyer une requête Autocomplete (New)
Une requête Autocomplete (New) est une requête HTTP POST. Pour en savoir plus sur les paramètres du corps de la requête, consultez la section Place Autocomplete (New).
La série de requêtes suivante montre un utilisateur qui recherche une pizzeria à San Francisco. Lorsque l'utilisateur commence à saisir une requête, la saisie semi-automatique (New) est appelée pour chaque frappe. Le jeton de session généré est transmis en tant que paramètre dans chaque appel.
Première requête et réponse
Requête 1
curl -X POST -d '{
"input": "p",
"sessionToken": "3519edfe-0f75-4a30-bfe4-7cbd89340b2c",
"locationBias": {
"circle": {
"center": {
"latitude": 37.7937,
"longitude": -122.3965
},
"radius": 500.0
}
}
}' -H 'Content-Type: application/json' -H "X-Goog-Api-Key: YOUR_API_KEY" \
https://places.googleapis.com/v1/places:autocomplete
Réponse 1
{
"suggestions": [
{
"placePrediction": {
"place": "places/ChIJHSGzi_yAhYARnrPmDWAx9ro",
"placeId": "ChIJHSGzi_yAhYARnrPmDWAx9ro",
"text": {
"text": "PIER 39, The Embarcadero, San Francisco, CA, USA",
"matches": [
{
"endOffset": 1
}
]
},
"structuredFormat": {
"mainText": {
"text": "PIER 39",
"matches": [
{
"endOffset": 1
}
]
},
"secondaryText": {
"text": "The Embarcadero, San Francisco, CA, USA"
}
},
"types": [
"historical_landmark",
"shopping_mall",
"point_of_interest",
"establishment",
"marina",
"tourist_attraction"
]
}
},
]
/ ... /
}
Deuxième requête et réponse
Requête 2
curl -X POST -d '{
"input": "pi",
"sessionToken": "3519edfe-0f75-4a30-bfe4-7cbd89340b2c",
"locationBias": {
"circle": {
"center": {
"latitude": 37.7937,
"longitude": -122.3965
},
"radius": 500.0
}
}
}' -H 'Content-Type: application/json' -H "X-Goog-Api-Key: YOUR_API_KEY" \
https://places.googleapis.com/v1/places:autocomplete
Réponse 2
{
"suggestions": [
{
"placePrediction": {
"place": "places/ChIJHSGzi_yAhYARnrPmDWAx9ro",
"placeId": "ChIJHSGzi_yAhYARnrPmDWAx9ro",
"text": {
"text": "PIER 39, The Embarcadero, San Francisco, CA, USA",
"matches": [
{
"endOffset": 2
}
]
},
"structuredFormat": {
"mainText": {
"text": "PIER 39",
"matches": [
{
"endOffset": 2
}
]
},
"secondaryText": {
"text": "The Embarcadero, San Francisco, CA, USA"
}
},
"types": [
"establishment",
"point_of_interest",
"shopping_mall",
"marina",
"historical_landmark",
"tourist_attraction"
]
}
},
/.../
]
}
Troisième requête et réponse
Requête 3
curl -X POST -d '{
"input": "piz",
"sessionToken": "3519edfe-0f75-4a30-bfe4-7cbd89340b2c",
"locationBias": {
"circle": {
"center": {
"latitude": 37.7937,
"longitude": -122.3965
},
"radius": 500.0
}
}
}' -H 'Content-Type: application/json' -H "X-Goog-Api-Key: YOUR_API_KEY" https://places.googleapis.com/v1/places:autocomplete
Réponse 3
{
"suggestions": [
{
"placePrediction": {
"place": "places/ChIJ_QJSSfGAhYARQVFJBNKy3HE",
"placeId": "ChIJ_QJSSfGAhYARQVFJBNKy3HE",
"text": {
"text": "Pizza By The Slice, Grant Avenue, San Francisco, CA, USA",
"matches": [
{
"endOffset": 3
}
]
},
"structuredFormat": {
"mainText": {
"text": "Pizza By The Slice",
"matches": [
{
"endOffset": 3
}
]
},
"secondaryText": {
"text": "Grant Avenue, San Francisco, CA, USA"
}
},
"types": [
"establishment",
"point_of_interest",
"food",
"pizza_restaurant",
"restaurant"
]
}
},
/.../
]
}
Mettre fin à la session
Pour mettre fin à une session, envoyez une requête à Place Details (New) ou Address Validation, puis transmettez le même jeton de session que celui que vous avez utilisé pour les requêtes Autocomplete (New).
Envoyer une requête Place Details (New)
Une requête Place Details (New) est une requête HTTP GET. Pour en savoir plus sur les paramètres du corps de la requête, consultez la section Place Details (New).
La requête Place Details (New) suivante inclut le id du lieu sélectionné et le sessionToken utilisé dans les précédents appels Autocomplete (New).
curl -X GET -H 'Content-Type: application/json' \ -H "X-Goog-Api-Key: YOUR_API_KEY" \ -H "X-Goog-FieldMask: id,displayName,accessibilityOptions,businessStatus" \ https://places.googleapis.com/v1/places/ChIJ_QJSSfGAhYARQVFJBNKy3HE?sessionToken=3519edfe-0f75-4a30-bfe4-7cbd89340b2c
En utilisant un lieu id défini sur ChIJ_QJSSfGAhYARQVFJBNKy3HE, l'appel génère la réponse JSON suivante:
{
"id": "ChIJ_QJSSfGAhYARQVFJBNKy3HE",
"businessStatus": "OPERATIONAL",
"displayName": {
"text": "Pizza By The Slice",
"languageCode": "en"
},
"accessibilityOptions": {
"wheelchairAccessibleParking": false,
"wheelchairAccessibleEntrance": true
}
}
Envoyer une requête Address Validation
Une requête de validation d’adresse est une requête HTTP POST. Pour en savoir plus sur les paramètres du corps de la requête, consultez la section Envoyer une requête de validation d'adresse.
La requête de validation d'adresse suivante inclut l'adresse du lieu sélectionné, qui se trouve dans le champtext de la réponse Autocomplete (New) et le sessionToken utilisé dans les précédents appels Autocomplete (New).
curl -X POST -d '{
"sessionToken": "3519edfe-0f75-4a30-bfe4-7cbd89340b2c",
"address": {
"addressLines": "Pizza By The Slice, Grant Avenue, San Francisco, CA, USA"
}
}' \
-H 'Content-Type: application/json' \
"https://addressvalidation.googleapis.com/v1:validateAddress?key=YOUR_API_KEY"
L'appel génère la réponse JSON suivante:
{
"result": {
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"hasInferredComponents": true
},
"address": {
"formattedAddress": "Pizza By The Slice, Grant Avenue, San Francisco, CA 94133, USA",
"postalAddress": {
"regionCode": "US",
"languageCode": "en",
"postalCode": "94133",
"administrativeArea": "CA",
"locality": "San Francisco",
"addressLines": [
"Pizza By The Slice",
"Grant Ave"
]
},
"addressComponents": [
{
"componentName": {
"text": "Pizza By The Slice",
"languageCode": "en"
},
"componentType": "point_of_interest",
"confirmationLevel": "CONFIRMED"
},
{
"componentName": {
"text": "Grant Avenue",
"languageCode": "en"
},
"componentType": "route",
"confirmationLevel": "CONFIRMED"
},
{
"componentName": {
"text": "San Francisco",
"languageCode": "en"
},
"componentType": "locality",
"confirmationLevel": "CONFIRMED"
},
{
"componentName": {
"text": "CA",
"languageCode": "en"
},
"componentType": "administrative_area_level_1",
"confirmationLevel": "CONFIRMED"
},
{
"componentName": {
"text": "USA",
"languageCode": "en"
},
"componentType": "country",
"confirmationLevel": "CONFIRMED"
},
{
"componentName": {
"text": "94133"
},
"componentType": "postal_code",
"confirmationLevel": "CONFIRMED",
"inferred": true
}
],
"missingComponentTypes": [
"street_number"
]
},
"geocode": {
"location": {
"latitude": 37.800504,
"longitude": -122.4074794
},
"plusCode": {
"globalCode": "849VRH2V+62"
},
"bounds": {
"low": {
"latitude": 37.800504,
"longitude": -122.4074794
},
"high": {
"latitude": 37.800504,
"longitude": -122.4074794
}
},
"featureSizeMeters": 10,
"placeId": "ChIJ_QJSSfGAhYARQVFJBNKy3HE",
"placeTypes": [
"food",
"restaurant",
"point_of_interest",
"establishment"
]
},
"uspsData": {
"standardizedAddress": {
"firstAddressLine": "PIZZA BY THE SLICE",
"secondAddressLine": "GRANT AVE",
"cityStateZipAddressLine": "SAN FRANCISCO",
"city": "SAN FRANCISCO",
"state": "CA",
"zipCode": "94133"
},
"dpvFootnote": "A1M1",
"postOfficeCity": "SAN FRANCISCO",
"postOfficeState": "CA"
}
},
"responseId": "4b669675-2c3b-463a-ae20-400248cf6ac9"
}
Abandonner une session
Une session prend fin si l'utilisateur la quitte. Par exemple, si un utilisateur commence à rechercher une pizzeria, mais ne sélectionne pas de lieu (ce qui déclenche un appel Place Details (New) et ne valide pas l'adresse (ce qui déclenche un appel de validation d'adresse), la session se termine et le jeton de session expire.