REST Resource: resources.buildings

資源:Building

公用 API:Resources.buildings

JSON 表示法
{
  "buildingId": string,
  "buildingName": string,
  "description": string,
  "coordinates": {
    object (BuildingCoordinates)
  },
  "kind": string,
  "etags": string,
  "floorNames": [
    string
  ],
  "address": {
    object (BuildingAddress)
  }
}
欄位
buildingId

string

建築物的專屬 ID。長度上限為 100 個半形字元。

buildingName

string

使用者在 Google 日曆中看到的建築物名稱。客戶的名稱不得重複,例如「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

選用設定。一般是指地址的縣市/鄉鎮部分。例如:美國城市、義大利市鎮、英國郵鎮。如為未明確定義縣市或其縣市不適用此結構的地區,請將 locality 留白,改用 addressLines。

sublocality

string

選用設定。地址的鄉鎮市區。

addressLines[]

string

非結構化的地址行,說明地址的低層級項目。

方法

delete

刪除建築物。

get

擷取建築物。

insert

插入建築物。

list

擷取帳戶的建築物清單。

patch

修補建築物。

update

更新建築物。