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)

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

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