REST Resource: resources.buildings

משאב: מבנה

ממשק API ציבורי: Resources.buildings

ייצוג ב-JSON 
{
  "buildingId": string,
  "buildingName": string,
  "description": string,
  "coordinates": {
    object (BuildingCoordinates)
  },
  "kind": string,
  "etags": string,
  "floorNames": [
    string
  ],
  "address": {
    object (BuildingAddress)
  }
}
שדות
buildingId

string

המזהה הייחודי של הבניין. האורך המקסימלי הוא 100 תווים.
buildingName

string

שם הבניין כפי שנראה למשתמשים ביומן. חייב להיות ייחודי ללקוח. לדוגמה, 'NYC-CHEL'. האורך המקסימלי הוא 100 תווים.
description

string

תיאור קצר של המבנה. לדוגמה, "חיפה".
coordinates

object (BuildingCoordinates)

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

string

זה סוג המשאב.
etags

string

ה-ETag של המשאב.
floorNames[]

string

השמות המוצגים של כל הקומות במבנה הזה. הקומות צפויות להיות ממוינות בסדר עולה, מהקומה הנמוכה ביותר לקומה הגבוהה ביותר. לדוגמה, ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] חייב להכיל לפחות ערך אחד.
address

object (BuildingAddress)

הכתובת הפיזית של הבניין. פרטים נוספים זמינים במאמר PostalAddress. שימו לב שצריך לציין רק שורת כתובת אחת וקוד אזור אחד.

BuildingCoordinates

ממשק API ציבורי: Resources.buildings

ייצוג ב-JSON 
{
  "latitude": number,
  "longitude": number
}
שדות
latitude

number

קו הרוחב במעלות עשרוניות.
longitude

number

קו האורך במעלות עשרוניות.

BuildingAddress

ממשק API ציבורי: Resources.buildings

ייצוג ב-JSON 
{
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ]
}
שדות
regionCode

string

חובה. קוד האזור במאגר CLDR של המדינה או האזור של הכתובת.
languageCode

string

זה שינוי אופציונלי. קוד השפה BCP-47 של התוכן בכתובת הזו (אם ידוע).
postalCode

string

זה שינוי אופציונלי. המיקוד של הכתובת.
administrativeArea

string

זה שינוי אופציונלי. הרמה המנהלית הגבוהה ביותר שמשמשת לכתובות דואר של מדינה או אזור.
locality

string

זה שינוי אופציונלי. בדרך כלל מתייחס לחלק של העיר בכתובת. דוגמאות: עיר בארה"ב, קהילת IT, עיר דואר בבריטניה. באזורים בעולם שבהם רשויות מוניציפאליות לא מוגדרות היטב או שלא מתאימות למבנה הזה בצורה טובה, השאירו את הרשות המוניציפאלית ריקה והשתמשו בקווי כתובת.
sublocality

string

זה שינוי אופציונלי. יישוב משנה של הכתובת.
addressLines[]

string

שורות כתובת לא מובנות, שמתארות את הרמות הנמוכות יותר של כתובת.

שיטות

delete

 מוחק מבנה.

get

 אחזור של מבנה.

insert

 הוספת בניין.

list

 אחזור רשימה של מבנים של חשבון.

patch

 תיקון של בניין.

update

 מעדכנות מבנה.