הפונקציה מחזירה רשימה מקטעי של כלי רכב שמשויכים לספק שתואמים לאפשרויות הבקשה.
בקשת HTTP
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
parent |
חובה. הפורמט הנדרש הוא |
פרמטרים של שאילתה
פרמטרים | |
---|---|
header |
כותרת הבקשה הרגילה של Fleet Engine. |
page |
המספר המקסימלי של כלי רכב להחזרה. ערך ברירת המחדל: 100. |
page |
הערך של |
minimum |
מציין את הקיבולת המינימלית הנדרשת של הרכב. הערך של |
trip |
הגבלת התגובה לכלי רכב שתומכים לפחות באחד מסוגי הנסיעות שצוינו. |
maximum |
הגבלת התגובה לכלי רכב ששלחו עדכוני מיקום ל-Fleet Engine בטווח הזמן שצוין. רכבים סטטיים שעדיין משדרים את המיקומים שלהם לא נחשבים לא מעודכנים. אם הערך הזה קיים, הוא חייב להיות משך זמן חוקי וחיובי. משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-' |
vehicle |
חובה. הגבלת התגובה לכלי רכב עם אחת מקטגוריות הסוג שצוינו. לא ניתן להפר את המדיניות: |
required |
מתקשרים יכולים ליצור פעולות לוגיות מורכבות באמצעות כל שילוב של השדות
המדיניות מגבילה את התגובה לכלי רכב עם המאפיינים שצוינו. השדה הזה הוא פעולת חיבור/AND. אפשר להוסיף עד 50 מאפייני requiredAttributes. המספר הזה תואם למספר המקסימלי של מאפיינים שמותר להוסיף לרכב. כל מחרוזת חוזרת צריכה להיות בפורמט 'key:value'. |
required |
הגבלת התגובה לכלי רכב עם לפחות אחד מהמאפיינים שצוינו בכל |
required |
בדומה ל-
המדיניות מגבילה את התגובה לכלי רכב שתואמים לכל המאפיינים ב- |
vehicle |
הגבלת התגובה לרכבים עם מצב הרכב הזה. |
on |
החזרת רכבים עם נסיעות נוכחיות בלבד. |
filter |
זה שינוי אופציונלי. שאילתת סינון שצריך להחיל כשמציגים כלי רכב. דוגמאות לתחביר של המסנן זמינות בכתובת http://aip.dev/160. השדה הזה נועד להחליף את השדות המסנן הזה פועל כתנאי AND עם אילוצים אחרים, כמו הערה: השאילתות היחידות שנתמכות הן על מאפייני רכב (לדוגמה, בנוסף, כל המאפיינים מאוחסנים כמחרוזות, כך שההשוואות היחידות הנתמכות למאפיינים הן השוואות של מחרוזות. כדי להשוות לערכים מספריים או לערכים בוליאניים, צריך להוסיף לכל הערכים מירכאות מפורשות כדי שיוגדרו כמחרוזות (לדוגמה, |
viewport |
זה שינוי אופציונלי. מסנן שמגביל את הרכבים שמוחזרים רק לאלה שהמיקום הידוע האחרון שלהם היה באזור המלבני שמוגדר על ידי חלון התצוגה. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
הודעת תגובה אחת (vehicles.list
).
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
ייצוג ב-JSON |
---|
{
"vehicles": [
{
object ( |
שדות | |
---|---|
vehicles[] |
כלי רכב שתואמים לקריטריונים בבקשה. המספר המקסימלי של כלי רכב שהוחזרו נקבע לפי השדה |
next |
אסימון לאחזור דף הרכבים הבא, או ריק אם אין יותר רכבים שעומדים בקריטריונים של הבקשה. |
total |
חובה. המספר הכולל של כלי הרכב שתואמים לקריטריונים של הבקשה בכל הדפים. |
אזור התצוגה
אזור תצוגה של קו רוחב, מיוצג בשתי אלכסון מול 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 |
חובה. הנקודה הגבוהה ביותר באזור התצוגה. |