Method: providers.vehicles.search

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

בקשת HTTP

POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles:search

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. חייב להיות בפורמט providers/{provider}. הספק צריך להיות מזהה הפרויקט (למשל sample-cloud-project) של הפרויקט ב-Google Cloud שמשויך לחשבון השירות שמבצע את הקריאה הזו.

גוף הבקשה

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

ייצוג JSON 
{
  "header": {
    object (RequestHeader)
  },
  "pickupPoint": {
    object (TerminalLocation)
  },
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "pickupRadiusMeters": integer,
  "count": integer,
  "minimumCapacity": integer,
  "tripTypes": [
    enum (TripType)
  ],
  "maximumStaleness": string,
  "vehicleTypes": [
    {
      object (VehicleType)
    }
  ],
  "requiredAttributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "requiredOneOfAttributes": [
    {
      object (VehicleAttributeList)
    }
  ],
  "requiredOneOfAttributeSets": [
    {
      object (VehicleAttributeList)
    }
  ],
  "orderBy": enum (VehicleMatchOrder),
  "includeBackToBack": boolean,
  "tripId": string,
  "currentTripsPresent": enum (CurrentTripsPresent),
  "filter": string
}
שדות
header

object (RequestHeader)

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

object (TerminalLocation)

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

object (TerminalLocation)

נקודת הנטישה של הלקוח. השדה הזה נדרש אם tripTypes מכיל את הערך TripType.SHARED.
pickupRadiusMeters

integer

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

integer

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

integer

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

enum (TripType)

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

string (Duration format)

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

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

object (VehicleType)

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

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 מאפיינים נדרשים. הערך הזה תואם למספר המאפיינים המקסימלי שמותר לכלול ברכב.
requiredOneOfAttributes[]

object (VehicleAttributeList)

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

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.
orderBy

enum (VehicleMatchOrder)

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

boolean

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

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

string

ציון הנסיעה המשויכת אל SearchVehicleRequest.
currentTripsPresent

enum (CurrentTripsPresent)

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

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").

גוף התשובה

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