Sitzungstokens verwenden
Sitzungstokens fassen die Abfrage- und Auswahlphasen einer automatischen Vervollständigung durch den Nutzer zu Abrechnungszwecken zu einer separaten Sitzung zusammen. Die folgenden Beispiele zeigen, wie Sitzungstokens in Autocomplete (New)- und Place Details-Aufrufen (New) verwendet werden.
Sitzungstoken erstellen
Die Nutzer sind dafür verantwortlich, für jede Sitzung eindeutige Sitzungstokens zu generieren. Google empfiehlt die Verwendung von UUIDs der Version 4.
Autocomplete (New)-Anfrage stellen
Eine Autocomplete (New)-Anfrage ist eine HTTP POST-Anfrage. Weitere Informationen zu Anfragetextparametern finden Sie unter Place Autocomplete (New)-Anfragen.
In der folgenden Anfrageserie sucht ein Nutzer nach einer Pizzeria in San Francisco. Sobald der Nutzer mit der Eingabe einer Abfrage beginnt, wird für jeden Tastenanschlag „Autocomplete (New)“ aufgerufen. Das generierte Sitzungstoken wird bei jedem Aufruf als Parameter übergeben.
Erste Anfrage und Antwort
Anfrage 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
Antwort 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"
]
}
},
]
/ ... /
}
Zweite Anfrage und Antwort
Anfrage 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
Antwort 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"
]
}
},
/.../
]
}
Dritte Anfrage und Antwort
Anfrage 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
Antwort 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"
]
}
},
/.../
]
}
Sitzung beenden
Sie können eine Sitzung beenden, indem Sie eine Anfrage an „Place Details (New)“ oder „Address Validation“ stellen und dasselbe Sitzungstoken übergeben, das Sie für die „Autocomplete“-Anfragen (New) verwendet haben.
„Place Details (New)“-Anfrage stellen
Eine „Place Details (New)“-Anfrage ist eine HTTP GET-Anfrage. Weitere Informationen zu Anfragetextparametern finden Sie unter Place Details (New)-Anfragen.
Die folgende „Place Details (New)“-Anfrage enthält die id des ausgewählten Orts und die sessionToken, die in früheren Aufrufen der Funktion „Autocomplete (New)“ verwendet wurden.
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
Mit dem Ort id von ChIJ_QJSSfGAhYARQVFJBNKy3HE generiert der Aufruf die folgende JSON-Antwort:
{
"id": "ChIJ_QJSSfGAhYARQVFJBNKy3HE",
"businessStatus": "OPERATIONAL",
"displayName": {
"text": "Pizza By The Slice",
"languageCode": "en"
},
"accessibilityOptions": {
"wheelchairAccessibleParking": false,
"wheelchairAccessibleEntrance": true
}
}
Anfrage zur Adressüberprüfung stellen
Eine Adressüberprüfungsanfrage ist eine HTTP-POST-Anfrage. Weitere Informationen zu Parametern für den Anfragetext finden Sie unter Anfrage zur Adressüberprüfung senden.
Die folgende Anfrage zur Adressüberprüfung enthält die Adresse des ausgewählten Orts aus dem Feldtext der Antwort der automatischen Vervollständigung (New) und die sessionToken, die in früheren Aufrufen der automatischen Vervollständigung („Neu“) verwendet wurde.
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"
Der Aufruf generiert die folgende JSON-Antwort:
{
"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"
}
Sitzung beenden
Eine Sitzung wird beendet, wenn der Nutzer sie abbricht. Wenn ein Nutzer beispielsweise mit der Suche nach einer Pizzeria beginnt, aber keinen Ort auswählt (der einen „Place Details (New)“-Aufruf auslöst) oder die Adresse validiert (durch einen Aufruf zur Adressüberprüfung), wird die Sitzung beendet und das Sitzungstoken läuft ab.