REST Resource: networks

Ressource: Réseau

Décrit l'ensemble du réseau existant pouvant être utilisé. Un client API donné peut disposer de plusieurs réseaux (par exemple, le réseau principal et une possible modification future à évaluer).

Représentation JSON
{
  "name": string,
  "dimensions": [
    {
      object (ValueDimension)
    }
  ],
  "pricing": {
    object (PricingStrategy)
  },
  "currencyCode": string,
  "timeStep": string,
  "distanceMatrix": [
    {
      object (DistanceMatrixEntry)
    }
  ]
}
Champs
name

string

Obligatoire. Identifiant. Ce paramètre ne peut pas être modifié.

dimensions[]

object (ValueDimension)

Distance, poids, palettes, etc., et mise à l'échelle (pour faire correspondre des nombres à virgule flottante à des entiers).

pricing

object (PricingStrategy)

Facultatif. Prix à payer par l'expéditeur pour l'expédition d'un colis qui ne nécessite pas de ligne dédiée.

currencyCode

string

Facultatif. Unité monétaire unique utilisée sur l'ensemble du réseau. Un client API donné peut avoir plusieurs unités pour différents réseaux. un réseau ne peut avoir qu'une seule unité monétaire. L'unité doit être codée selon la norme ISO 4217, par exemple google3/google/type/money.proto.

timeStep

string (Duration format)

Facultatif. Discrétisation temporelle Les décisions sont générées avec cette précision temporelle. En interne, l'état est conservé avec cette précision.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

distanceMatrix[]

object (DistanceMatrixEntry)

Facultatif. Matrice des distances (représentée par une liste d'arêtes orientées pondérées).

DistanceMatrixEntry

La distance entre un hub source et un hub de destination.

Représentation JSON
{
  "sourceHub": string,
  "destinationHub": string,
  "weights": [
    {
      object (ValueDimension)
    }
  ]
}
Champs
sourceHub

string

Obligatoire. Hub source.

destinationHub

string

Obligatoire. Hub de destination.

weights[]

object (ValueDimension)

Obligatoire. Distance entre les hubs, mesurée en plusieurs dimensions.

Méthodes

create

Crée un réseau.

delete

Supprime un réseau.

get

Récupère les détails d'un réseau.

list

Liste le réseau.

listPaths

Renvoie tous les chemins d'accès actuellement disponibles.

patch

Met à jour un réseau.