Method: providers.vehicles.list

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

בקשת HTTP

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

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

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

פרמטרים
parent

string

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

פרמטרים של שאילתה

פרמטרים
header

object (RequestHeader)

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

pageSize

integer

המספר המקסימלי של כלי רכב שצריך להחזיר. ערך ברירת המחדל: 100.

pageToken

string

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

minimumCapacity

integer

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

tripTypes[]

enum (TripType)

הגבלת התגובה לכלי רכב שתומכים לפחות באחד מסוגי הנסיעה שצוינו.

maximumStaleness

string (Duration format)

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

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

vehicleTypeCategories[]

enum (Category)

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

requiredAttributes[]

string

מתקשרים יכולים ליצור פעולות לוגיות מורכבות באמצעות כל שילוב של השדות 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 מאפייני חובה. הערך הזה תואם למספר המאפיינים המקסימלי שמותר לכלול ברכב. כל מחרוזת חוזרת צריכה להיות בפורמט "key:value".

requiredOneOfAttributes[]

string

הגבלת התגובה לכלי רכב עם לפחות אחד מהמאפיינים שצוינו בכל VehicleAttributeList. בכל רשימה, הרכב צריך להתאים לפחות לאחד מהמאפיינים. השדה הזה הוא פעולת פירוק/או (OR) כוללני בכל VehicleAttributeList ופעולת חיבור/AND בכל האוסף של VehicleAttributeList. כל מחרוזת חוזרת צריכה להיות בפורמט "key1:value1|key2:value2|key3:value3".

requiredOneOfAttributeSets[]

string

האפליקציה 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 פרטנית/או כוללת בכל האוסף של VehicleAttributeList. כל מחרוזת חוזרת צריכה להיות בפורמט "key1:value1|key2:value2|key3:value3".

vehicleState

enum (VehicleState)

הגבלת התגובה לכלי רכב עם מצב הרכב הזה.

onTripOnly

boolean

החזרת רכבים עם נסיעות נוכחיות בלבד.

filter

string

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

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

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

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

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

viewport

object (Viewport)

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

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

הודעת תגובה אחת (vehicles.list).

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

ייצוג JSON
{
  "vehicles": [
    {
      object (Vehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
שדות
vehicles[]

object (Vehicle)

כלי רכב שתואמים לקריטריונים של הבקשה. המספר המקסימלי של כלי רכב שהוחזרו נקבע לפי השדה pageSize בבקשה.

nextPageToken

string

אסימון לשחזור הדף הבא של כלי רכב, או ריק אם אין עוד רכבים שעומדים בקריטריונים של הבקשה.

totalSize

string (int64 format)

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

אזור התצוגה

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

  • אם low = high, אזור התצוגה מורכב מנקודה אחת בלבד.

  • אם הערך של low.longitude > high.longitude, טווח קו האורך הפוך (אזור התצוגה חוצה את קו האורך 180 מעלות).

  • אם הערך של low.longitude = -180 מעלות ו- high.longitude = 180 מעלות, אזור התצוגה כולל את כל קווי האורך

  • אם low.longitude = 180 מעלות ו-high.longitude = 180 מעלות, טווח קו האורך ריק.

  • אם הערך של low.latitude > high.latitude, טווח קו הרוחב ריק.

צריך לאכלס גם את low וגם את high, והתיבה המיוצגת לא יכולה להיות ריקה (כפי שצוין בהגדרות שלמעלה). אזור תצוגה ריק יגרום לשגיאה.

לדוגמה, אזור התצוגה הזה כולל את כל העיר תל אביב:

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

ייצוג JSON
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
שדות
low

object (LatLng)

חובה. הנקודה הנמוכה של אזור התצוגה.

high

object (LatLng)

חובה. הנקודה הגבוהה של אזור התצוגה.