How to create and upload a shipment-model json file to GCS | Google Maps Route Optimization for PHP

[Rudi-Mediawave]

Hi, thanks for advice and help.

Currently I am using a library from Google: "google/maps-routeoptimization" specifically for PHP to create a shipment-model.json file and will upload it to GCS.

The code I have created so far is as follows:

<?php

use Google\Maps\RouteOptimization\V1\OptimizeToursRequest;
use Google\Maps\RouteOptimization\V1\Vehicle;
use Google\Maps\RouteOptimization\V1\Vehicle\LoadLimit;
use Google\Protobuf\Timestamp;
use Google\Type\LatLng;
use Google\Maps\RouteOptimization\V1\Shipment;
use Google\Maps\RouteOptimization\V1\Shipment\VisitRequest;
use Google\Maps\RouteOptimization\V1\ShipmentModel;
use Google\Maps\RouteOptimization\V1\Waypoint;
use Google\Maps\RouteOptimization\V1\Location;
use Google\Maps\RouteOptimization\V1\Vehicle\DurationLimit;
use Illuminate\Support\Facades\Log;

if (!function_exists('generate_shipment_model')) {
    /**
     * Generate a new shipment model data.
     *
     * @param array $shipments
     * @param array $vehicles
     * @param int $maxActiveVehicles
     * @param string $globalStartTime
     * @param string $globalEndTime
     * @return string|bool
     */
    function generate_shipment_model(
        array $shipments,
        array $vehicles,
        int $maxActiveVehicles,
        string $globalStartTime,
        string $globalEndTime
    ): string|bool
    {
        // Do this for a looping process
        // for shipment collection.
        if (collect($shipments)->count() < 1)
            return false;

        if (collect($vehicles)->count() < 1)
            return false;

        $shipment_collection = collect($shipments)->map(function ($shipment) {
            $latitude = (float)$shipment[trim("latitude")];
            $longitude = (float)$shipment[trim("longitude")];
            $allowedVehicle = (int)$shipment[trim("allowedVehicle")] ?? 1;
            $shipment_label = $shipment[trim("label")] ?? trim("");

            $latLng = (new LatLng())
                ->setLatitude($latitude)
                ->setLongitude($longitude);
            $location = (new Location())
                ->setLatLng($latLng);
            $waypoint = (new Waypoint())
                ->setLocation($location);
            $visitRequest = (new VisitRequest())
                ->setArrivalWaypoint($waypoint);
            return (new Shipment())
                ->setDeliveries(array($visitRequest))
                ->setAllowedVehicleIndices(array($allowedVehicle))
                ->setLabel($shipment_label);
        })->toArray();
        // end of shipment collection looping process.

        $vehicle_collection = collect($vehicles)->map(function ($vehicle) {
            $start_latitude         = (float)($vehicle[trim("start_latitude")] ?? 0);
            $start_longitude        = (float)($vehicle[trim("start_longitude")] ?? 0);
            $end_latitude           = (float)($vehicle[trim("end_latitude")] ?? 0);
            $end_longitude          = (float)($vehicle[trim("end_longitude")] ?? 0);
            $travelDurationLimit    = (int)($vehicle[trim("travelDurationLimit")] ?? 0);
            $maxLoadLimit           = (int)($vehicle[trim("maxLoadLimit")] ?? 0);
            $label                  = (string)($vehicle[trim("label")] ?? trim(""));

            // Do this for a looping process
            // for vehicle collection.
            $vehicle_start_latLng = (new LatLng())
                ->setLatitude($start_latitude)
                ->setLongitude($start_longitude);
            $vehicle_start_location = (new Location())
                ->setLatLng($vehicle_start_latLng);
            $vehicle_start_waypoint = (new Waypoint())
                ->setLocation($vehicle_start_location);

            $vehicle_end_latLng = (new LatLng())
                ->setLatitude($end_latitude)
                ->setLongitude($end_longitude);
            $vehicle_end_location = (new Location())
                ->setLatLng($vehicle_end_latLng);
            $vehicle_end_waypoint = (new Waypoint())
                ->setLocation($vehicle_end_location);

            $travel_duration_limit = new DurationLimit(null);

            $loadLimit = (new LoadLimit())
                ->setMaxLoad($maxLoadLimit);

            return (new Vehicle())
                ->setDisplayName($label)
                ->setStartWaypoint($vehicle_start_waypoint)
                ->setEndWaypoint($vehicle_end_waypoint)
                ->setTravelDurationLimit($travel_duration_limit)
                ->setLoadLimits(array("makanan-box" => $loadLimit))
                ->setLabel($label);

            // end of vehicle collection looping process.
        })->toArray();

        $string_global_start_time = strtotime($globalStartTime);
        $string_global_end_time = strtotime($globalEndTime);

        $global_start_time = (new Timestamp())
            ->setSeconds($string_global_start_time)
            ->setNanos(1);

        $global_end_time = (new Timestamp())
            ->setSeconds($string_global_end_time)
            ->setNanos(1);

        $model = (new ShipmentModel())
            ->setShipments($shipment_collection)
            ->setVehicles($vehicle_collection)
            ->setMaxActiveVehicles($maxActiveVehicles)
            ->setGlobalStartTime($global_start_time)
            ->setGlobalEndTime($global_end_time);

        $shipment_model_request = (new OptimizeToursRequest())
            ->setModel($model)
            ->setSearchMode(1)
            ->setInterpretInjectedSolutionsUsingLabels(false)
            ->setConsiderRoadTraffic(true)
            ->setPopulateTransitionPolylines(false)
            ->setAllowLargeDeadlineDespiteInterruptionRisk(false)
            ->setUseGeodesicDistances(false)
            ->setUseGeodesicDistances(1)
            ->setLabel("Group-I")
            ->serializeToJsonString();

        Log::info($shipment_model_request);

        return $shipment_model_request;
    }
}

