הפונקציה מחזירה רשימה מעומדת של כלי רכב המשויכים לספק שתואמות לאפשרויות הבקשה.
בקשת HTTP
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
parent |
חובה. חייב להיות בפורמט |
פרמטרים של שאילתה
פרמטרים | |
---|---|
header |
כותרת הבקשה הרגילה של Fleet Engine. |
pageSize |
המספר המקסימלי של כלי רכב שיש להחזיר. ערך ברירת המחדל: 100. |
pageToken |
הערך של |
minimumCapacity |
הנתון הזה מציין את הקיבולת המינימלית הנדרשת של הרכב. ערך |
tripTypes[] |
מגבילה את התגובה לכלי רכב שתומכים לפחות באחד מסוגי הנסיעה שצוינו. |
maximumStaleness |
הגבלת התגובה לכלי רכב ששלחו עדכוני מיקום ל-Flit 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 |
חובה. הנקודה הגבוהה של אזור התצוגה. |