List
|
|||||
|
|
||||
Retrieves a list of calendar resources 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 5 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 |
orderBy |
STRING |
Field(s) to sort results by in either ascending or descending order. Supported fields include resourceId, resourceName, capacity, buildingId, and floorName. If no order is specified, defaults to ascending. Should be of the form "field [asc|desc], field [asc|desc], ...". For example buildingId, capacity desc would return results sorted first by buildingId in ascending order then by capacity in descending order |
query |
STRING |
String query used to filter results. Should be of the form "field operator value" where field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match, '!=' for mismatch and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Logical operators NOT and AND are supported (in this order of precedence). Supported fields include generatedResourceName, name, buildingId, floor_name, capacity, featureInstances.feature.name. For example buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone |
pageToken |
STRING |
Token to specify the next page in the list |
maxResults |
INTEGER |
Maximum number of results to return |
= 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 |
|
orderBy STRING Field(s) to sort results by in either ascending or descending order. Supported fields include resourceId, resourceName, capacity, buildingId, and floorName. If no order is specified, defaults to ascending. Should be of the form "field [asc|desc], field [asc|desc], ...". For example buildingId, capacity desc would return results sorted first by buildingId in ascending order then by capacity in descending order |
|
query STRING String query used to filter results. Should be of the form "field operator value" where field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match, '!=' for mismatch and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Logical operators NOT and AND are supported (in this order of precedence). Supported fields include generatedResourceName, name, buildingId, floor_name, capacity, featureInstances.feature.name. For example buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone |
|
pageToken STRING Token to specify the next page in the list |
|
maxResults INTEGER Maximum number of results to return |
Output
This building block provides 19 output parameters
| Name | Format | Description |
|---|---|---|
items[] |
OBJECT |
Public API: Resources.calendars |
items[].resourceCategory |
STRING |
The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN |
items[].kind |
STRING |
The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource |
items[].buildingId |
STRING |
Unique ID for the building a resource is located in |
items[].generatedResourceName |
STRING |
The read-only auto-generated name of the calendar resource which includes metadata about the resource such as building name, floor, capacity, etc. For example, "NYC-2-Training Room 1A (16)" |
items[].floorName |
STRING |
Name of the floor a resource is located on |
items[].resourceType |
STRING |
The type of the calendar resource, intended for non-room resources |
items[].floorSection |
STRING |
Name of the section within a floor a resource is located in |
items[].featureInstances |
ANY |
Instances of features for the calendar resource |
items[].capacity |
INTEGER |
Capacity of a resource, number of seats in a room |
items[].etags |
STRING |
ETag of the resource |
items[].resourceId |
STRING |
The unique ID for the calendar resource |
items[].resourceEmail |
STRING |
The read-only email for the calendar resource. Generated as part of creating a new calendar resource |
items[].resourceName |
STRING |
The name of the calendar resource. For example, "Training Room 1A" |
items[].userVisibleDescription |
STRING |
Description of the resource, visible to users and admins |
items[].resourceDescription |
STRING |
Description of the resource, visible only to admins |
etag |
STRING |
ETag of the resource |
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 |
kind |
STRING |
Identifies this as a collection of CalendarResources. This is always admin#directory#resources#calendars#calendarResourcesList |
= Parameter name
= Format
|
items[] OBJECT Public API: Resources.calendars |
|
items[].resourceCategory STRING The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN |
|
items[].kind STRING The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource |
|
items[].buildingId STRING Unique ID for the building a resource is located in |
|
items[].generatedResourceName STRING The read-only auto-generated name of the calendar resource which includes metadata about the resource such as building name, floor, capacity, etc. For example, "NYC-2-Training Room 1A (16)" |
|
items[].floorName STRING Name of the floor a resource is located on |
|
items[].resourceType STRING The type of the calendar resource, intended for non-room resources |
|
items[].floorSection STRING Name of the section within a floor a resource is located in |
|
items[].featureInstances ANY Instances of features for the calendar resource |
|
items[].capacity INTEGER Capacity of a resource, number of seats in a room |
|
items[].etags STRING ETag of the resource |
|
items[].resourceId STRING The unique ID for the calendar resource |
|
items[].resourceEmail STRING The read-only email for the calendar resource. Generated as part of creating a new calendar resource |
|
items[].resourceName STRING The name of the calendar resource. For example, "Training Room 1A" |
|
items[].userVisibleDescription STRING Description of the resource, visible to users and admins |
|
items[].resourceDescription STRING Description of the resource, visible only to admins |
|
etag STRING ETag of the resource |
|
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 |
|
kind STRING Identifies this as a collection of CalendarResources. This is always admin#directory#resources#calendars#calendarResourcesList |