So far, the code runs without any errors and successfully creates a json file like this:

{
    "model": {
        "shipments": [
            {
                "deliveries": [
                    {
                        "arrivalWaypoint": {
                            "location": {
                                "latLng": {
                                    "latitude": -6.5887,
                                    "longitude": 106.8876
                                }
                            }
                        }
                    }
                ],
                "allowedVehicleIndices": [
                    1
                ],
                "label": "TK MUTIARA"
            },
            {
                "deliveries": [
                    {
                        "arrivalWaypoint": {
                            "location": {
                                "latLng": {
                                    "latitude": -6.5997,
                                    "longitude": 106.8911
                                }
                            }
                        }
                    }
                ],
                "allowedVehicleIndices": [
                    1
                ],
                "label": "SD NEGERI 02"
            }
        ],
        "vehicles": [
            {
                "displayName": "Mobil Box B8990YTH",
                "startWaypoint": {
                    "location": {
                        "latLng": {
                            "latitude": -6.617666721323278,
                            "longitude": 106.90198050040127
                        }
                    }
                },
                "endWaypoint": {
                    "location": {
                        "latLng": {
                            "latitude": -6.617666721323278,
                            "longitude": 106.90198050040127
                        }
                    }
                },
                "loadLimits": {
                    "makanan-box": {
                        "maxLoad": "8"
                    }
                },
                "travelDurationLimit": {},
                "label": "Mobil Box B8990YTH"
            },
            {
                "displayName": "Mobil Box B1202MTH",
                "startWaypoint": {
                    "location": {
                        "latLng": {
                            "latitude": -6.617666721323278,
                            "longitude": 106.90198050040127
                        }
                    }
                },
                "endWaypoint": {
                    "location": {
                        "latLng": {
                            "latitude": -6.617666721323278,
                            "longitude": 106.90198050040127
                        }
                    }
                },
                "loadLimits": {
                    "makanan-box": {
                        "maxLoad": "30"
                    }
                },
                "travelDurationLimit": {},
                "label": "Mobil Box B1202MTH"
            }
        ],
        "maxActiveVehicles": 1,
        "globalStartTime": "8800-09-27T10:27:39.000000001Z",
        "globalEndTime": "6000-09-27T10:27:40.000000001Z"
    },
    "searchMode": "RETURN_FAST",
    "considerRoadTraffic": true,
    "useGeodesicDistances": true,
    "label": "Group-I"
}

The question is:

1. Does this library have a function to upload shipment data directly to GCS without first carrying out the procedure of making the data into json locally and uploading it to GCS?

I usually use the cli command below to upload shipping models to GCS.

Send shipment-model command:
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "x-goog-user-project: [PROJECT_ID]" -d @shipment-model.json https://cloudoptimization.googleapis.com/v1/projects/[PROJECT_ID]:batchOptimizeTours

and check status command:
curl -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "x-goog-user-project: [PROJECT_ID]" "https://cloudoptimization.googleapis.com/v1/projects/[PROJECT_ID]/operations/{RESULT-FROM-FIRST_COMMAND}"

I have tried looking for documents on this but have been unable to find any.
Does anyone care to provide guidance? thanks and sorry for my bad english.