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 מחזיר רשימת נסיעות בכל קריאה, ואם לא נותרו תוצאות, רשימת הנסיעות ריקה.