Resources.buildings

For a list of methods for this resource, see the end of this page.

Resource representations

JSON template for Building object in Directory API.

{
  "kind": "admin#directory#resources#buildings#Building",
  "etags": etag,
  "buildingId": string,
  "buildingName": string,
  "description": string,
  "coordinates": {
    "latitude": double,
    "longitude": double
  },
  "floorNames": [
    string
  ],
  "address": {
    "addressLines": [
      string
    ],
    "regionCode": string,
    "languageCode": string,
    "postalCode": string,
    "administrativeArea": string,
    "locality": string,
    "sublocality": string
  }
}
Property name Value Description Notes
address nested object The postal address of the building. See PostalAddress for details. Note that only a single address line and region code are required.
address.addressLines[] list Unstructured address lines describing the lower levels of an address.
address.administrativeArea string Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
address.languageCode string Optional. BCP-47 language code of the contents of this address (if known).
address.locality string Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines.
address.postalCode string Optional. Postal code of the address.
address.regionCode string Required. CLDR region code of the country/region of the address.
address.sublocality string Optional. Sublocality of the address.
buildingId string Unique identifier for the building. The maximum length is 100 characters.
buildingName string The building name as seen by users in Calendar. Must be unique for the customer. For example, "NYC-CHEL". The maximum length is 100 characters.
coordinates nested object The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees.
coordinates.latitude double Latitude in decimal degrees.
coordinates.longitude double Longitude in decimal degrees.
description string A brief description of the building. For example, "Chelsea Market".
etags etag ETag of the resource.
floorNames[] list The display names for all floors in this building. The floors are expected to be sorted in ascending order, from lowest floor to highest floor. For example, ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] Must contain at least one entry.
kind string Kind of resource this is.

Methods

delete
Deletes a building.
get
Retrieves a building.
insert
Inserts a building.
list
Retrieves a list of buildings for an account.
patch
Updates a building. This method supports patch semantics.
update
Updates a building.