Search Rooms
Search for rooms and other resources in your Google Calendar account.
Options
Field | Definition | Type | Required |
---|---|---|---|
Result Set |
Determine the number of items in the search results:
|
Dropdown | TRUE |
Filter |
Select an operator to limit the search results:
A filter is set against searches in the following fields:
|
Dropdown | TRUE |
Input
Field | Definition | Type | Required |
---|---|---|---|
Filters (for the option Starts With) | |||
Generated Name | Read-only auto-generated name of the room which includes metadata about the resource such as building name, floor, capacity, and so forth. For example, NYC-2-Training Room 1A (16) . |
String | FALSE |
Name |
Name of the calendar resource. For example, Training Room 1A .
|
String | FALSE |
Filters (for the options Equal and Not Equal) | |||
Generated Name | Read-only auto-generated name of the room which includes metadata about the resource such as building name, floor, capacity, and so forth. For example, NYC-2-Training Room 1A (16) . |
String | FALSE |
Name |
Name of the calendar resource. For example, Training Room 1A .
|
String | FALSE |
Building ID | Unique ID for the building in which a room is located. | String | FALSE |
Floor Name | Name of the floor on which the room is located. | String | FALSE |
Capacity | Capacity of a room, number of seats in a room. | Number | FALSE |
Feature Name (for the options Equal only) | Name of a feature for the room. | String | FALSE |
Read-only email for the room resource. | String | FALSE | |
Category |
Category of the calendar resource. Options are:
Legacy data is set to CATEGORY_UNKNOWN. |
Dropdown | FALSE |

If input fields are left blank, the search results will return all calendar rooms.
Output
Field | Definition | Type |
---|---|---|
Rooms | ||
Read-only email for the room resource. | String | |
Generated Name | Read-only auto-generated name of the room which includes metadata about the resource such as building name, floor, capacity, and so forth. For example, NYC-2-Training Room 1A (16) . |
Object |
Name | Name of the calendar resource. For example, Training Room 1A . |
Object |
User Visible Description | Description of the room, visible to users and admins. | Object |
Description | Description of the room, visible only to admins. | Object |
Kind | Type of resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource . |
Object |
Etags | ETag of the room resource. | Object |
Type | Type of data returned. | Object |
Category | Category of the calendar resource. Either CONFERENCE_ROOM or OTHER . Legacy data is set to CATEGORY_UNKNOWN . |
Object |
Feature Instances | Instances of features for the room. | List of Objects |
Feature | Name of a feature for the room. | Object |
ID | Unique ID for the room. | Object |
Capacity | Capacity of a room, number of seats in a room. | Object |
Floor Name | Name of the floor on which the room is located. | Object |
Building ID | Unique ID for the building in which a room is located. | Object |
Floor Section | Name of the section within a floor in which the room is located. | Object |