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".

גוף התשובה

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

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

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

object (Trip)

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

string

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