REST Resource: networks

משאב: רשת

מתאר את הרשת המלאה הקיימת שבה ניתן להשתמש. ללקוח API נתון יכולות להיות כמה רשתות (למשל, הרשת הראשית ושינוי עתידי אפשרי לבדיקה).

ייצוג JSON 
{
  "name": string,
  "dimensions": [
    {
      object (ValueDimension)
    }
  ],
  "pricing": {
    object (PricingStrategy)
  },
  "currencyCode": string,
  "timeStep": string,
  "distanceMatrix": [
    {
      object (DistanceMatrixEntry)
    }
  ]
}
שדות
name

string

חובה. מזהה. לא ניתן לעדכן.
dimensions[]

object (ValueDimension)

מרחק, משקל, משטחים וכו', וגם קנה מידה (למיפוי מספר ממשי (float) למספרים שלמים).
pricing

object (PricingStrategy)

זה שינוי אופציונלי. המחיר שהשולח ישלם עבור משלוח שלא צריך ליצור בו שורה ייעודית.
currencyCode

string

זה שינוי אופציונלי. יחידה כספית יחידה בשימוש בכל הרשת. ללקוח API נתון יכולות להיות מספר יחידות שונות לרשתות שונות; לרשת מסוימת יכולה להיות רק יחידה כספית אחת. יש לקודד את היחידה בתקן ISO 4217, למשל google3/google/type/money.proto.
timeStep

string (Duration format)

זה שינוי אופציונלי. הפרש זמן. ההחלטות מתקבלות ברמת הדיוק הזו בזמן. באופן פנימי, המצב נשמר בדיוק לפי אותו הערך.

משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-'s'. לדוגמה: "3.5s".
distanceMatrix[]

object (DistanceMatrixEntry)

זה שינוי אופציונלי. מטריצת מרחק (שמייצגת רשימת קצוות משוקללים).

DistanceMatrixEntry

המרחק בין מרכז מקור למרכז יעד.

ייצוג JSON 
{
  "sourceHub": string,
  "destinationHub": string,
  "weights": [
    {
      object (ValueDimension)
    }
  ]
}
שדות
sourceHub

string

חובה. מרכז המקור.
destinationHub

string

חובה. מרכז היעד.
weights[]

object (ValueDimension)

חובה. המרחק בין המרכזים, נמדד בכמה מימדים.

שיטות

create

 יצירת רשת

delete

 מוחקת רשת.

get

 מקבל את הפרטים של רשת.

list

 מציין את הרשת.

listPaths

 הפונקציה מחזירה את כל הנתיבים הזמינים כרגע.

patch

 עדכון רשת.