Como usar tokens de sessão
Os tokens de sessão agrupam as fases de consulta e seleção de uma pesquisa de preenchimento automático do usuário em uma sessão discreta para fins de faturamento. Os exemplos a seguir mostram como usar tokens de sessão nas chamadas Autocomplete (novo) e Place Details (novo).
Criar um token de sessão
Os usuários são responsáveis por gerar tokens de sessão únicos para cada sessão. O Google recomenda o uso da versão 4 dos UUIDs.
Fazer uma solicitação de preenchimento automático (nova)
Uma solicitação de Autocomplete (nova) é uma solicitação HTTP POST. Para mais informações sobre os parâmetros do corpo da solicitação, consulte Place Autocomplete (novo).
A série de solicitações a seguir mostra um usuário pesquisando uma pizzaria em São Francisco. Quando o usuário começa a digitar uma consulta, o preenchimento automático (novo) é chamado para cada tecla pressionada. O token de sessão gerado é transmitido como um parâmetro em cada chamada.
Primeira solicitação e resposta
Solicitação 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
Resposta 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"
]
}
},
]
/ ... /
}
Segunda solicitação e resposta
Solicitação 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
Resposta 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"
]
}
},
/.../
]
}
Terceira solicitação e resposta
Solicitação 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
Resposta 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"
]
}
},
/.../
]
}
Encerrar a sessão
Encerre uma sessão fazendo uma solicitação para o Place Details (New) ou Address Validation e transmitindo o mesmo token de sessão que você usou para as solicitações do Autocomplete (New).
Fazer uma solicitação do Place Details (novo)
Uma solicitação do Place Details (New) é uma solicitação HTTP GET. Para mais informações sobre os parâmetros do corpo da solicitação, consulte Place Details (novo).
A solicitação do Place Details (novo) a seguir inclui o id do lugar selecionado e o sessionToken usado nas chamadas anteriores do Autocomplete (novo).
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
Usando um local id de ChIJ_QJSSfGAhYARQVFJBNKy3HE, a chamada gera a seguinte resposta JSON:
{
"id": "ChIJ_QJSSfGAhYARQVFJBNKy3HE",
"businessStatus": "OPERATIONAL",
"displayName": {
"text": "Pizza By The Slice",
"languageCode": "en"
},
"accessibilityOptions": {
"wheelchairAccessibleParking": false,
"wheelchairAccessibleEntrance": true
}
}
Fazer uma solicitação de validação de endereço
Uma solicitação de validação de endereço é uma solicitação HTTP POST. Para mais informações sobre os parâmetros do corpo da solicitação, consulte Enviar uma solicitação de validação de endereço.
A solicitação de validação de endereço a seguir inclui o endereço do lugar selecionado, encontrado no campotext da resposta do Autocomplete (novo) e o sessionToken usado nas chamadas anteriores do Autocomplete (novo).
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"
A chamada gera a seguinte resposta JSON:
{
"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"
}
Abandonar uma sessão
Uma sessão é encerrada quando o usuário a abandona. Por exemplo, se um usuário começar a procurar uma pizzaria, mas não selecionar um lugar (acionando uma chamada do Place Details (nova)) nem validar o endereço (acionando uma chamada de validação de endereço), a sessão será encerrada e o token de sessão vai expirar.