Method: searchAlongRoute

לחפש מקומות לאורך מסלול הנסיעה.

בקשת HTTP

POST https://mapstools.googleapis.com/v1:searchAlongRoute

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "routingPreference": enum (RoutingPreference),
  "includeExtendedDetails": boolean,
  "travelMode": enum (RouteTravelMode),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "encodedPolyline": string,
  "retrievalToken": string,
  "routeEndpoints": {
    object (RouteEndpoints)
  }
  // End of mutually exclusive fields.
}
שדות
textQuery

string

חובה. שאילתת חיפוש בשפה טבעית (למשל, "מטענים לרכב חשמלי", "קפה").
languageCode

string

זה שינוי אופציונלי. השפה של הסיכום ופרטי המקום. ברירת המחדל היא "en-US".
regionCode

string

זה שינוי אופציונלי. קוד המדינה או האזור (CLDR) של המיקום (למשל, "US").
routingPreference

enum (RoutingPreference)

זה שינוי אופציונלי. העדפת מסלול אופציונלית שמציינת איך להשתמש בנתוני התנועה. ברירת המחדל היא TRAFFIC_UNAWARE.
includeExtendedDetails

boolean

זה שינוי אופציונלי. כולל פרטי מקום מורחבים בתשובה.

הגדירו את השדה הזה לערך true כשהבקשה של המשתמש דורשת תובנות איכותיות עשירות, דינמיקה בזמן אמת או מאפייני ישות מיוחדים: - ביקורות איכותיות, סנטימנט של לקוחות ומשוב. - פריטים ספציפיים כמו מנות בתפריט, מאכלים מיוחדים, משקאות או מאפיינים בולטים של העסק. - אווירה, עיצוב פנים, אסתטיקה או מצב רוח איכותיים. - נתונים בזמן אמת ומפרטים של מתקנים מיוחדים, מדיניות/טיפים למבקרים, זמני המתנה.

משאירים את הערך false (ברירת המחדל) לחיפושים רגילים (למשל, סוגי מטבחים, סוגי חנויות), חיפושי מיקום/כתובת, פרטים ליצירת קשר, שעות פעילות ומטא-נתונים/שירותים רגילים.

הפעלת השדה הזה עלולה לגרום לזמן אחזור ארוך יותר.
travelMode

enum (RouteTravelMode)

זה שינוי אופציונלי. מציין את אופן הנסיעה שמשמש לחישוב המסלול ודרכי המעקף. ברירת המחדל היא DRIVE. האפשרויות WALK ו-BICYCLE נתמכות רק עם routeEndpoints. אין תמיכה ב-TRANSIT.
מפרט המסלול: מסלול קיים, אסימון מסלול או נקודות קצה של מוצא/יעד. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
encodedPolyline

string

מחרוזת של קו פוליגוני מקודד שמייצגת את המסלול. מידע נוסף זמין בכתובת https://developers.google.com/maps/documentation/utilities/polylinealgorithm
retrievalToken

string

אסימון אחזור שהוחזר מקריאה קודמת ל-v1.computeRoutes שמייצג את המסלול.
routeEndpoints

object (RouteEndpoints)

נקודות קצה מפורשות של המסלול (מוצא ויעד).
סוף השדות שמוציאים זה את זה.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של SearchAlongRouteResponse.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/maps-platform.mapstools