REST Resource: networks

Zasób: sieć

Opisuje całą istniejącą sieć, której można używać. Każdy klient korzystający z interfejsu API może mieć kilka sieci (np. sieć główną i możliwe w przyszłości modyfikacje do oceny).

Zapis JSON 
{
  "name": string,
  "dimensions": [
    {
      object (ValueDimension)
    }
  ],
  "pricing": {
    object (PricingStrategy)
  },
  "currencyCode": string,
  "timeStep": string,
  "distanceMatrix": [
    {
      object (DistanceMatrixEntry)
    }
  ]
}
Pola
name

string

Wymagane. Identyfikator. Tego ustawienia nie można później zmienić.
dimensions[]

object (ValueDimension)

Odległość, waga, palety itd. oraz skalowanie (do mapowania liczb zmiennoprzecinkowych na liczby całkowite).
pricing

object (PricingStrategy)

Opcjonalnie: Cena, jaką ma zapłacić nadawca za wysyłkę, która nie wymaga osobnej linii.
currencyCode

string

Opcjonalnie: Jedna jednostka pieniężna używana w całej sieci. Każdy klient API może mieć kilka różnych jednostek dla różnych sieci. sieć może mieć tylko jedną jednostkę pieniężną. Jednostka musi być zakodowana w formacie ISO 4217, np. google3/google/type/money.proto.
timeStep

string (Duration format)

Opcjonalnie: Dyskretyzacja czasu. Decyzje są podejmowane z taką precyzją w czasie. Wewnętrznie stan jest zachowywany z taką precyzją.

Czas trwania w sekundach składający się z maksymalnie 9 cyfr po przecinku, kończący się cyfrą „s”. Przykład: "3.5s".
distanceMatrix[]

object (DistanceMatrixEntry)

Opcjonalnie: Macierz odległości (reprezentuje listę ważonych, kierowanych krawędzi).

DistanceMatrixEntry

Odległość między centrum źródłowym a centrum docelowym.

Zapis JSON 
{
  "sourceHub": string,
  "destinationHub": string,
  "weights": [
    {
      object (ValueDimension)
    }
  ]
}
Pola
sourceHub

string

Wymagane. Centrum źródeł.
destinationHub

string

Wymagane. Centrum docelowe.
weights[]

object (ValueDimension)

Wymagane. Odległość między centrami mierzona w kilku wymiarach.

Metody

create

 Tworzy sieć.

delete

 Usuwa sieć.

get

 Pobiera szczegóły sieci.

list

 Wyświetla listę sieci.

listPaths

 Zwraca wszystkie aktualnie dostępne ścieżki.

patch

 Aktualizuje sieć.