- בקשת HTTP
- פרמטרים של נתיב
- גוף הבקשה
- גוף התשובה
- VehicleAttributeList
- VehicleMatchOrder
- CurrentTripsPresent
- VehicleMatch
- Waypoint
- VehicleMatchType
מחזירה רשימה של כלי רכב שתואמים לאפשרויות הבקשה.
בקשת HTTP
POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles:search
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
parent |
חובה. חייב להיות בפורמט |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "header": { object ( |
שדות | |
---|---|
header |
כותרת הבקשה הרגילה של Fleet Engine. |
pickupPoint |
חובה. נקודת האיסוף שצריך לחפש בה. |
dropoffPoint |
המיקום המיועד למסירת הלקוח. חובה למלא את השדה הזה אם השדה |
pickupRadiusMeters |
חובה. ההגדרה הזו מגדירה את רדיוס חיפוש הרכב סביב נקודת האיסוף. יוחזרו רק כלי רכב שנמצאים ברדיוס החיפוש. הערך חייב להיות בין 400 ל-10,000 מטר (כולל). |
count |
חובה. מציין את המספר המקסימלי של רכבים שיש להחזיר. הערך חייב להיות בין 1 ל-50 (כולל). |
minimumCapacity |
חובה. מציין את מספר הנוסעים שרוצים לקחת בחשבון בנסיעה. הערך חייב להיות לפחות 1. ערך הקיבולת של הנהג לא נלקח בחשבון. |
tripTypes[] |
חובה. סוג הנסיעה המוצעת. חובה לכלול סוג אחד בדיוק. לא ניתן להפר את המדיניות: |
maximumStaleness |
מגביל את החיפוש רק לכלי הרכב ששלחו עדכוני מיקום ל-Feet Engine במהלך פרק הזמן שצוין. רכבים נייחים שעדיין משדרים את המיקומים שלהם לא נחשבים למיושנים. אם שדה זה לא מוגדר, השרת ישתמש בחמש דקות כערך ברירת המחדל. משך זמן בשניות עם עד תשע ספרות עשרוניות, המסתיים ב-' |
vehicleTypes[] |
חובה. מגביל את החיפוש לרכבים עם אחד מהסוגים שצוינו. צריך לציין לפחות סוג אחד של רכב. אסור להשתמש בסוגי רכב עם הקטגוריה |
requiredAttributes[] |
מתקשרים יכולים ליצור פעולות לוגיות מורכבות באמצעות כל שילוב של השדות
החיפוש יוגבל רק לכלי רכב עם המאפיינים שצוינו. השדה הזה הוא פעולת חיבור/AND. אפשר להוסיף עד 50 מאפיינים נדרשים. הערך הזה תואם למספר המקסימלי של מאפיינים שמותר להוסיף לרכב. |
requiredOneOfAttributes[] |
החיפוש יוגבל רק לכלי רכב שיש בהם לפחות אחד מהמאפיינים שצוינו בכל |
requiredOneOfAttributeSets[] |
בדומה ל-
החיפוש יוגבל רק לרכבים עם כל המאפיינים שמסומנים במאפיין |
orderBy |
חובה. מציין את קריטריון הסדר הרצוי של התוצאות. |
includeBackToBack |
הערך הזה מציין אם כלי רכב עם נסיעה פעילה אחת עומדים בדרישות לחיפוש הזה. השדה הזה משמש רק אם לא צוין ערך ברירת המחדל הוא |
tripId |
ציון הנסיעה המשויכת אל |
currentTripsPresent |
הכיתוב הזה מציין אם כלי רכב עם נסיעות פעילות עומדים בדרישות לחיפוש הזה. חובה להגדיר את הערך הזה לערך שאינו |
filter |
זה שינוי אופציונלי. שאילתת סינון שצריך להחיל כשמחפשים רכבים. בכתובת http://aip.dev/160 אפשר לראות דוגמאות לתחביר של המסנן. השדה הזה נועד להחליף את השדות המסנן הזה פועל כסעיף AND עם אילוצים אחרים, כמו חשוב לשים לב שהשאילתות היחידות שנתמכות הן בנושא מאפייני רכב (לדוגמה, בנוסף, כל המאפיינים נשמרים כמחרוזות, כך שההשוואות היחידות שנתמכות מול מאפיינים הן השוואות מחרוזות. כדי לבצע השוואה מול מספר או ערכים בוליאניים, צריך להקיף את הערכים במירכאות מפורשות, כך שהמערכת תתייחס אליהם כמחרוזות (לדוגמה, |
גוף התשובה
הודעת תגובה אחת (vehicles.search
).
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"matches": [
{
object ( |
שדות | |
---|---|
matches[] |
רשימה של רכבים שתואמים לקריטריונים של |
VehicleAttributeList
סוג נתונים של רשימת רשימות למאפייני רכב.
ייצוג JSON |
---|
{
"attributes": [
{
object ( |
שדות | |
---|---|
attributes[] |
רשימת המאפיינים באוסף הזה. |
VehicleMatchOrder
מציין את סדר ההתאמות של הרכב בתשובה.
טיפוסים בני מנייה (enums) | |
---|---|
UNKNOWN_VEHICLE_MATCH_ORDER |
ברירת המחדל, משמשת להזמנה של התאמת רכבים שלא צוינה או לא מזוהה. |
PICKUP_POINT_ETA |
בסדר עולה לפי זמן הנסיעה של הרכב אל נקודת האיסוף. |
PICKUP_POINT_DISTANCE |
סדר עולה לפי מרחק הנסיעה של כלי הרכב אל נקודת האיסוף. |
DROPOFF_POINT_ETA |
סדר עולה לפי זמן הנסיעה של כלי הרכב אל נקודת ההורדה. אפשר להשתמש בהזמנה הזו רק אם נקודת ההורדה צוינה בבקשה. |
PICKUP_POINT_STRAIGHT_DISTANCE |
סדר עולה לפי המרחק בקו הישר מהמיקום האחרון שדווח ברכב עד לנקודת האיסוף. |
COST |
סדר עולה לפי עלות ההתאמה שהוגדרה. עלות ההתאמה מוגדרת כחישוב משוקלל בין המרחק בקו ישר לבין זמן ההגעה המשוער. המשקלים מוגדרים עם ערכי ברירת מחדל ואפשר לשנות אותם לפי לקוח. אם צריך לשנות את המשקולות האלה בפרויקט, יש לפנות לתמיכה של Google. |
CurrentTripsPresent
ההגדרה הזו מציינת את סוגי ההגבלות על הנסיעות הנוכחיות של הרכב.
טיפוסים בני מנייה (enums) | |
---|---|
CURRENT_TRIPS_PRESENT_UNSPECIFIED |
הזמינות של כלי רכב שיש בהם נסיעות נקבעת לפי השדה includeBackToBack . |
NONE |
כלי רכב ללא נסיעות יכולים להופיע בתוצאות החיפוש. כשמשתמשים בערך הזה, includeBackToBack לא יכול להיות true . |
ANY |
כלי רכב עם 5 נסיעות עדכניות ו-10 ציוני דרך לכל היותר נכללים בתוצאות החיפוש. כשמשתמשים בערך הזה, includeBackToBack לא יכול להיות true . |
VehicleMatch
מכילה את הרכב ואומדנים קשורים לרכב שתואמים לנקודות הנסיעות הפעילות ברכב SearchVehiclesRequest
.
ייצוג JSON |
---|
{ "vehicle": { object ( |
שדות | |
---|---|
vehicle |
חובה. רכב שתואם לבקשה. |
vehiclePickupEta |
זמן ההגעה המשוער של הרכב לנקודת האיסוף שצוינה בבקשה. ערך ריק מציין כישלון בחישוב זמן ההגעה המשוער של הרכב. אם הערך של חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
vehiclePickupDistanceMeters |
המרחק מהמיקום הנוכחי של הרכב לנקודת האיסוף שציינתם בבקשה, כולל נקודות ביניים לאיסוף או הורדה לנסיעות קיימות. המרחק הזה כולל את מרחק הנסיעה המחושב (המסלול), וגם את מרחק הקו הישר בין נקודת הקצה של הניווט לבין נקודת האיסוף המבוקשת. (המרחק בין נקודת הסיום של הניווט לבין נקודת האיסוף המבוקשת הוא בדרך כלל קטן). ערך ריק מציין שגיאה בחישוב המרחק. |
vehiclePickupStraightLineDistanceMeters |
חובה. המרחק הישר בין הרכב לנקודת האיסוף שצוין בבקשה. |
vehicleDropoffEta |
זמן ההגעה המשוער ברכב השלם אל נקודת ההורדה שצוינה בבקשה. זמן ההגעה המשוער כולל עצירה בכל ציוני הדרך לפני חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
vehiclePickupToDropoffDistanceMeters |
מרחק הנסיעה של הרכב (במטרים) מנקודת האיסוף אל נקודת ההורדה שצוינה בבקשה. המרחק הוא רק בין שתי הנקודות, והוא לא כולל את מיקום הרכב או נקודות אחרות שצריך לבקר בהן לפני שהרכב מגיע לנקודת האיסוף או לנקודת ההורדה. הערך יאוכלס רק כאשר יצוינו |
tripType |
חובה. סוג הנסיעה לפי הבקשה ששימשה לחישוב זמן ההגעה המשוער לנקודת האיסוף. |
vehicleTripsWaypoints[] |
רשימה ממוינת של ציוני דרך שמשמשים לחישוב זמן ההגעה המשוער. הרשימה כוללת את מיקום הרכב, נקודות האיסוף של הנסיעות הפעילות של הרכב ונקודות האיסוף שצוינו בבקשה. רשימה ריקה מציינת כשל בחישוב זמן ההגעה המשוער של הרכב. |
vehicleMatchType |
סוג ההתאמה של הרכב. |
requestedOrderedBy |
הסדר המבוקש למיון התאמות כלי רכב. |
orderedBy |
ההזמנה בפועל שבה נעשה שימוש ברכב הזה. בדרך כלל הערך הזה יתאים לשדה 'orderBy' מהבקשה; עם זאת, בנסיבות מסוימות כמו שגיאת שרת פנימית, ניתן להשתמש בשיטה אחרת (כמו |
נקודת ציון
מתאר נקודות ביניים לאורך מסלול של VehicleMatch
בSearchVehiclesResponse
. הקונספט הזה מיוצג בתור TripWaypoint
בכל נקודות הקצה האחרות.
ייצוג JSON |
---|
{
"latLng": {
object ( |
שדות | |
---|---|
latLng |
המיקום של ציון הדרך הזה. |
eta |
הזמן המשוער שהרכב יגיע לנקודת הדרך הזו. חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
VehicleMatchType
סוג ההתאמה לרכב.
טיפוסים בני מנייה (enums) | |
---|---|
UNKNOWN |
סוג התאמה לא ידוע של רכב |
EXCLUSIVE |
כרגע לא הוקצתה נסיעה לרכב, והוא יכול להמשיך לנקודת האיסוף. |
BACK_TO_BACK |
הרכב מוקצה כרגע לנסיעה, אבל הוא יכול להמשיך לנקודת האיסוף אחרי השלמת הנסיעה. בחישובי זמן ההגעה המשוער והמרחק, הנסיעה הנוכחית נלקחת בחשבון. |
CARPOOL |
יש ברכב מספיק קיבולת לנסיעה משותפת. |
CARPOOL_BACK_TO_BACK |
הרכב יסיים את הנסיעה הפעילה הנוכחית לפני שימשיך לנקודת האיסוף. בחישובי זמן ההגעה המשוער והמרחק, הנסיעה הנוכחית נלקחת בחשבון. |