Method: providers.vehicles.search

object (RequestHeader)

כותרת הבקשה הרגילה של Fleet Engine.

object (TerminalLocation)

חובה. נקודת האיסוף שרוצים לחפש בסביבתה.

object (TerminalLocation)

המיקום המתוכנן של מסירת ההזמנה ללקוח. השדה הזה נדרש אם השדה tripTypes מכיל את השדה TripType.SHARED.

integer

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

integer

חובה. מציין את המספר המקסימלי של כלי רכב להחזרה. הערך צריך להיות בין 1 ל-50 (כולל).

integer

חובה. מספר הנוסעים שנלקחים בחשבון לנסיעה. הערך חייב להיות גדול מ-1 או שווה לו. הנהג לא נכלל בערך הקיבולת.

enum (TripType)

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

string (Duration format)

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

משך הזמן בשניות, עם עד תשע ספרות עשרוניות, שמסתיימים ב-'s'. דוגמה: "3.5s".

object (VehicleType)

חובה. הגבלת החיפוש לכלי רכב מאחד מהסוגים שצוינו. צריך לציין לפחות סוג רכב אחד. אסור להשתמש ב-VehicleTypes עם קטגוריה UNKNOWN.

object (VehicleAttribute)

מבצעי הקריאה יכולים ליצור פעולות לוגיות מורכבות באמצעות כל שילוב של השדות requiredAttributes,‏ requiredOneOfAttributes ו-requiredOneOfAttributeSets.

requiredAttributes היא רשימה. ב-requiredOneOfAttributes נעשה שימוש בהודעה שמאפשרת רשימה של רשימות. בשילוב, שני השדות מאפשרים ליצור את הביטוי הזה:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(requiredOneOfAttributes[0][0] OR requiredOneOfAttributes[0][1] OR
...)
AND
(requiredOneOfAttributes[1][0] OR requiredOneOfAttributes[1][1] OR
...)

הגבלת החיפוש רק לרכבים עם המאפיינים שצוינו. השדה הזה הוא פעולת התחברות/AND. אפשר להוסיף עד 50 מאפייני requiredAttributes. זהו המספר המקסימלי של מאפיינים שמותר להוסיף לרכב.

object (VehicleAttributeList)

הגבלת החיפוש רק לכלי רכב שיש להם לפחות אחד מהמאפיינים שצוינו בכל VehicleAttributeList. בכל רשימה, הרכב חייב להתאים לפחות לאחד מהמאפיינים. השדה הזה הוא פעולת או/OR כוללנית בכל VehicleAttributeList ופעולת וג/AND על פני האוסף של VehicleAttributeList.

object (VehicleAttributeList)

requiredOneOfAttributeSets מספק פונקציונליות נוספת.

בדומה ל-requiredOneOfAttributes, גם ב-requiredOneOfAttributeSets נעשה שימוש בהודעה שמאפשרת רשימה של רשימות, ומאפשרת להשתמש בביטויים כמו זה:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(
  (requiredOneOfAttributeSets[0][0] AND
  requiredOneOfAttributeSets[0][1] AND
  ...)
  OR
  (requiredOneOfAttributeSets[1][0] AND
  requiredOneOfAttributeSets[1][1] AND
  ...)
)

הגבלת החיפוש רק לרכבים שיש להם את כל המאפיינים ב-VehicleAttributeList. בכל רשימה, הרכב חייב להתאים לכל המאפיינים. השדה הזה הוא פעולת חיבור/AND בכל VehicleAttributeList ופעולת חיבור/OR כוללנית בכל האוסף של VehicleAttributeList.

enum (VehicleMatchOrder)

חובה. מציין את קריטריון הסדר הרצוי של התוצאות.

boolean

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

ערך ברירת המחדל הוא false.

string

הנסיעה שמשויכת ל-SearchVehicleRequest הזה.

enum (CurrentTripsPresent)

האפשרות הזו מציינת אם רכבים עם נסיעות פעילות עומדים בדרישות החיפוש הזה. אם השדה tripType כולל את השדה SHARED, צריך להגדיר לו ערך שאינו CURRENT_TRIPS_PRESENT_UNSPECIFIED.

string

זה שינוי אופציונלי. שאילתת סינון שחלה במהלך חיפוש כלי רכב. דוגמאות לתחביר של המסנן זמינות בכתובת http://aip.dev/160.

השדה הזה נועד להחליף את השדות requiredAttributes,‏ requiredOneOfAttributes ו-required_one_of_attributes_sets. אם מציינים כאן ערך שאינו ריק, השדות הבאים חייבים להיות ריקים: requiredAttributes,‏ requiredOneOfAttributes ו-required_one_of_attributes_sets.

המסנן הזה פועל כתנאי AND עם אילוצים אחרים, כמו minimumCapacity או vehicleTypes.

הערה: השאילתות היחידות שנתמכות הן על מאפייני כלי רכב (לדוגמה, attributes.<key> = <value> או attributes.<key1> = <value1> AND attributes.<key2> = <value2>). מספר ההגבלות המקסימלי שמותר בשאילתת סינון הוא 50.

בנוסף, כל המאפיינים מאוחסנים כמחרוזות, כך שההשוואות היחידות הנתמכות למאפיינים הן השוואות בין מחרוזות. כדי להשוות לערכים מספריים או לערכים בוליאניים, צריך להוסיף לכל הערכים מירכאות מפורשות כדי שיוגדרו כמחרוזות (לדוגמה, attributes.<key> = "10" או attributes.<key> = "true").