列出配送車輛

本文件說明如何列出配送車輛。

環境和限制

您可以透過伺服器或瀏覽器環境列出運輸車輛。駕駛座 SDK 不支援列出交付車輛。

刊登交車車輛要求廣泛使用貨運車輛, 只供信任的使用者使用使用 Delivery Fleet ReaderFleet Engine 提出清單配送車輛要求時,傳遞管理員權杖。

刊登的貨車車輛因影響而遮蓋以下欄位 回應大小:

  • CurrentRouteSegment
  • RemainingVehicleJourneySegments

用量

您可以依據屬性篩選器和檢視區範圍列出車輛。如果您未指定篩選器或檢視區,回應就會包含所有發布媒介。

含有屬性篩選器的清單

您可以使用 attributes 屬性篩選貨運車輛。舉例來說,如要查詢鍵為 my_key 且值為 my_value 的屬性,請使用 attributes.my_key = my_value。如要查詢多個屬性,請使用邏輯 ANDOR 運算子彙整查詢,如同 attributes.key1 = value1 AND attributes.key2 = value2 中的做法。如需篩選器查詢語法的完整說明,請參閱 AIP-160。當您將篩選器與可視區域範圍搭配使用時,篩選器 可做為可視區域邊界的 AND 運算子。詳情請參閱「車輛屬性篩選器查詢」。

含有檢視區範圍邊界清單

您可以使用 viewport 要求,依地點篩選列出的運輸車輛 參數。viewport 要求參數會使用兩個邊界座標定義檢視區:high (東北) 和 low (西南) 經緯度座標組合。如果要求包含高緯度,但實際上低於低緯度,系統會拒絕該要求。

清單回應

根據預設,配送車輛清單的頁面大小會以適當的頁面大小進行分頁。如果 如果指定頁面大小,該要求只會傳回車輛數量 可能會超過這個上限如果要求的頁面大小超過內部最大值,系統就會使用內部最大值。預設頁面和最大頁面 尺寸都是 100 輛車

快遞車輛清單可包含用於讀取下一頁 也就是預測結果只有在提交更多頁面時,回應中才會出現網頁權杖 車輛可供擷取。如要擷取下一頁的工作,請使用 用來要求的網頁權杖與 請求。

車輛清單範例

您可以使用 Java gRPC 程式庫或 REST,在 含有特定屬性的區域就算 並將空無一物。發生此情況時,就表示沒有指定屬性的車輛 已存在於指定的檢視點中

Java


  static final String PROJECT_ID = "my-delivery-co-gcp-project";

  DeliveryServiceBlockingStub deliveryService =
    DeliveryServiceGrpc.newBlockingStub(channel);

  // Tasks request
  String parent = "providers/" + PROJECT_ID;
  ListDeliveryVehiclesRequest listDeliveryVehiclesRequest =
    ListDeliveryVehiclesRequest.newBuilder()  // No need for the header
        .setParent(parent)
        .setViewport(
              Viewport.newBuilder()
                .setHigh(LatLng.newBuilder()
                    .setLatitude(37.45)
                    .setLongitude(-122.06)
                    .build())
                .setLow(LatLng.newBuilder()
                    .setLatitude(37.41)
                    .setLongitude(-122.11)
                    .build())
        .setFilter("attributes.my_key = my_value")
        .build();

  try {
    ListDeliveryVehiclesResponse listDeliveryVehiclesResponse =
        deliveryService.listDeliveryVehicles(listDeliveryVehiclesRequest);
  } catch (StatusRuntimeException e) {
    Status s = e.getStatus();
    switch (s.getCode()) {
        case NOT_FOUND:
            break;

        case PERMISSION_DENIED:
            break;
    }
    return;
  }

REST

  # HTTP request
  html GET https://fleetengine.googleapis.com/v1/providers/<project_id>/deliveryVehicles

  # Request with a filter
  # Request sets JWT, PROJECT_ID, and VEHICLE_ID in the local environment
  curl -H "Authorization: Bearer ${JWT}" \
    "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/deliveryVehicles?filter=attributes.my_key%20%3D%20my_value%20&viewport.high.latitude=37.45&viewport.high.longitude=-122.06&viewport.low.latitude=37.41&viewport.low.longitude=-122.11"

如果查詢成功,回應主體會包含下列資料 結構:

  // JSON representation
  {
    "deliveryVehicles": [
      {
        object (DeliveryVehicle)
      }
    ],
    "nextPageToken": string,
    "totalSize": integer
  }

後續步驟