List
|
|||||
|
|
||||
Retrieves a list of buildings for an account
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage the provisioning of calendar resources on your domain
- View calendar resources on your domain
Input
This building block consumes 3 input parameters
| Name | Format | Description |
|---|---|---|
customer Required |
STRING |
The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID |
maxResults |
INTEGER |
Maximum number of results to return |
pageToken |
STRING |
Token to specify the next page in the list |
= Parameter name
= Format
|
customer STRING Required The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID |
|
maxResults INTEGER Maximum number of results to return |
|
pageToken STRING Token to specify the next page in the list |
Output
This building block provides 21 output parameters
| Name | Format | Description |
|---|---|---|
kind |
STRING |
Kind of resource this is |
etag |
STRING |
ETag of the resource |
buildings[] |
OBJECT |
Public API: Resources.buildings |
buildings[].etags |
STRING |
ETag of the resource |
buildings[].coordinates |
OBJECT |
Public API: Resources.buildings |
buildings[].coordinates.latitude |
NUMBER |
Latitude in decimal degrees |
buildings[].coordinates.longitude |
NUMBER |
Longitude in decimal degrees |
buildings[].address |
OBJECT |
Public API: Resources.buildings |
buildings[].address.addressLines[] |
STRING |
|
buildings[].address.languageCode |
STRING |
Optional. BCP-47 language code of the contents of this address (if known) |
buildings[].address.administrativeArea |
STRING |
Optional. Highest administrative subdivision which is used for postal addresses of a country or region |
buildings[].address.sublocality |
STRING |
Optional. Sublocality of the address |
buildings[].address.regionCode |
STRING |
Required. CLDR region code of the country/region of the address |
buildings[].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 |
buildings[].address.postalCode |
STRING |
Optional. Postal code of the address |
buildings[].description |
STRING |
A brief description of the building. For example, "Chelsea Market" |
buildings[].buildingId |
STRING |
Unique identifier for the building. The maximum length is 100 characters |
buildings[].floorNames[] |
STRING |
|
buildings[].kind |
STRING |
Kind of resource this is |
buildings[].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 |
nextPageToken |
STRING |
The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results |
= Parameter name
= Format
|
kind STRING Kind of resource this is |
|
etag STRING ETag of the resource |
|
buildings[] OBJECT Public API: Resources.buildings |
|
buildings[].etags STRING ETag of the resource |
|
buildings[].coordinates OBJECT Public API: Resources.buildings |
|
buildings[].coordinates.latitude NUMBER Latitude in decimal degrees |
|
buildings[].coordinates.longitude NUMBER Longitude in decimal degrees |
|
buildings[].address OBJECT Public API: Resources.buildings |
|
buildings[].address.addressLines[] STRING |
|
buildings[].address.languageCode STRING Optional. BCP-47 language code of the contents of this address (if known) |
|
buildings[].address.administrativeArea STRING Optional. Highest administrative subdivision which is used for postal addresses of a country or region |
|
buildings[].address.sublocality STRING Optional. Sublocality of the address |
|
buildings[].address.regionCode STRING Required. CLDR region code of the country/region of the address |
|
buildings[].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 |
|
buildings[].address.postalCode STRING Optional. Postal code of the address |
|
buildings[].description STRING A brief description of the building. For example, "Chelsea Market" |
|
buildings[].buildingId STRING Unique identifier for the building. The maximum length is 100 characters |
|
buildings[].floorNames[] STRING |
|
buildings[].kind STRING Kind of resource this is |
|
buildings[].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 |
|
nextPageToken STRING The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results |