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)

הגבלת התגובה לכלי רכב ששלחו עדכוני מיקום ל-Flit 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 ופעולת חיתוך/OR כוללת, באוסף של 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)

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