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

תיאור קצר של המבנה. לדוגמה, "Chelsea Market".
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, עיר דואר בבריטניה. באזורים בעולם שבהם הרשויות המוניציפאליות אינן מוגדרות היטב או שאינן מתאימות למבנה זה, השאירו את הרשות המוניציפאלית ריקה והשתמשו ב-addressLines.
sublocality

string

אפשרות. מיקום המשנה של הכתובת.
addressLines[]

string

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

שיטות

delete

 מוחק מבנה.

get

 מאחזר מבנה.

insert

 הוספת מבנה.

list

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

patch

 טלאים של בניין.

update

 עדכון מבנה.