Method: providers.vehicles.list

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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 מאפייני requiredAttributes. המספר הזה תואם למספר המקסימלי של מאפיינים שמותר להוסיף לרכב. כל מחרוזת חוזרת צריכה להיות בפורמט '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, והתיבה שמייצגת אותם לא יכולה להיות ריקה (כפי שצוין בהגדרות שלמעלה). אזור תצוגה ריק יגרום לשגיאה.

לדוגמה, חלון התצוגה הזה כולל את ניו יורק במלואה:

{ &quot;low&quot;: { &quot;latitude&quot;: 40.477398, &quot;longitude&quot;: -74.259087 }, &quot;high&quot;: { &quot;latitude&quot;: 40.91618, &quot;longitude&quot;: -73.70018 } }

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

object (LatLng)

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

high

object (LatLng)

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