Get
|
|||||
|
|
||||
Retrieves a calendar resource
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 2 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 |
calendarResourceId Required |
STRING |
The unique ID of the calendar resource to retrieve |
= 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 |
|
calendarResourceId STRING Required The unique ID of the calendar resource to retrieve |
Output
This building block provides 15 output parameters
| Name | Format | Description |
|---|---|---|
resourceCategory |
STRING |
The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN |
kind |
STRING |
The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource |
buildingId |
STRING |
Unique ID for the building a resource is located in |
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)" |
floorName |
STRING |
Name of the floor a resource is located on |
resourceType |
STRING |
The type of the calendar resource, intended for non-room resources |
floorSection |
STRING |
Name of the section within a floor a resource is located in |
featureInstances |
ANY |
Instances of features for the calendar resource |
capacity |
INTEGER |
Capacity of a resource, number of seats in a room |
etags |
STRING |
ETag of the resource |
resourceId |
STRING |
The unique ID for the calendar resource |
resourceEmail |
STRING |
The read-only email for the calendar resource. Generated as part of creating a new calendar resource |
resourceName |
STRING |
The name of the calendar resource. For example, "Training Room 1A" |
userVisibleDescription |
STRING |
Description of the resource, visible to users and admins |
resourceDescription |
STRING |
Description of the resource, visible only to admins |
= Parameter name
= Format
|
resourceCategory STRING The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN |
|
kind STRING The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource |
|
buildingId STRING Unique ID for the building a resource is located in |
|
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)" |
|
floorName STRING Name of the floor a resource is located on |
|
resourceType STRING The type of the calendar resource, intended for non-room resources |
|
floorSection STRING Name of the section within a floor a resource is located in |
|
featureInstances ANY Instances of features for the calendar resource |
|
capacity INTEGER Capacity of a resource, number of seats in a room |
|
etags STRING ETag of the resource |
|
resourceId STRING The unique ID for the calendar resource |
|
resourceEmail STRING The read-only email for the calendar resource. Generated as part of creating a new calendar resource |
|
resourceName STRING The name of the calendar resource. For example, "Training Room 1A" |
|
userVisibleDescription STRING Description of the resource, visible to users and admins |
|
resourceDescription STRING Description of the resource, visible only to admins |