Method: providers.deliveryVehicles.list

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

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

פרמטרים
parent

string

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

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

פרמטרים
header

object (DeliveryRequestHeader)

אפשרות. כותרת הבקשה הרגילה של ה-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 היא הגבלה 1.
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)

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