列出配送車輛

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

環境和限制

你可以透過伺服器或瀏覽器環境列出送貨車輛。Driver SDK 不支援列出送貨車輛。

列出送貨車輛要求廣泛存取送貨車輛，且僅適用於信任的使用者。提出列出送貨車輛的要求時，請使用「Delivery Fleet Reader」或「Fleet Engine Delivery Admin」權杖。

由於會影響回應大小，系統會遮蓋所列送貨車輛的下列欄位：

  • CurrentRouteSegment
  • RemainingVehicleJourneySegments

用量

您可以依屬性篩選器和可視範圍界線列出車輛。如果未指定篩選條件或檢視區塊，回應會包含所有運送車輛。

列出含有屬性篩選器的項目

你可以使用 attributes 屬性篩選條件列出送貨車輛。舉例來說，如要查詢鍵為 my_key 且值為 my_value 的屬性，請使用 attributes.my_key = my_value。如要查詢多個屬性，請使用邏輯 AND 和 OR 運算子，如 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
  }

後續步驟