Method: providers.deliveryVehicles.list

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. חייב להיות בפורמט providers/{provider}. השדה provider חייב להיות מזהה הפרויקט ב-Google Cloud. לדוגמה, sample-cloud-project.

פרמטרים של שאילתה

פרמטרים
header

object (DeliveryRequestHeader)

זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API.
pageSize

integer

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

string

זה שינוי אופציונלי. אסימון דף, שהתקבל מקריאה קודמת ב-deliveryVehicles.list. צריך לספק את הפרטים האלה כדי לאחזר את הדף הבא.

כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-deliveryVehicles.list חייבים להתאים לקריאה שסיפקה את אסימון הדף.
filter

string

זה שינוי אופציונלי. שאילתת סינון שתחול כשמציגים כלי רכב למשלוחים. דוגמאות לתחביר של המסנן זמינות בכתובת http://aip.dev/160. אם לא מציינים ערך או אם מציינים מחרוזת ריקה למסנן, כל כלי המסירה יוחזרו.

חשוב לזכור שהשאילתות היחידות שנתמכות ב-deliveryVehicles.list הן על מאפייני רכב (לדוגמה, attributes.<key> = <value> או attributes.<key1> = <value1> AND attributes.<key2> = <value2>). כמו כן, כל המאפיינים מאוחסנים כמחרוזות, ולכן ההשוואות היחידות שנתמכות למאפיינים הן השוואות של מחרוזות. כדי להשוות מול ערכים של מספרים או בוליאניים, יש להקיף את הערכים באופן מפורש כך שיטופלו כמחרוזות (לדוגמה, attributes.<key> = "10" או attributes.<key> = "true").

המספר המקסימלי של הגבלות שמותר להוסיף לשאילתת סינון הוא 50. הגבלה היא חלק מהשאילתה בפורמט attribute.<KEY> <COMPARATOR> <VALUE>. לדוגמה, attributes.foo = bar היא הגבלה אחת.
viewport

object (Viewport)

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

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

הודעת התגובה deliveryVehicles.list.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:

ייצוג JSON 
{
  "deliveryVehicles": [
    {
      object (DeliveryVehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
שדות
deliveryVehicles[]

object (DeliveryVehicle)

קבוצת כלי הרכב להעברה שעומד בקריטריונים המבוקשים לסינון. אם לא מציינים מסנן, הבקשה מחזירה את כל כלי הרכב להעברה. תגובה מוצלחת יכולה גם להיות ריקה. תגובה ריקה מציינת שלא נמצאו כלי רכב להעברת מוצרים שתואמים לקריטריונים המבוקשים של המסנן.
nextPageToken

string

אפשר להעביר את האסימון הזה ב-ListDeliveryVehiclesRequest כדי להמשיך להציג תוצאות. כשכל התוצאות מוחזרות, השדה הזה לא יופיע בתשובה או שהוא יהיה מחרוזת ריקה.
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)

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