הפונקציה מחזירה רשימה מקטעי של כלי רכב שמשויכים לספק שתואמים לאפשרויות הבקשה.
בקשת HTTP
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
parent |
חובה. חייב להיות בפורמט |
פרמטרים של שאילתה
פרמטרים | |
---|---|
header |
כותרת הבקשה הרגילה של Fleet Engine. |
pageSize |
המספר המקסימלי של כלי רכב שצריך להחזיר. ערך ברירת המחדל: 100. |
pageToken |
הערך של ה |
minimumCapacity |
מציינת את הקיבולת המינימלית הנדרשת של הרכב. הערך של כל כלי הרכב שמוחזרים יהיה |
tripTypes[] |
הגבלת התגובה לכלי רכב שתומכים לפחות באחד מסוגי הנסיעה שצוינו. |
maximumStaleness |
הגבלת התגובה לכלי רכב ששלחו עדכוני מיקום ל-Fleet Engine בטווח הזמן שצוין. כלי רכב נייחים שעדיין מעבירים את מיקומם לא נחשבים למיושנים. אם השדה הזה קיים, הוא צריך להיות משך זמן תקין תקין. משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-' |
vehicleTypeCategories[] |
חובה. מגבילה את התגובה לכלי רכב עם אחת מקטגוריות הסוגים שצוינו. לא ניתן להפר את המדיניות: |
requiredAttributes[] |
מתקשרים יכולים ליצור פעולות לוגיות מורכבות באמצעות כל שילוב של השדות
המדיניות מגבילה את התגובה לכלי רכב עם המאפיינים שצוינו. השדה הזה הוא פעולת חיבור/AND. אפשר להוסיף עד 50 מאפייני חובה. הערך הזה תואם למספר המאפיינים המקסימלי שמותר לכלול ברכב. כל מחרוזת חוזרת צריכה להיות בפורמט "key:value". |
requiredOneOfAttributes[] |
הגבלת התגובה לכלי רכב עם לפחות אחד מהמאפיינים שצוינו בכל |
requiredOneOfAttributeSets[] |
האפליקציה בדומה ל-
המדיניות מגבילה את התגובה לכלי רכב שתואמים לכל המאפיינים ב- |
vehicleState |
הגבלת התגובה לכלי רכב עם מצב הרכב הזה. |
onTripOnly |
החזרת רכבים עם נסיעות נוכחיות בלבד. |
filter |
זה שינוי אופציונלי. שאילתת סינון שצריך להחיל כשמציגים כלי רכב. דוגמאות לתחביר של המסנן: http://aip.dev/160 השדה הזה נועד להחליף את השדות המסנן הזה פועל כתנאי AND עם אילוצים אחרים, כמו לתשומת ליבכם, השאילתות היחידות שנתמכות הן על מאפייני רכב (לדוגמה, בנוסף, כל המאפיינים מאוחסנים כמחרוזות, כך שאפשר להשוות רק בין מחרוזות לבין מאפיינים. כדי להשוות מול ערכים של מספרים או בוליאניים, יש להקיף את הערכים באופן מפורש כך שיטופלו כמחרוזות (לדוגמה, |
viewport |
זה שינוי אופציונלי. מסנן שמגביל את כלי הרכב שמוחזרים בכלי רכב שהמיקום הידוע האחרון שלהם היה באזור המלבני שהוגדר באזור התצוגה. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
הודעת תגובה אחת (vehicles.list
).
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"vehicles": [
{
object ( |
שדות | |
---|---|
vehicles[] |
כלי רכב שתואמים לקריטריונים של הבקשה. המספר המקסימלי של כלי רכב שהוחזרו נקבע לפי השדה |
nextPageToken |
אסימון לשחזור הדף הבא של כלי רכב, או ריק אם אין עוד רכבים שעומדים בקריטריונים של הבקשה. |
totalSize |
חובה. המספר הכולל של כלי רכב שתואמים לקריטריוני הבקשה בכל הדפים. |
אזור התצוגה
אזור תצוגה של קו רוחב, מיוצג בשתי אלכסון מול 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 ( |
שדות | |
---|---|
low |
חובה. הנקודה הנמוכה של אזור התצוגה. |
high |
חובה. הנקודה הגבוהה של אזור התצוגה. |