Method: providers.trips.search

הצגת כל הנסיעות ברכב מסוים.

בקשת HTTP

POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/trips:search

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

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

פרמטרים
parent

string

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

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON
{
  "header": {
    object (RequestHeader)
  },
  "vehicleId": string,
  "activeTripsOnly": boolean,
  "pageSize": integer,
  "pageToken": string,
  "minimumStaleness": string
}
שדות
header

object (RequestHeader)

כותרת הבקשה הרגילה של Fleet Engine.

vehicleId

string

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

  • currentRouteSegment
  • remainingWaypoints
  • remainingDistanceMeters
  • etaToFirstWaypoint
activeTripsOnly

boolean

אם הערך מוגדר כ-true, התגובה תכלול נסיעות שמשפיעות על המסלול של הנהג.

pageSize

integer

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

pageToken

string

כדי להמשיך מהתוצאות הקודמות, צריך להגדיר את הערך הזה לערך שהוחזר בעבר ב-SearchTripsResponse.

minimumStaleness

string (Duration format)

אם מצוין, הפונקציה מחזירה את הנסיעות שלא עודכנו אחרי השעה (current - minimumStaleness).

משך הזמן בשניות, עם עד תשע ספרות עשרוניות, שמסתיימים ב-'s'. דוגמה: "3.5s".

גוף התשובה

הודעת התגובה של trips.search.

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

ייצוג ב-JSON
{
  "trips": [
    {
      object (Trip)
    }
  ],
  "nextPageToken": string
}
שדות
trips[]

object (Trip)

רשימת הנסיעות של הרכב המבוקש.

nextPageToken

string

מעבירים את האסימון הזה ב-SearchTripsRequest כדי לדפדף בתוצאות הרשימה. ה-API מחזיר רשימת נסיעות בכל קריאה, וכאשר אין יותר תוצאות, רשימת הנסיעות ריקה.