מבוא
ההשלמה האוטומטית (חדשה) היא שירות אינטרנט שמחזיר חיזויים של מקומות וחיזויים של שאילתות בתגובה לבקשת HTTP. בבקשה, מציינים מחרוזת לחיפוש טקסט וגבולות גיאוגרפיים ששולטים באזור החיפוש.
התכונה Autocomplete (חדש) יכולה להתאים מילים מלאות ומחרוזות משנה של הקלט, ולפתור שמות של מקומות, כתובות וקודי פלוס. לכן אפליקציות יכולות לשלוח שאילתות בזמן שהמשתמש מקליד, כדי לספק תחזיות של מקומות ושאילתות בזמן אמת.
התשובה של Autocomplete (חדש) יכולה להכיל שני סוגים של תחזיות:
- חיזוי מקומות: מקומות, כמו עסקים, כתובות ונקודות עניין, על סמך מחרוזת טקסט הקלט שצוינה ואזור החיפוש. החיזויים של מקומות מוחזרים כברירת מחדל.
- תחזיות לשאילתות: מחרוזות של שאילתות שתואמות למחרוזת הטקסט שהוזנה ולאזור החיפוש. כברירת מחדל, לא מוחזרות תחזיות לשאילתות. משתמשים בפרמטר הבקשה
includeQueryPredictionsכדי להוסיף לתשובה תחזיות של שאילתות.
לדוגמה, אתם קוראים ל-Autocomplete (New) באמצעות מחרוזת קלט שמכילה קלט חלקי של משתמשים, Sicilian piz, כאשר אזור החיפוש מוגבל לסן פרנסיסקו, קליפורניה. התשובה מכילה רשימה של תחזיות לגבי מקומות שתואמות למחרוזת החיפוש ולאזור החיפוש, כמו המסעדה Sicilian Pizza Kitchen, וגם פרטים על המקום.
התחזיות לגבי מקומות שמוחזרות נועדו להצגה למשתמש כדי לעזור לו לבחור את המקום הרצוי. אפשר לשלוח בקשה לפרטי מקום (חדש) כדי לקבל מידע נוסף על כל אחת מהתחזיות לגבי מקומות שמוחזרות.
התשובה יכולה לכלול גם רשימה של תחזיות לשאילתות שתואמות למחרוזת החיפוש ולאזור החיפוש, כמו 'פיצה ופסטה סיציליאנית'. כל תחזית לשאילתה בתגובה כוללת את השדה text שמכיל מחרוזת טקסט מומלצת לחיפוש. אפשר להשתמש במחרוזת הזו כקלט לחיפוש טקסט (חדש) כדי לבצע חיפוש מפורט יותר.
APIs Explorer מאפשר לכם לשלוח בקשות בזמן אמת כדי להכיר את ה-API ואת האפשרויות שלו:
בקשות להשלמה אוטומטית (חדש)
בקשה להשלמה אוטומטית (חדשה) היא בקשת HTTP POST לכתובת URL בתבנית הבאה:
https://places.googleapis.com/v1/places:autocomplete
מעבירים את כל הפרמטרים בגוף הבקשה בפורמט JSON או בכותרות כחלק מבקשת ה-POST. לדוגמה:
curl -X POST -d '{
"input": "pizza",
"locationBias": {
"circle": {
"center": {
"latitude": 37.7937,
"longitude": -122.3965
},
"radius": 500.0
}
}
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete
פרמטרים נתמכים
פרמטר |
תיאור |
|---|---|
מחרוזת טקסט לחיפוש (מילים מלאות, מחרוזות משנה, שמות מקומות, כתובות, Plus Codes). |
|
|
רשימה מופרדת בפסיקים שמציינת אילו שדות להחזיר בתשובה. |
הגבלת התוצאות למקומות שתואמים לאחד מתוך עד חמישה סוגים ראשיים שצוינו. |
|
אם הערך הוא true, התוצאות כוללות עסקים ללא מיקום פיזי (עסקים שנותנים שירות באזור מוגדר). ברירת המחדל היא False. |
|
אם הערך הוא true, התשובה כוללת גם תחזיות של מקומות וגם תחזיות של שאילתות. ברירת המחדל היא False. |
|
מערך של עד 15 קודי מדינה בני שני תווים להגבלת התוצאות. |
|
ההיסט של תו Unicode מבוסס-אפס של מיקום הסמן במחרוזת הקלט, שמשפיע על התחזיות. ברירת המחדל היא אורך הקלט. |
|
השפה המועדפת (קוד IETF BCP-47) לתוצאות. ברירת המחדל היא כותרת Accept-Language או 'en'. |
|
מציין אזור (מעגל או מלבן) שתוצאות החיפוש יתמקדו בו, אבל מאפשר גם תוצאות מחוץ לאזור. אי אפשר להשתמש בפרמטר הזה עם locationRestriction. |
|
מציין אזור (עיגול או מלבן) להגבלת תוצאות החיפוש. התוצאות מחוץ לאזור הזה לא נכללות. אי אפשר להשתמש בפרמטר הזה עם locationBias. |
|
נקודת המוצא (קו רוחב, קו אורך) שמשמשת לחישוב המרחק בקו ישר (distanceMeters) ליעדים הצפויים. |
|
קוד אזור שמשמש לעיצוב התשובה ולהטיית ההצעות (לדוגמה, uk, fr). |
|
מחרוזת שנוצרת על ידי המשתמש כדי לקבץ קריאות של השלמה אוטומטית לסשן לצורכי חיוב. |
מידע על התשובה
ההשלמה האוטומטית (חדשה) מחזירה אובייקט JSON כתגובה. בתשובה:
- המערך
suggestionsמכיל את כל המקומות והשאילתות שהמערכת ניבאה, לפי הסדר, על סמך מידת הרלוונטיות שלהם. כל מקום מיוצג על ידי השדהplacePredictionוכל שאילתה מיוצגת על ידי השדהqueryPrediction. - שדה
placePredictionמכיל מידע מפורט על חיזוי של מקום יחיד, כולל מזהה המקום ותיאור טקסטואלי. - שדה
queryPredictionמכיל מידע מפורט על חיזוי שאילתה יחיד.
אובייקט ה-JSON המלא הוא בפורמט:
{
"suggestions": [
{
"placePrediction": {
"place": "places/ChIJ5YQQf1GHhYARPKG7WLIaOko",
"placeId": "ChIJ5YQQf1GHhYARPKG7WLIaOko",
"text": {
"text": "Amoeba Music, Haight Street, San Francisco, CA, USA",
"matches": [
{
"endOffset": 6
}]
},
...
},
{
"queryPrediction": {
"text": {
"text": "Amoeba Music",
"matches": [
{
"endOffset": 6
}]
},
...
}
...]
}פרמטרים נדרשים
-
קלט
מחרוזת הטקסט שבה יתבצע החיפוש. מציינים מילים מלאות ותת-מחרוזות, שמות של מקומות, כתובות וקודי מיקום. שירות ההשלמה האוטומטית (חדש) מחזיר התאמות אפשריות על סמך המחרוזת הזו ומסדר את התוצאות לפי מידת הרלוונטיות שלהן.
פרמטרים אופציונליים
-
FieldMask
כדי לציין את רשימת השדות שיוחזרו בתגובה, יוצרים מסכת שדות של תגובה. מעבירים את מסכת שדות התגובה לשיטה באמצעות כותרת ה-HTTP
X-Goog-FieldMask.מציינים רשימה של שדות של הצעות שיוחזרו, מופרדים בפסיקים. לדוגמה, כדי לאחזר את
suggestions.placePrediction.text.textואתsuggestions.queryPrediction.text.textשל ההצעה.X-Goog-FieldMask: suggestions.placePrediction.text.text,suggestions.queryPrediction.text.text
כדי לאחזר את כל השדות, משתמשים ב-
*.X-Goog-FieldMask: *
-
includeFutureOpeningBusinesses
אם
true, מחזירה עסקים שצפויים להיפתח בעתיד. ברירת המחדל היאfalse. -
includedPrimaryTypes
לכל מקום יכול להיות סוג ראשי אחד בלבד מתוך הסוגים שמפורטים בטבלה א' או בטבלה ב'. לדוגמה, יכול להיות שהסוג הראשי יהיה
"mexican_restaurant"או"steak_house".כברירת מחדל, ה-API מחזיר את כל המקומות על סמך הפרמטר
input, ללא קשר לערך הסוג הראשי שמשויך למקום. כדי להגביל את התוצאות לסוג ראשי מסוים או לסוגים ראשיים מסוימים, צריך להעביר את הפרמטרincludedPrimaryTypes.משתמשים בפרמטר הזה כדי לציין עד חמישה ערכי סוג מטבלה א' או מטבלה ב'. כדי שמקום ייכלל בתשובה, הוא צריך להתאים לאחד מהערכים שצוינו לסוג הראשי.
הפרמטר הזה יכול לכלול גם את הערכים
(regions)או(cities). המסננים של אוסף הסוגים(regions)הם אזורים או חלוקות, כמו שכונות ומיקודים. המסנן(cities)type collection מסנן מקומות ש-Google מזהה כערים.הבקשה נדחית עם השגיאה
INVALID_REQUESTאם:- צוינו יותר מחמישה סוגים.
- צוין סוג כלשהו בנוסף ל-
(cities)או ל-(regions). - מצוינים סוגים לא מזוהים.
-
includePureServiceAreaBusinesses
אם הערך הוא
true, התשובה כוללת עסקים שמגיעים ישירות אל הלקוחות או מבצעים אליהם משלוחים, אבל אין להם מיקום פיזי של העסק. אם הערך מוגדר ל-false, ה-API מחזיר רק עסקים עם מיקום פיזי. -
includeQueryPredictions
אם הערך הוא
true, התשובה כוללת גם תחזיות של מקומות וגם תחזיות של שאילתות. ערך ברירת המחדל הואfalse, כלומר התשובה כוללת רק תחזיות של מקומות. -
includedRegionCodes
כולל רק תוצאות מהרשימה של האזורים שצוינו, שמוגדרים כמערך של עד 15 ערכים של ccTLD (דומיין ברמה העליונה) באורך שני תווים. אם לא מציינים את הפרמטר הזה, לא מוחלות הגבלות על התשובה. לדוגמה, כדי להגביל את האזורים לגרמניה ולצרפת:
"includedRegionCodes": ["de", "fr"]
אם מציינים גם
locationRestrictionוגםincludedRegionCodes, התוצאות ממוקמות באזור החיתוך של שתי ההגדרות. -
inputOffset
ההיסט של תו Unicode מבוסס-אפס שמציין את מיקום הסמן ב-
input. מיקום הסמן יכול להשפיע על התחזיות שמוחזרות. אם השדה ריק, ברירת המחדל היא האורך שלinput. -
languageCode
השפה המועדפת שבה יוחזרו התוצאות. יכול להיות שהתוצאות יהיו בשפות שונות אם השפה שבה נעשה שימוש ב-
inputשונה מהערך שצוין ב-languageCode, או אם אין תרגום למקום שהוחזר מהשפה המקומית ל-languageCode.- כדי לציין את השפה המועדפת, צריך להשתמש בקודי שפה של IETF BCP-47.
-
אם לא מספקים את
languageCode, ה-API משתמש בערך שצוין בכותרתAccept-Language. אם לא מציינים אף אחת מהן, ברירת המחדל היאen. אם מציינים קוד שפה לא תקין, ה-API מחזיר שגיאהINVALID_ARGUMENT. - לשפה המועדפת יש השפעה קטנה על קבוצת התוצאות שממשק ה-API בוחר להחזיר, ועל הסדר שבו הן מוחזרות. הדבר משפיע גם על היכולת של ה-API לתקן שגיאות איות.
-
ה-API מנסה לספק כתובת רחוב שגם המשתמש וגם האוכלוסייה המקומית יכולים לקרוא, וגם לשקף את הקלט של המשתמש. הפורמט של תחזיות המיקום משתנה בהתאם לקלט של המשתמש בכל בקשה.
-
המונחים התואמים בפרמטר
inputנבחרים קודם, באמצעות שמות שתואמים להעדפת השפה שצוינה בפרמטרlanguageCode, אם יש כאלה. אחרת, המערכת משתמשת בשמות שהכי מתאימים לקלט של המשתמש. -
כתובות רחוב מעוצבות בשפה המקומית, בסקריפט שקריא למשתמש
כשאפשר, רק אחרי שנבחרו מונחים תואמים למונחים בפרמטר
input. -
כל הכתובות האחרות מוחזרות בשפה המועדפת, אחרי שנבחרו מונחים תואמים למונחים בפרמטר
input. אם השם לא זמין בשפה המועדפת, ה-API משתמש בהתאמה הקרובה ביותר.
-
המונחים התואמים בפרמטר
locationBias או locationRestriction
אפשר לציין
Autocomplete (חדש) משתמש בכתובת ה-IP של המכשיר כדי להטות את התוצאות.locationBiasאוlocationRestriction, אבל לא את שניהם, כדי להגדיר את אזור החיפוש. אפשר לחשוב עלlocationRestrictionכהגדרה של האזור שבו התוצאות צריכות להיות, ועלlocationBiasכהגדרה של האזור שבו התוצאות צריכות להיות קרובות, אבל יכולות להיות מחוץ לאזור.locationBias
מציין אזור לחיפוש. המיקום הזה משמש כהטיה, כלומר יכול להיות שיוחזרו תוצאות שמסביב למיקום הנתון, כולל תוצאות מחוץ לאזור שצוין.
locationRestriction
מציין אזור לחיפוש. לא יוחזרו תוצאות מחוץ לאזור שצוין.
מציינים את אזור
locationBiasאוlocationRestrictionכחלון תצוגה מלבני או כעיגול.מעגל מוגדר על ידי נקודת מרכז ורדיוס במטרים. הרדיוס חייב להיות בין 0.0 ל-50,000.0, כולל. ערך ברירת המחדל הוא 0.0. במקרה של
locationRestriction, צריך להגדיר את הרדיוס לערך שגדול מ-0.0. אחרת, הבקשה לא תחזיר תוצאות.לדוגמה:
"locationBias": { "circle": { "center": { "latitude": 37.7937, "longitude": -122.3965 }, "radius": 500.0 } }
מלבן הוא אזור תצוגה של קווי רוחב ואורך, שמיוצג על ידי שתי נקודות
lowונקודות גבוהות שממוקמות באלכסון זו מול זו. אזור התצוגה נחשב לאזור סגור, כלומר הוא כולל את הגבול שלו. הגבולות של קו הרוחב צריכים להיות בין 90- ל-90 מעלות, כולל, והגבולות של קו האורך צריכים להיות בין 180- ל-180 מעלות, כולל:- אם
low=high, אזור התצוגה מורכב מהנקודה היחידה הזו. - אם
low.longitude>high.longitude, טווח קווי האורך הפוך (אזור התצוגה חוצה את קו האורך 180 מעלות). - אם
low.longitude= -180 מעלות ו-high.longitude= 180 מעלות, אז אזור התצוגה כולל את כל קווי האורך. - אם
low.longitude= 180 מעלות ו-high.longitude= -180 מעלות, טווח קווי האורך ריק.
חובה למלא את השדות
lowו-high, והתיבה שמייצגת את הנתונים לא יכולה להיות ריקה. אם אזור התצוגה ריק, תופיע שגיאה.לדוגמה, אזור התצוגה הזה כולל את כל העיר ניו יורק:
"locationBias": { "rectangle": { "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } } }
- אם
-
origin
נקודת המוצא שממנה יחושב המרחק בקו ישר ליעד (מוחזר כ-
distanceMeters). אם הערך הזה לא מצוין, המרחק בקו ישר לא יוחזר. חובה לציין את הקואורדינטות של קו הרוחב וקו האורך באופן הבא:"origin": { "latitude": 40.477398, "longitude": -74.259087 }
-
regionCode
קוד האזור שמשמש לעיצוב התשובה, שמוגדר כערך של שני תווים של ccTLD (דומיין ברמה העליונה). רוב קודי ה-ccTLD זהים לקודי ISO 3166-1, עם כמה יוצאים מן הכלל. לדוגמה, ה-ccTLD של בריטניה הוא uk (.co.uk), אבל קוד ISO 3166-1 שלה הוא gb (טכנית, עבור הישות 'ממלכת בריטניה הגדולה וצפון אירלנד').
ההצעות מוטות גם על סמך קודי אזורים. Google ממליצה להגדיר את התג
regionCodeבהתאם להעדפה האזורית של המשתמש.אם מציינים קוד אזור לא תקין, ה-API מחזיר שגיאה מסוג
INVALID_ARGUMENT. הפרמטר יכול להשפיע על התוצאות בהתאם לדין החל. -
sessionToken
אסימוני סשן הם מחרוזות שנוצרות על ידי המשתמש ועוקבות אחרי קריאות ל'השלמה אוטומטית (חדשה)' כ'סשנים'. התכונה 'השלמה אוטומטית (חדש)' משתמשת בטוקנים של סשנים כדי לקבץ את שלבי השאילתה והבחירה של חיפוש השלמה אוטומטית של משתמש לסשן נפרד למטרות חיוב. מידע נוסף זמין במאמר אסימוני סשן.
בחירת פרמטרים להטיית התוצאות
פרמטרים של השלמה אוטומטית (חדש) יכולים להשפיע על תוצאות החיפוש בצורה שונה. בטבלה הבאה מפורטות המלצות לשימוש בפרמטרים על סמך התוצאה הרצויה.| פרמטר | המלצה לשימוש |
|---|---|
regionCode |
ההגדרה נקבעת לפי העדפות הפורמט והמידות של המשתמש. |
includedRegionCodes |
הגדרה שמגבילה את התוצאות לרשימה של אזורים שצוינו. |
locationBias |
משתמשים באפשרות הזו כשרוצים לקבל תוצאות באזור מסוים או בסביבתו. אם רלוונטי, מגדירים את האזור כחלק הגלוי של המפה שהמשתמש רואה. |
locationRestriction |
משתמשים בערך only רק כשלא רוצים לקבל תוצאות מחוץ לאזור. |
origin |
השתמשו באפשרות הזו כשרוצים לחשב מרחק בקו ישר לכל תחזית. |
דוגמאות להשלמה אוטומטית (חדש)
הגבלת החיפוש לאזור מסוים באמצעות locationRestriction
השדה locationRestriction מציין את האזור לחיפוש. לא מוחזרות תוצאות מחוץ לאזור שצוין. בדוגמה הבאה, משתמשים ב-locationRestriction כדי להגביל את הבקשה לעיגול ברדיוס של 5,000 מטרים שמרכזו בסן פרנסיסקו:
curl -X POST -d '{
"input": "Art museum",
"locationRestriction": {
"circle": {
"center": {
"latitude": 37.7749,
"longitude": -122.4194
},
"radius": 5000.0
}
}
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete
כל התוצאות מהאזורים שצוינו נכללות במערך suggestions:
{ "suggestions": [ { "placePrediction": { "place": "places/ChIJkQQVTZqAhYARHxPt2iJkm1Q", "placeId": "ChIJkQQVTZqAhYARHxPt2iJkm1Q", "text": { "text": "Asian Art Museum, Larkin Street, San Francisco, CA, USA", "matches": [ { "startOffset": 6, "endOffset": 16 } ] }, "structuredFormat": { "mainText": { "text": "Asian Art Museum", "matches": [ { "startOffset": 6, "endOffset": 16 } ] }, "secondaryText": { "text": "Larkin Street, San Francisco, CA, USA" } }, "types": [ "establishment", "museum", "point_of_interest" ] } }, { "placePrediction": { "place": "places/ChIJI7NivpmAhYARSuRPlbbn_2w", "placeId": "ChIJI7NivpmAhYARSuRPlbbn_2w", "text": { "text": "de Young Museum, Hagiwara Tea Garden Drive, San Francisco, CA, USA", "matches": [ { "endOffset": 15 } ] }, "structuredFormat": { "mainText": { "text": "de Young Museum", "matches": [ { "endOffset": 15 } ] }, "secondaryText": { "text": "Hagiwara Tea Garden Drive, San Francisco, CA, USA" } }, "types": [ "establishment", "point_of_interest", "tourist_attraction", "museum" ] } }, /.../ ] }
אפשר גם להשתמש ב-locationRestriction כדי להגביל את החיפושים לחלון תצוגה מלבני. בדוגמה הבאה, הבקשה מוגבלת לדאונטאון סן פרנסיסקו:
curl -X POST -d '{
"input": "Art museum",
"locationRestriction": {
"rectangle": {
"low": {
"latitude": 37.7751,
"longitude": -122.4219
},
"high": {
"latitude": 37.7955,
"longitude": -122.3937
}
}
}
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete
התוצאות מופיעות במערך suggestions:
{ "suggestions": [ { "placePrediction": { "place": "places/ChIJkQQVTZqAhYARHxPt2iJkm1Q", "placeId": "ChIJkQQVTZqAhYARHxPt2iJkm1Q", "text": { "text": "Asian Art Museum, Larkin Street, San Francisco, CA, USA", "matches": [ { "startOffset": 6, "endOffset": 16 } ] }, "structuredFormat": { "mainText": { "text": "Asian Art Museum", "matches": [ { "startOffset": 6, "endOffset": 16 } ] }, "secondaryText": { "text": "Larkin Street, San Francisco, CA, USA" } }, "types": [ "point_of_interest", "museum", "establishment" ] } }, { "placePrediction": { "place": "places/ChIJyQNK-4SAhYARO2DZaJleWRc", "placeId": "ChIJyQNK-4SAhYARO2DZaJleWRc", "text": { "text": "International Art Museum of America, Market Street, San Francisco, CA, USA", "matches": [ { "startOffset": 14, "endOffset": 24 } ] }, "structuredFormat": { "mainText": { "text": "International Art Museum of America", "matches": [ { "startOffset": 14, "endOffset": 24 } ] }, "secondaryText": { "text": "Market Street, San Francisco, CA, USA" } }, "types": [ "museum", "point_of_interest", "tourist_attraction", "art_gallery", "establishment" ] } } ] }
הטיית החיפוש לאזור מסוים באמצעות locationBias
במקרה של locationBias, המיקום משמש כהטיה, כלומר יכול להיות שיוחזרו תוצאות שמסביב למיקום שצוין, כולל תוצאות מחוץ לאזור שצוין. בדוגמה הבאה, אתם משנים את ההטיה של הבקשה לדאונטאון סן פרנסיסקו:
curl -X POST -d '{
"input": "Amoeba",
"locationBias": {
"circle": {
"center": {
"latitude": 37.7749,
"longitude": -122.4194
},
"radius": 5000.0
}
}
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete
התוצאות כוללות עכשיו הרבה יותר פריטים, כולל תוצאות מחוץ לרדיוס של 5,000 מטר:
{ "suggestions": [ { "placePrediction": { "place": "places/ChIJ5YQQf1GHhYARPKG7WLIaOko", "placeId": "ChIJ5YQQf1GHhYARPKG7WLIaOko", "text": { "text": "Amoeba Music, Haight Street, San Francisco, CA, USA", "matches": [ { "endOffset": 6 } ] }, "structuredFormat": { "mainText": { "text": "Amoeba Music", "matches": [ { "endOffset": 6 } ] }, "secondaryText": { "text": "Haight Street, San Francisco, CA, USA" } }, "types": [ "electronics_store", "point_of_interest", "store", "establishment", "home_goods_store" ] } }, { "placePrediction": { "place": "places/ChIJr7uwwy58hYARBY-e7-QVwqw", "placeId": "ChIJr7uwwy58hYARBY-e7-QVwqw", "text": { "text": "Amoeba Music, Telegraph Avenue, Berkeley, CA, USA", "matches": [ { "endOffset": 6 } ] }, "structuredFormat": { "mainText": { "text": "Amoeba Music", "matches": [ { "endOffset": 6 } ] }, "secondaryText": { "text": "Telegraph Avenue, Berkeley, CA, USA" } }, "types": [ "electronics_store", "point_of_interest", "establishment", "home_goods_store", "store" ] } }, ... ] }
אפשר גם להשתמש ב-locationBias כדי להטות את החיפושים לחלון תצוגה מלבני. בדוגמה הבאה, הבקשה מוגבלת לדאונטאון סן פרנסיסקו:
curl -X POST -d '{
"input": "Amoeba",
"locationBias": {
"rectangle": {
"low": {
"latitude": 37.7751,
"longitude": -122.4219
},
"high": {
"latitude": 37.7955,
"longitude": -122.3937
}
}
}
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete
למרות שתוצאות החיפוש בתוך אזור התצוגה המלבני מופיעות בתשובה, חלק מהתוצאות נמצאות מחוץ לגבולות המוגדרים, בגלל הטיה. התוצאות מופיעות גם במערך suggestions:
{ "suggestions": [ { "placePrediction": { "place": "places/ChIJ5YQQf1GHhYARPKG7WLIaOko", "placeId": "ChIJ5YQQf1GHhYARPKG7WLIaOko", "text": { "text": "Amoeba Music, Haight Street, San Francisco, CA, USA", "matches": [ { "endOffset": 6 } ] }, "structuredFormat": { "mainText": { "text": "Amoeba Music", "matches": [ { "endOffset": 6 } ] }, "secondaryText": { "text": "Haight Street, San Francisco, CA, USA" } }, "types": [ "point_of_interest", "store", "establishment" ] } }, { "placePrediction": { "place": "places/ChIJr7uwwy58hYARBY-e7-QVwqw", "placeId": "ChIJr7uwwy58hYARBY-e7-QVwqw", "text": { "text": "Amoeba Music, Telegraph Avenue, Berkeley, CA, USA", "matches": [ { "endOffset": 6 } ] }, "structuredFormat": { "mainText": { "text": "Amoeba Music", "matches": [ { "endOffset": 6 } ] }, "secondaryText": { "text": "Telegraph Avenue, Berkeley, CA, USA" } }, "types": [ "point_of_interest", "store", "establishment" ] } }, { "placePrediction": { "place": "places/ChIJRdmfADq_woARYaVhnfQSUTI", "placeId": "ChIJRdmfADq_woARYaVhnfQSUTI", "text": { "text": "Amoeba Music, Hollywood Boulevard, Los Angeles, CA, USA", "matches": [ { "endOffset": 6 } ] }, "structuredFormat": { "mainText": { "text": "Amoeba Music", "matches": [ { "endOffset": 6 } ] }, "secondaryText": { "text": "Hollywood Boulevard, Los Angeles, CA, USA" } }, "types": [ "point_of_interest", "store", "establishment" ] } }, /.../ ] }
שימוש ב-includedPrimaryTypes
משתמשים בפרמטר includedPrimaryTypes כדי לציין עד חמישה ערכי סוג מתוך
טבלה א',
טבלה ב',
או רק (regions), או רק (cities). כדי שמקום ייכלל בתשובה, הוא צריך להתאים לאחד מהערכים שצוינו לסוג הראשי.
בדוגמה הבאה, מציינים input מחרוזת של
'כדורגל' ומשתמשים בפרמטר includedPrimaryTypes כדי להגביל את התוצאות למקומות מסוג "sporting_goods_store":
curl -X POST -d '{
"input": "Soccer",
"includedPrimaryTypes": ["sporting_goods_store"],
"locationBias": {
"circle": {
"center": {
"latitude": 37.7749,
"longitude": -122.4194
},
"radius": 500.0
}
}
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete
אם לא מציינים את הפרמטר includedPrimaryTypes, התוצאות יכולות לכלול בתי עסק מסוג שלא רוצים, כמו "athletic_field".
בקשת תחזיות לשאילתות
כברירת מחדל, לא מוחזרות תחזיות לשאילתות. משתמשים בפרמטר הבקשה includeQueryPredictions כדי להוסיף לתשובה תחזיות של שאילתות. לדוגמה:
curl -X POST -d '{
"input": "Amoeba",
"includeQueryPredictions": true,
"locationBias": {
"circle": {
"center": {
"latitude": 37.7749,
"longitude": -122.4194
},
"radius": 5000.0
}
}
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete
המערך suggestions מכיל עכשיו גם תחזיות של מקומות וגם תחזיות של שאילתות, כמו שמוצג למעלה בקטע מידע על התשובה. כל תחזית לשאילתה כוללת את השדה text שמכיל מחרוזת טקסט מומלצת לחיפוש. אתם יכולים לשלוח בקשה לחיפוש טקסט (חדש) כדי לקבל מידע נוסף על כל אחת מהתחזיות לשאילתות שמוחזרות.
שימוש במקור
בדוגמה הזו, הקואורדינטות של קו הרוחב וקו האורך שצריך לכלול בבקשה הן origin. כשמציינים את origin, ההשלמה האוטומטית (חדשה) כוללת את השדה distanceMeters בתגובה, שמכיל את המרחק בקו ישר מ-origin ליעד. בדוגמה הזו, המקור מוגדר למרכז של סן פרנסיסקו:
curl -X POST -d '{
"input": "Amoeba",
"origin": {
"latitude": 37.7749,
"longitude": -122.4194
},
"locationRestriction": {
"circle": {
"center": {
"latitude": 37.7749,
"longitude": -122.4194
},
"radius": 5000.0
}
}
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete
התשובה כוללת עכשיו את distanceMeters:
{ "suggestions": [ { "placePrediction": { "place": "places/ChIJ5YQQf1GHhYARPKG7WLIaOko", "placeId": "ChIJ5YQQf1GHhYARPKG7WLIaOko", "text": { "text": "Amoeba Music, Haight Street, San Francisco, CA, USA", "matches": [ { "endOffset": 6 } ] }, "structuredFormat": { "mainText": { "text": "Amoeba Music", "matches": [ { "endOffset": 6 } ] }, "secondaryText": { "text": "Haight Street, San Francisco, CA, USA" } }, "types": [ "home_goods_store", "establishment", "point_of_interest", "store", "electronics_store" ], "distanceMeters": 3012 } } ] }
חיפוש עסקים שייפתחו בעתיד
בדוגמה הבאה מוצגת בקשה להשלמה אוטומטית (חדשה) של עסקים שייפתחו בעתיד בניו מידואוז, איידהו:
curl -X POST \
-H "Content-Type: application/json" \
-H "X-Goog-Api-Key: API_KEY" \
-d '{
"input": "Roberts Greenhouse and Tree Farm",
"includeFutureOpeningBusinesses": true,
"locationBias": {
"circle": {
"center": {"latitude": 44.9755100, "longitude": -116.2842180},
"radius": 20
}
}
}' \
"https://places.googleapis.com/v1/places:autocomplete"
התשובה כוללת פרטים על המקום, אבל לא את תאריך הפתיחה.
{ "suggestions": [ { "placePrediction": { "place": "places/ChIJp1-VoKWJplQRMz8g-7Wa3Do", "placeId": "ChIJp1-VoKWJplQRMz8g-7Wa3Do", "text": { "text": "Roberts Greenhouse and Tree Farm, McLain Street, New Meadows, ID, USA", "matches": [ { "endOffset": 32 } ] }, "structuredFormat": { "mainText": { "text": "Roberts Greenhouse and Tree Farm", "matches": [ { "endOffset": 32 } ] }, "secondaryText": { "text": "McLain Street, New Meadows, ID, USA" } }, "types": [ "garden_center", "establishment", "service", "store", "point_of_interest" ] } } ] }
חסר מרחק בתשובה
במקרים מסוימים, התגובה לא כוללת את distanceMeters, גם אם הבקשה כוללת את origin. מצב כזה יכול לקרות בתרחישים הבאים:
- התכונה
distanceMetersלא נכללת בתחזיות שלroute. - הערך
distanceMetersלא נכלל כשהערך שלו הוא0, כמו במקרה של תחזיות שרחוקות פחות ממטר אחד מהמיקוםoriginשצוין.
ספריות לקוח שמנסות לקרוא את השדה distanceMeters מאובייקט מנותח יחזירו שדה עם הערך 0.
כדי למנוע הטעיה של המשתמשים, אל תציגו למשתמשים מרחק אפס.
אופטימיזציה של השלמה אוטומטית (חדש)
בקטע הזה מתוארות שיטות מומלצות שיעזרו לכם להפיק את המרב משירות ההשלמה האוטומטית (חדש).
הנה כמה הנחיות כלליות:
- הדרך הכי מהירה לפתח ממשק משתמש תקין היא להשתמש בווידג'ט Autocomplete (חדש) של Maps JavaScript API, בווידג'ט Autocomplete (חדש) של Places SDK ל-Android או בווידג'ט Autocomplete (חדש) של Places SDK ל-iOS.
- הסבר על שדות הנתונים החשובים של Autocomplete (חדש)
- השדות 'הטיה לפי מיקום' ו'הגבלת מיקום' הם אופציונליים, אבל יכולה להיות להם השפעה משמעותית על הביצועים של ההשלמה האוטומטית.
- כדאי להשתמש בטיפול בשגיאות כדי לוודא שהאפליקציה תפעל בצורה תקינה גם אם ה-API יחזיר שגיאה.
- חשוב לוודא שהאפליקציה מטפלת במצב שבו לא נבחרה אפשרות, ומציעה למשתמשים דרך להמשיך.
שיטות מומלצות לאופטימיזציה של עלויות
אופטימיזציה בסיסית של עלויות
כדי לייעל את העלות של השימוש בשירות Autocomplete (חדש), כדאי להשתמש במסכות שדות בווידג'טים Place Details (חדש) ו-Autocomplete (חדש) כדי להחזיר רק את שדות הנתונים של Autocomplete (חדש) שאתם צריכים.
אופטימיזציה מתקדמת של עלויות
כדאי לשקול הטמעה פרוגרמטית של Autocomplete (חדש) כדי לגשת אל SKU: תמחור של בקשות להשלמה אוטומטית ולבקש תוצאות של Geocoding API לגבי המקום שנבחר במקום Place Details (חדש). תמחור לפי בקשה בשילוב עם Geocoding API הוא חסכוני יותר מתמחור לפי סשן (מבוסס-סשן) אם מתקיימים שני התנאים הבאים:
- אם אתם צריכים רק את קו הרוחב/קו האורך או את הכתובת של המקום שהמשתמש בחר, Geocoding API מספק את המידע הזה בפחות משיחה של Place Details (New).
- אם המשתמשים בוחרים הצעות להשלמת החיפוש בממוצע של ארבע בקשות או פחות להשלמה אוטומטית (חדשה), יכול להיות שהתמחור לפי בקשה יהיה חסכוני יותר מהתמחור לפי סשן.
האם האפליקציה שלך דורשת מידע כלשהו מלבד הכתובת וקו הרוחב/קו האורך של החיזוי שנבחר?
כן, צריך עוד פרטים
שימוש ב-Autocomplete (חדש) מבוסס-סשן עם Place Details (חדש).
מכיוון שהאפליקציה שלך דורשת Place Details (חדש), כמו שם המקום, הסטטוס של העסק או שעות הפתיחה, ההטמעה של השלמה אוטומטית (חדשה) צריכה להשתמש בטוקן לסשן (באופן פרוגרמטי או מובנה בווידג'טים של JavaScript, Android או iOS) לכל סשן, בנוסף ל-SKU הרלוונטיים של מקומות, בהתאם לשדות הנתונים של המקום שאתם מבקשים.1
הטמעה של ווידג'טים
ניהול הסשנים מוטמע אוטומטית בווידג'טים של
JavaScript,
Android,
או iOS. היא כוללת גם את הבקשות של Autocomplete (חדש) וגם את הבקשה של Place Details (חדש)
לחיזוי שנבחר. חשוב לציין את הפרמטר fields כדי לוודא שאתם מבקשים רק את שדות הנתונים שאתם צריכים ב-Autocomplete (חדש).
הטמעה פרוגרמטית
משתמשים בטוקן סשן
עם בקשות Autocomplete (חדש). כשמבקשים Place Details (חדש) לגבי התחזית שנבחרה, צריך לכלול את הפרמטרים הבאים:
- מזהה המקום מהתשובה של Autocomplete (חדש)
- טוקן הסשן שמשמש בבקשה של ההשלמה האוטומטית (חדשה)
- הפרמטר
fieldsשמציין את שדות הנתונים של Autocomplete (חדש) שדרושים לכם
לא, צריך רק כתובת ומיקום
יכול להיות ש-Geocoding API יהיה אפשרות חסכונית יותר מאשר Place Details (חדש) עבור האפליקציה שלכם, בהתאם לביצועים של השימוש ב-Autocomplete (חדש). היעילות של ההשלמה האוטומטית (חדש) בכל אפליקציה משתנה בהתאם למה שהמשתמשים מזינים, איפה האפליקציה נמצאת והאם הוטמעו שיטות מומלצות לאופטימיזציה של הביצועים.
כדי לענות על השאלה הבאה, צריך לנתח כמה תווים משתמש מקליד בממוצע לפני שהוא בוחר חיזוי של השלמה אוטומטית (חדשה) באפליקציה.
האם המשתמשים בוחרים חיזוי של השלמה אוטומטית (חדשה) בממוצע בארבע בקשות או פחות?
כן
הטמעה פרוגרמטית של Autocomplete (חדש) ללא טוקנים של סשנים וקריאה ל-Geocoding API לגבי החיזוי של המקום שנבחר.
Geocoding API מספק כתובות וקואורדינטות של קווי אורך ורוחב.
ביצוע ארבע בקשות Autocomplete ועוד קריאה ל-Geocoding API לגבי החיזוי של המקום שנבחר, יעלה פחות מהעלות של כל סשן ב-Autocomplete (חדש).1
כדאי להשתמש בשיטות מומלצות לשיפור הביצועים כדי לעזור למשתמשים לקבל את התחזית שהם מחפשים גם אם הם מקלידים פחות תווים.
לא
שימוש ב-Autocomplete (חדש) מבוסס-סשן עם Place Details (חדש).
מכיוון שהמספר הממוצע של הבקשות שצפויות להתבצע לפני שהמשתמש בוחר חיזוי של
Autocomplete (חדש) גבוה מהעלות של התמחור לפי סשן, בהטמעה של Autocomplete (חדש)
צריך להשתמש בטוקן סשן גם לבקשות של Autocomplete (חדש) וגם לבקשה המשויכת של
Place Details (חדש)
לכל סשן.
1
הטמעה של ווידג'טים
ניהול הסשנים מוטמע אוטומטית בווידג'טים של
JavaScript,
Android,
או iOS. הבקשות האלה כוללות גם את הבקשות של Autocomplete (חדש) וגם את הבקשות של Place Details (חדש) לגבי החיזוי שנבחר. כדי לוודא שאתם מבקשים רק את השדות שאתם צריכים, חשוב לציין את הפרמטר fields.
הטמעה פרוגרמטית
משתמשים בטוקן סשן
עם בקשות Autocomplete (חדש).
כשמבקשים Place Details (חדש) לגבי התחזית שנבחרה, צריך לכלול את הפרמטרים הבאים:
- מזהה המקום מהתשובה של Autocomplete (חדש)
- טוקן הסשן שמשמש בבקשה של ההשלמה האוטומטית (חדשה)
- הפרמטר
fieldsשמציין שדות כמו כתובת וגיאומטריה
כדאי לשקול לדחות בקשות להשלמה אוטומטית (חדשה)
אפשר להשתמש באסטרטגיות כמו דחיית בקשה להשלמה אוטומטית (חדשה) עד שהמשתמש יקליד את שלושת או ארבעת התווים הראשונים, כדי שהאפליקציה תשלח פחות בקשות. לדוגמה, אם שולחים בקשות להשלמה אוטומטית (חדשה) לכל תו אחרי שהמשתמש הקליד את התו השלישי, ואם המשתמש מקליד שבעה תווים ואז בוחר תחזית שבשבילה נשלחת בקשת API אחת ל-Geocoding API, העלות הכוללת תהיה של 4 בקשות להשלמה אוטומטית (חדשה) + קידוד גאוגרפי.1
אם עיכוב הבקשות יכול להוריד את הממוצע של הבקשות הפרוגרמטיות מתחת לארבע, אפשר לפעול לפי ההנחיות להטמעה של Autocomplete (חדש) עם ביצועים טובים באמצעות Geocoding API. חשוב לזכור שהמשתמשים עשויים לפרש עיכובים בבקשות כזמן אחזור, כי הם מצפים לראות תחזיות עם כל הקשה חדשה על המקשים.
כדאי להשתמש בשיטות מומלצות לשיפור הביצועים כדי לעזור למשתמשים לקבל את התחזית שהם מחפשים בפחות תווים.
-
למידע על עלויות, אפשר לעיין במחירונים של Google Maps Platform.
שיטות מומלצות לשיפור הביצועים
בהנחיות הבאות מוסבר איך לבצע אופטימיזציה של הביצועים של ההשלמה האוטומטית (חדשה):
- מוסיפים הגבלות לפי מדינה, הטיה לפי מיקום והעדפת שפה (ביישומים פרוגרמטיים) להטמעה של Autocomplete (חדש). אין צורך בהעדפת שפה בווידג'טים, כי הם בוחרים את העדפות השפה מתוך הדפדפן או המכשיר הנייד של המשתמש.
- אם ההשלמה האוטומטית (חדשה) מופיעה עם מפה, אפשר להטות את המיקום לפי אזור התצוגה של המפה.
- במצבים שבהם משתמש לא בוחר באחת מההצעות להשלמה אוטומטית (חדשה), בדרך כלל כי אף אחת מההצעות האלה לא מתאימה לכתובת הרצויה, אפשר להשתמש מחדש בקלט של משתמשים כדי לנסות לקבל תוצאות רלוונטיות יותר:
- אם אתם מצפים שהמשתמש יזין רק פרטי כתובת, תוכלו להשתמש מחדש בקלט של משתמשים המקורי בקריאה ל-Geocoding API.
- אם אתם מצפים שהמשתמש יזין שאילתות לגבי מקום ספציפי לפי שם או כתובת, תשתמשו בבקשה של Place Details (חדש). אם אתם מצפים לתוצאות רק באזור מסוים, כדאי להשתמש בהטיה לפי מיקום.
- משתמשים שמזינים כתובות של יחידות משנה, כמו כתובות של יחידות או דירות ספציפיות בתוך בניין. לדוגמה, הכתובת הצ'כית "Stroupežnického 3191/17, Praha" תניב חיזוי חלקי בהשלמה האוטומטית (חדש).
- משתמשים שמזינים כתובות עם קידומות של קטע כביש כמו "23-30 29th St, Queens" בניו יורק או "47-380 Kamehameha Hwy, Kaneohe" באי קוואי בהוואי.
הטיה של מיקום
כדי להטות את התוצאות לאזור מסוים, מעבירים פרמטר location ופרמטר radius. ההוראה הזו גורמת להשלמה האוטומטית (חדשה) להעדיף להציג תוצאות באזור המוגדר. יכול להיות שיוצגו תוצאות מחוץ לאזור שהוגדר. אפשר להשתמש בפרמטר includedRegionCodes כדי לסנן את התוצאות ולהציג רק מקומות במדינה שצוינה.
הגבלת מיקום
כדי להגביל את התוצאות לאזור מסוים, מעבירים פרמטר locationRestriction.
אפשר גם להגביל את התוצאות לאזור שהוגדר על ידי location
והפרמטר radius, על ידי הוספת הפרמטר
locationRestriction. ההוראה הזו גורמת להשלמה האוטומטית (חדשה) להחזיר רק תוצאות מהאזור הזה.
רוצה לנסות?
הכלי APIs Explorer מאפשר לכם לשלוח בקשות לדוגמה כדי להכיר את ה-API ואת האפשרויות שלו.
לוחצים על סמל ה-API api בצד שמאל של הדף.
אפשר לערוך את פרמטרים הבקשה.
לוחצים על הלחצן Execute (הפעלה). בתיבת הדו-שיח, בוחרים את החשבון שבו רוצים להשתמש כדי לשלוח את הבקשה.
בחלונית APIs Explorer, לוחצים על סמל המסך המלא מסך מלא כדי להרחיב את החלון של APIs Explorer.