PlacesService class
google.maps.places.PlacesService
class
כולל שיטות שקשורות לחיפוש מקומות ולאחזור פרטים על מקום.
אפשר להתקשר אל const {PlacesService} = await google.maps.importLibrary("places")
כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
יצרן | |
---|---|
PlacesService |
PlacesService(attrContainer) פרמטרים:
יוצרת מופע חדש של PlacesService שמציג שיוכים בקונטיינר שצוין. |
Methods | |
---|---|
findPlaceFromPhoneNumber |
findPlaceFromPhoneNumber(request, callback) פרמטרים:
ערך מוחזר: אין
מאחזרת רשימה של מקומות על סמך מספר טלפון. ברוב המקרים אמור להיות רק פריט אחד ברשימת התוצאות, אבל אם הבקשה לא ברורה יכול להיות שיוחזרו יותר מתוצאה אחת. ה- PlaceResult s שמועברים אל פונקציית הקריאה החוזרת הם תת-קבוצות של PlaceResult מלא. האפליקציה יכולה לקבל PlaceResult מפורט יותר לכל מקום על ידי הפעלת PlacesService.getDetails והעברת PlaceResult.place_id למקום הרצוי. |
findPlaceFromQuery |
findPlaceFromQuery(request, callback) פרמטרים:
ערך מוחזר: אין
מאחזרת רשימה של מקומות על סמך מחרוזת שאילתה. ברוב המקרים אמור להיות רק פריט אחד ברשימת התוצאות, אבל אם הבקשה לא ברורה יכול להיות שיוחזרו יותר מתוצאה אחת. ה- PlaceResult s שמועברים אל פונקציית הקריאה החוזרת הם תת-קבוצות של PlaceResult מלא. האפליקציה יכולה לקבל PlaceResult מפורט יותר לכל מקום על ידי הפעלת PlacesService.getDetails והעברת PlaceResult.place_id למקום הרצוי. |
getDetails |
getDetails(request, callback) פרמטרים:
ערך מוחזר: אין
אחזור פרטים על המקום שזוהה על ידי placeId שצוין. |
nearbySearch |
nearbySearch(request, callback) פרמטרים:
ערך מוחזר: אין
אחזור רשימה של מקומות ליד מיקום מסוים, על סמך מילת מפתח או סוג. תמיד צריך לציין מיקום, באמצעות העברת פרמטר LatLngBounds או פרמטרים location ו-radius . ה-PlaceResult s שמועברים לקריאה החוזרת הם קבוצות משנה של ה-PlaceResult המלא. האפליקציה יכולה לקבל PlaceResult מפורט יותר לכל מקום על ידי שליחת בקשה לפרטי מקום עם PlaceResult.place_id של המקום הרצוי. אפשר להשתמש באובייקט PlaceSearchPagination כדי לאחזר דפים נוספים של תוצאות (הערך הוא null אם זה הדף האחרון של התוצאות או אם יש רק דף אחד של תוצאות). |
textSearch |
textSearch(request, callback) פרמטרים:
ערך מוחזר: אין
מאחזר רשימה של מקומות על סמך מחרוזת שאילתה (לדוגמה, 'פיצה בניו יורק' או 'חנויות נעליים ליד אוטווה'). פרמטרים של מיקום הם אופציונליים. כשמציינים מיקום, התוצאות מוטות רק לתוצאות בקרבת מקום, ולא מוגבלות למקומות בתוך האזור. משתמשים ב- textSearch כשרוצים לחפש מקומות באמצעות מחרוזת שרירותית, ובמקרים שבהם לא רוצים להגביל את תוצאות החיפוש למיקום מסוים. אפשר להשתמש באובייקט PlaceSearchPagination כדי לאחזר דפים נוספים של תוצאות (הערך הוא null אם זה הדף האחרון של התוצאות או אם יש רק דף אחד של תוצאות). |
PlaceDetailsRequest interface
google.maps.places.PlaceDetailsRequest
ממשק
שאילתת פרטי מקום שתישלח אל PlacesService
.
מאפיינים | |
---|---|
placeId |
סוג:
string מזהה המקום של המקום שלגביו מתבקשים פרטים. |
fields optional |
סוג:
Array<string> optional השדות שייכללו בתגובת הפרטים, שעליהם יחויב. אם לא מציינים שדות או מעבירים את הערך ['ALL'] , כל השדות הזמינים יוחזרו ותחויבו עליהם (לא מומלץ לפריסות בסביבת ייצור). רשימת השדות זמינה בכתובת PlaceResult . אפשר לציין שדות מקוננים באמצעות נתיבים עם נקודות (לדוגמה, "geometry.location" ). |
language optional |
סוג:
string optional מזהה שפה של השפה שבה צריך להחזיר את הפרטים. כאן אפשר לעיין ברשימת השפות הנתמכות. |
region optional |
סוג:
string optional קוד האזור של האזור שבו נמצא המשתמש. ההגדרה הזו יכולה להשפיע על התמונות שיוצגו, ואולי גם על דברים אחרים. קוד האזור יכול להיות ccTLD (דומיין ברמה העליונה) באורך שני תווים. רוב קודי ה-ccTLD זהים לקודי ISO 3166-1, אבל יש כמה יוצאים מן הכלל. לדוגמה, דומיין ccTLD של בריטניה הוא uk ( .co.uk ), אבל קוד ISO 3166-1 שלה הוא gb (מבחינה טכנית, עבור הישות 'ממלכת בריטניה הגדולה וצפון אירלנד'). |
sessionToken optional |
סוג:
AutocompleteSessionToken optional הפניה ייחודית שמשמשת לאגד את בקשת הפרטים עם סשן של השלמה אוטומטית. |
FindPlaceFromPhoneNumberRequest interface
google.maps.places.FindPlaceFromPhoneNumberRequest
ממשק
בקשה לחיפוש מקום מתוך חיפוש טקסט שתישלח אל PlacesService.findPlaceFromPhoneNumber
.
מאפיינים | |
---|---|
fields |
סוג:
Array<string> השדות שייכללו בתשובה, שעליהם יחויב המשתמש. אם מעבירים את הערך ['ALL'] , כל השדות הזמינים יוחזרו ותחויבו עליהם (לא מומלץ להשתמש באפשרות הזו בפריסות של מוצרים). רשימת השדות זמינה בכתובת PlaceResult . אפשר לציין שדות מקוננים באמצעות נתיבים עם נקודות (לדוגמה, "geometry.location" ). |
phoneNumber |
סוג:
string מספר הטלפון של המקום שרוצים לחפש. הפורמט צריך להיות E.164. |
language optional |
סוג:
string optional מזהה שפה לשפה שבה צריך להחזיר את השמות והכתובות, אם אפשר. כאן אפשר לעיין ברשימת השפות הנתמכות. |
locationBias optional |
סוג:
LocationBias optional ההטיה שמשמשת לחיפוש מקום. התוצאה תהיה מוטה לכיוון LocationBias שצוין, אבל לא תוגבל אליו. |
FindPlaceFromQueryRequest interface
google.maps.places.FindPlaceFromQueryRequest
ממשק
בקשה לחיפוש מקום מתוך חיפוש טקסט שתישלח אל PlacesService.findPlaceFromQuery
.
מאפיינים | |
---|---|
fields |
סוג:
Array<string> השדות שייכללו בתשובה, שעליהם יחויב המשתמש. אם מעבירים את הערך ['ALL'] , כל השדות הזמינים יוחזרו ותחויבו עליהם (לא מומלץ להשתמש באפשרות הזו בפריסות של מוצרים). רשימת השדות זמינה בכתובת PlaceResult . אפשר לציין שדות מקוננים באמצעות נתיבים עם נקודות (לדוגמה, "geometry.location" ). |
query |
סוג:
string השאילתה של הבקשה. לדוגמה, השם או הכתובת של מקום. |
language optional |
סוג:
string optional מזהה שפה לשפה שבה צריך להחזיר את השמות והכתובות, אם אפשר. כאן אפשר לעיין ברשימת השפות הנתמכות. |
locationBias optional |
סוג:
LocationBias optional ההטיה שמשמשת לחיפוש מקום. התוצאה תהיה מוטה לכיוון LocationBias שצוין, אבל לא תוגבל אליו. |
PlaceSearchRequest interface
google.maps.places.PlaceSearchRequest
ממשק
שאילתת חיפוש של מקום שתישלח אל PlacesService
.
מאפיינים | |
---|---|
bounds optional |
סוג:
LatLngBounds|LatLngBoundsLiteral optional הגבולות שבהם יתבצע החיפוש של מקומות. אם המדיניות bounds מוגדרת, המערכת מתעלמת גם מהמדיניות location וגם מהמדיניות radius . |
keyword optional |
סוג:
string optional מונח שיושווה לכל השדות הזמינים, כולל, בין היתר, שם, סוג וכתובת, וגם ביקורות של לקוחות ותוכן אחר של צד שלישי. |
language optional |
סוג:
string optional מזהה שפה לשפה שבה צריך להחזיר את השמות והכתובות, אם אפשר. כאן אפשר לעיין ברשימת השפות הנתמכות. |
location optional |
סוג:
LatLng|LatLngLiteral optional המיקום שסביבו יתבצע החיפוש של מקומות. |
maxPriceLevel optional |
סוג:
number optional הגבלת התוצאות למקומות ברמת המחיר שצוינה או ברמה נמוכה יותר. הערכים החוקיים הם 0 (המחיר הכי משתלם) עד 4 (המחיר הכי גבוה), כולל. אם מציינים ערך, הוא חייב להיות גדול מ- minPrice או שווה לו. |
minPriceLevel optional |
סוג:
number optional הגבלת התוצאות למקומות ברמת המחיר שצוינה או ברמה גבוהה יותר. הערכים החוקיים הם 0 (המחיר הכי משתלם) עד 4 (המחיר הכי גבוה), כולל. אם מציינים ערך, הוא חייב להיות קטן מ- maxPrice או שווה לו. |
|
סוג:
string optional שווה ערך ל- keyword . הערכים בשדה הזה משולבים עם הערכים בשדה keyword ומועברים כחלק מאותה מחרוזת חיפוש. |
openNow optional |
סוג:
boolean optional הגבלת התוצאות רק למקומות שפתוחים כרגע. |
radius optional |
סוג:
number optional המרחק מהמיקום שצוין שבמסגרתו יתבצע חיפוש של מקומות, במטרים. הערך המקסימלי המותר הוא 50,000. |
rankBy optional |
סוג:
RankBy optional ברירת מחדל:
RankBy.PROMINENCE מציין את שיטת הדירוג שתשמש להחזרת התוצאות. הערה: אם הערך של rankBy הוא DISTANCE , צריך לציין location אבל אי אפשר לציין radius או bounds . |
type optional |
סוג:
string optional חיפוש של מקומות מהסוג שצוין. הסוג מתורגם לשפה המקומית של מיקום היעד של הבקשה ומשמש כמחרוזת שאילתה. אם מסופקת גם שאילתה, היא מצורפת למחרוזת הסוג המותאמת לשוק המקומי. תוצאות מסוג אחר מושמטות מהתשובה. אפשר להשתמש בשדה הזה כדי לבצע חיפושים קטגוריים שלא תלויים בשפה או באזור. הסוגים התקינים מפורטים כאן. |
TextSearchRequest ממשק
google.maps.places.TextSearchRequest
ממשק
בקשת חיפוש טקסט שתישלח אל PlacesService
.
מאפיינים | |
---|---|
bounds optional |
סוג:
LatLngBounds|LatLngBoundsLiteral optional גבולות שמשמשים להטיית התוצאות כשמחפשים מקומות (אופציונלי). אם המדיניות bounds מוגדרת, המערכת מתעלמת גם מהמדיניות location וגם מהמדיניות radius . התוצאות לא יוגבלו לאלה שנמצאות בתוך הגבולות האלה, אבל התוצאות שנמצאות בתוך הגבולות ידורגו גבוה יותר. |
language optional |
סוג:
string optional מזהה שפה לשפה שבה צריך להחזיר את השמות והכתובות, אם אפשר. כאן אפשר לעיין ברשימת השפות הנתמכות. |
location optional |
סוג:
LatLng|LatLngLiteral optional מרכז האזור שמשמש להטיית התוצאות כשמחפשים מקומות. |
query optional |
סוג:
string optional מונח השאילתה של הבקשה. לדוגמה, שם של מקום ('מגדל אייפל'), קטגוריה ואחריה שם של מיקום ('פיצה בניו יורק'), או שם של מקום ואחריו מזהה מיקום ('סטארבקס בסידני'). |
radius optional |
סוג:
number optional רדיוס האזור שמשמש להטיית התוצאות כשמחפשים מקומות, במטרים. |
region optional |
סוג:
string optional קוד אזור להטיית התוצאות. קוד האזור יכול להיות ccTLD (דומיין ברמה העליונה) באורך שני תווים. רוב קודי ה-ccTLD זהים לקודי ISO 3166-1, אבל יש כמה יוצאים מן הכלל. לדוגמה, דומיין ccTLD של בריטניה הוא uk ( .co.uk ), אבל קוד ISO 3166-1 שלה הוא gb (מבחינה טכנית, עבור הישות 'ממלכת בריטניה הגדולה וצפון אירלנד'). |
type optional |
סוג:
string optional חיפוש של מקומות מהסוג שצוין. הסוג מתורגם לשפה המקומית של מיקום היעד של הבקשה ומשמש כמחרוזת שאילתה. אם מסופקת גם שאילתה, היא מצורפת למחרוזת הסוג המותאמת לשוק המקומי. תוצאות מסוג אחר מושמטות מהתשובה. אפשר להשתמש בשדה הזה כדי לבצע חיפושים קטגוריים שלא תלויים בשפה או באזור. הסוגים התקינים מפורטים כאן. |
RankBy constants
google.maps.places.RankBy
constants
אפשרויות דירוג ל-PlaceSearchRequest.
אפשר להתקשר אל const {RankBy} = await google.maps.importLibrary("places")
כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
Constants | |
---|---|
DISTANCE |
מדרג את תוצאות המקומות לפי המרחק מהמיקום. |
PROMINENCE |
דירוג תוצאות של מקומות לפי מידת הבולטות שלהם. |
LocationBias typedef
google.maps.places.LocationBias
typedef
LocationBias מייצג גבול רך או רמז לשימוש כשמחפשים מקומות. יכול להיות שהתוצאות יגיעו מחוץ לאזור שצוין. כדי להשתמש בכתובת ה-IP של המשתמש הנוכחי כהטיה, אפשר לציין את המחרוזת "IP_BIAS"
. הערה: אם משתמשים בCircle
, צריך להגדיר את המרכז והרדיוס.
LatLng|LatLngLiteral|LatLngBounds|LatLngBoundsLiteral|Circle|CircleLiteral|string
LocationRestriction typedef
google.maps.places.LocationRestriction
typedef
האובייקט LocationRestriction מייצג גבולות מדויקים לשימוש כשמחפשים מקומות.
PlacesServiceStatus קבועים
google.maps.places.PlacesServiceStatus
constants
הסטטוס שמוחזר על ידי PlacesService
בסיום החיפושים שלו. אפשר לציין אותם לפי ערך או באמצעות שם הקבוע. לדוגמה, 'OK'
או google.maps.places.PlacesServiceStatus.OK
.
אפשר להתקשר אל const {PlacesServiceStatus} = await google.maps.importLibrary("places")
כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
Constants | |
---|---|
INVALID_REQUEST |
הבקשה הזו לא תקינה. |
NOT_FOUND |
המקום שאליו מתייחסים לא נמצא. |
OK |
התשובה מכילה תוצאה תקינה. |
OVER_QUERY_LIMIT |
האפליקציה חרגה ממכסת הבקשות שלה. |
REQUEST_DENIED |
לאפליקציה אין הרשאה להשתמש ב-PlacesService . |
UNKNOWN_ERROR |
לא ניתן היה לעבד את הבקשה PlacesService בגלל שגיאת שרת. אם תנסו שוב, יכול להיות שהבקשה תצליח. |
ZERO_RESULTS |
לא נמצאה תוצאה לבקשה הזו. |
PlaceSearchPagination interface
google.maps.places.PlaceSearchPagination
ממשק
אובייקט שמשמש לאחזור דפים נוספים של תוצאות של מקומות.
מאפיינים | |
---|---|
hasNextPage |
סוג:
boolean מציין אם יש תוצאות נוספות. true אם יש דף תוצאות נוסף. |
Methods | |
---|---|
nextPage |
nextPage() פרמטרים: אין
ערך מוחזר:
void מאחזר את הדף הבא של התוצאות. משתמש באותה פונקציית קריאה חוזרת שסופקה לבקשת החיפוש הראשונה. |
ממשק PlaceResult
google.maps.places.PlaceResult
ממשק
הגדרת מידע על מקום.
מאפיינים | |
---|---|
address_components optional |
סוג:
Array<GeocoderAddressComponent> optional אוסף של רכיבי הכתובת של המיקום של המקום הזה. זמין רק עם PlacesService.getDetails . |
adr_address optional |
סוג:
string optional הייצוג של כתובת המקום במיקרופורמט adr. זמין רק עם PlacesService.getDetails . |
aspects optional |
סוג:
Array<PlaceAspectRating> optional היבטים מדורגים של המקום הזה, על סמך ביקורות משתמשים ב-Google וב-Zagat. הדירוגים הם בסולם של 0 עד 30. |
business_status optional |
סוג:
BusinessStatus optional דגל שמציין את סטטוס הפעילות של המקום, אם הוא עסק (מציין אם המקום פעיל או סגור זמנית או לצמיתות). אם אין נתונים זמינים, הדגל לא מוצג בחיפוש או בתגובות עם פרטים. |
formatted_address optional |
סוג:
string optional הכתובת המלאה של המקום. |
formatted_phone_number optional |
סוג:
string optional מספר הטלפון של המקום, בפורמט שתואם ל המוסכמות האזוריות של המספר. זמין רק עם PlacesService.getDetails . |
geometry optional |
סוג:
PlaceGeometry optional מידע שקשור לגיאומטריה של המקום. |
html_attributions optional |
סוג:
Array<string> optional טקסט השיוך שיוצג לתוצאת המקום הזו. הערכים הזמינים של html_attributions מוחזרים תמיד, בלי קשר לערכים של fields שהתבקשו, והם חייבים להיות מוצגים. |
icon optional |
סוג:
string optional כתובת URL למשאב תמונה שאפשר להשתמש בו כדי לייצג את הקטגוריה של המקום הזה. |
icon_background_color optional |
סוג:
string optional צבע הרקע לשימוש עם סמל של מקום. מידע נוסף מופיע ב- PlaceResult.icon_mask_base_uri . |
icon_mask_base_uri optional |
סוג:
string optional כתובת URL קטומה של מסכת סמל. כדי לגשת לסוגים שונים של סמלים, מוסיפים סיומת קובץ בסוף (למשל, .svg או .png ). |
international_phone_number optional |
סוג:
string optional מספר הטלפון של המקום בפורמט לחיוג בינלאומי. הפורמט הבינלאומי כולל את קוד המדינה, ומתחיל בסימן הפלוס (+). זמין רק עם PlacesService.getDetails . |
name optional |
סוג:
string optional שם המקום. הערה: במקרה של מקומות שהוזנו על ידי המשתמש, זהו הטקסט הגולמי, כפי שהוקלד על ידי המשתמש. חשוב להפעיל שיקול דעת כשמשתמשים בנתונים האלה, כי משתמשים זדוניים עלולים לנסות להשתמש בהם כווקטור לתקיפות של הזרקת קוד (ראו http://en.wikipedia.org/wiki/Code_injection). |
opening_hours optional |
סוג:
PlaceOpeningHours optional הגדרה של שעות הפתיחה והסגירה של המקום. |
|
סוג:
boolean optional סימון שמציין אם המקום סגור, באופן זמני או לצמיתות. אם המקום פועל, או אם אין נתונים זמינים, הדגל לא יופיע בתגובה. |
photos optional |
סוג:
Array<PlacePhoto> optional תמונות של המקום הזה. האוסף יכיל עד עשרה אובייקטים של PlacePhoto . |
place_id optional |
סוג:
string optional מזהה ייחודי של המקום. |
plus_code optional |
סוג:
PlacePlusCode optional הגדרת קודים של מיקומים פתוחים או Plus Codes למקום. |
price_level optional |
סוג:
number optional רמת המחיר של המקום, בסולם של 0 עד 4. המשמעות של רמות המחירים היא כדלקמן:
|
rating optional |
סוג:
number optional דירוג, בין 1.0 ל-5.0, שמבוסס על ביקורות משתמשים על המקום הזה. |
reviews optional |
סוג:
Array<PlaceReview> optional רשימת הביקורות על המקום הזה. זמין רק עם PlacesService.getDetails . |
types optional |
סוג:
Array<string> optional |
url optional |
סוג:
string optional כתובת ה-URL של הדף הרשמי של המקום הזה ב-Google. זהו דף בבעלות Google שמכיל את המידע הטוב ביותר שזמין על המקום. זמין רק עם PlacesService.getDetails . |
user_ratings_total optional |
סוג:
number optional מספר דירוגי המשתמשים שתרמו לדירוג המקום הזה PlaceResult.rating . |
|
סוג:
number optional ההפרש מ-UTC של אזור הזמן הנוכחי של המקום, בדקות. לדוגמה, סידני, אוסטרליה, מקדימה את שעון UTC ב-11 שעות בזמן שעון הקיץ, ולכן הערך של utc_offset יהיה 660 . באזורי זמן שמאחרים את UTC, הקיזוז הוא שלילי. לדוגמה, utc_offset בכף ורדה הוא -60 . זמין רק עם PlacesService.getDetails . |
utc_offset_minutes optional |
סוג:
number optional ההפרש מ-UTC של אזור הזמן הנוכחי של המקום, בדקות. לדוגמה, סידני, אוסטרליה, מקדימה את שעון UTC ב-11 שעות בזמן שעון הקיץ, ולכן הערך של utc_offset_minutes יהיה 660 . באזורי זמן שמאחרים את UTC, הקיזוז הוא שלילי. לדוגמה, utc_offset_minutes בכף ורדה הוא -60 . זמין רק עם PlacesService.getDetails . |
vicinity optional |
סוג:
string optional הכתובת הפשוטה של המקום, כולל שם הרחוב, מספר הבית והיישוב, אבל לא המחוז/המדינה, המיקוד או המדינה. לדוגמה, הערך של הסביבה במשרד של Google בסידני, אוסטרליה, הוא "48 Pirrama Road, Pyrmont" . זמין רק עם PlacesService.getDetails . |
website optional |
סוג:
string optional האתר הרשמי של המקום הזה, כמו דף הבית של העסק. זמין רק עם PlacesService.getDetails . |
PlaceAspectRating PlaceAspectRating
google.maps.places.PlaceAspectRating
ממשק
המאפיין מגדיר מידע על היבט של המקום שהמשתמשים כתבו עליו ביקורת.
מאפיינים | |
---|---|
rating |
סוג:
number הדירוג של ההיבט הזה. בביקורות ספציפיות, זהו מספר שלם מ-0 עד 3. לדירוגים מצטברים של מקום, הערך הוא מספר שלם בין 0 ל-30. |
type |
סוג:
string סוג ההיבט. לדוגמה, "food" , "decor" , "service" או "overall" . |
BusinessStatus constants
google.maps.places.BusinessStatus
constants
סטטוס הפעילות של המקום, אם מדובר בעסק, שמוחזר ב-PlaceResult (מציין אם המקום פעיל או סגור זמנית או לצמיתות). אפשר לציין את הערכים האלה או את שם הקבוע (לדוגמה: 'OPERATIONAL'
או google.maps.places.BusinessStatus.OPERATIONAL
).
אפשר להתקשר אל const {BusinessStatus} = await google.maps.importLibrary("places")
כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
Constants | |
---|---|
CLOSED_PERMANENTLY |
העסק סגור לצמיתות. |
|