1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="admin_directory_v1.html">Admin SDK API</a> . <a href="admin_directory_v1.resources.html">resources</a> . <a href="admin_directory_v1.resources.calendars.html">calendars</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(customer, calendarResourceId, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes a calendar resource.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(customer, calendarResourceId, x__xgafv=None)</a></code></p> 85<p class="firstline">Retrieves a calendar resource.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(customer, body=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Inserts a calendar resource.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(customer, maxResults=None, orderBy=None, pageToken=None, query=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Retrieves a list of calendar resources for an account.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(customer, calendarResourceId, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Patches a calendar resource.</p> 98<p class="toc_element"> 99 <code><a href="#update">update(customer, calendarResourceId, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Updates a calendar resource. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="close">close()</code> 104 <pre>Close httplib2 connections.</pre> 105</div> 106 107<div class="method"> 108 <code class="details" id="delete">delete(customer, calendarResourceId, x__xgafv=None)</code> 109 <pre>Deletes a calendar resource. 110 111Args: 112 customer: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID. (required) 113 calendarResourceId: string, The unique ID of the calendar resource to delete. (required) 114 x__xgafv: string, V1 error format. 115 Allowed values 116 1 - v1 error format 117 2 - v2 error format 118</pre> 119</div> 120 121<div class="method"> 122 <code class="details" id="get">get(customer, calendarResourceId, x__xgafv=None)</code> 123 <pre>Retrieves a calendar resource. 124 125Args: 126 customer: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID. (required) 127 calendarResourceId: string, The unique ID of the calendar resource to retrieve. (required) 128 x__xgafv: string, V1 error format. 129 Allowed values 130 1 - v1 error format 131 2 - v2 error format 132 133Returns: 134 An object of the form: 135 136 { # Public API: Resources.calendars 137 "buildingId": "A String", # Unique ID for the building a resource is located in. 138 "capacity": 42, # Capacity of a resource, number of seats in a room. 139 "etags": "A String", # ETag of the resource. 140 "featureInstances": "", # Instances of features for the calendar resource. 141 "floorName": "A String", # Name of the floor a resource is located on. 142 "floorSection": "A String", # Name of the section within a floor a resource is located in. 143 "generatedResourceName": "A 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)". 144 "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is `admin#directory#resources#calendars#CalendarResource`. 145 "resourceCategory": "A String", # The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN. 146 "resourceDescription": "A String", # Description of the resource, visible only to admins. 147 "resourceEmail": "A String", # The read-only email for the calendar resource. Generated as part of creating a new calendar resource. 148 "resourceId": "A String", # The unique ID for the calendar resource. 149 "resourceName": "A String", # The name of the calendar resource. For example, "Training Room 1A". 150 "resourceType": "A String", # The type of the calendar resource, intended for non-room resources. 151 "userVisibleDescription": "A String", # Description of the resource, visible to users and admins. 152}</pre> 153</div> 154 155<div class="method"> 156 <code class="details" id="insert">insert(customer, body=None, x__xgafv=None)</code> 157 <pre>Inserts a calendar resource. 158 159Args: 160 customer: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID. (required) 161 body: object, The request body. 162 The object takes the form of: 163 164{ # Public API: Resources.calendars 165 "buildingId": "A String", # Unique ID for the building a resource is located in. 166 "capacity": 42, # Capacity of a resource, number of seats in a room. 167 "etags": "A String", # ETag of the resource. 168 "featureInstances": "", # Instances of features for the calendar resource. 169 "floorName": "A String", # Name of the floor a resource is located on. 170 "floorSection": "A String", # Name of the section within a floor a resource is located in. 171 "generatedResourceName": "A 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)". 172 "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is `admin#directory#resources#calendars#CalendarResource`. 173 "resourceCategory": "A String", # The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN. 174 "resourceDescription": "A String", # Description of the resource, visible only to admins. 175 "resourceEmail": "A String", # The read-only email for the calendar resource. Generated as part of creating a new calendar resource. 176 "resourceId": "A String", # The unique ID for the calendar resource. 177 "resourceName": "A String", # The name of the calendar resource. For example, "Training Room 1A". 178 "resourceType": "A String", # The type of the calendar resource, intended for non-room resources. 179 "userVisibleDescription": "A String", # Description of the resource, visible to users and admins. 180} 181 182 x__xgafv: string, V1 error format. 183 Allowed values 184 1 - v1 error format 185 2 - v2 error format 186 187Returns: 188 An object of the form: 189 190 { # Public API: Resources.calendars 191 "buildingId": "A String", # Unique ID for the building a resource is located in. 192 "capacity": 42, # Capacity of a resource, number of seats in a room. 193 "etags": "A String", # ETag of the resource. 194 "featureInstances": "", # Instances of features for the calendar resource. 195 "floorName": "A String", # Name of the floor a resource is located on. 196 "floorSection": "A String", # Name of the section within a floor a resource is located in. 197 "generatedResourceName": "A 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)". 198 "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is `admin#directory#resources#calendars#CalendarResource`. 199 "resourceCategory": "A String", # The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN. 200 "resourceDescription": "A String", # Description of the resource, visible only to admins. 201 "resourceEmail": "A String", # The read-only email for the calendar resource. Generated as part of creating a new calendar resource. 202 "resourceId": "A String", # The unique ID for the calendar resource. 203 "resourceName": "A String", # The name of the calendar resource. For example, "Training Room 1A". 204 "resourceType": "A String", # The type of the calendar resource, intended for non-room resources. 205 "userVisibleDescription": "A String", # Description of the resource, visible to users and admins. 206}</pre> 207</div> 208 209<div class="method"> 210 <code class="details" id="list">list(customer, maxResults=None, orderBy=None, pageToken=None, query=None, x__xgafv=None)</code> 211 <pre>Retrieves a list of calendar resources for an account. 212 213Args: 214 customer: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID. (required) 215 maxResults: integer, Maximum number of results to return. 216 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. 217 pageToken: string, Token to specify the next page in the list. 218 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`, `resourceEmail`, `resourceCategory`. For example `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`. 219 x__xgafv: string, V1 error format. 220 Allowed values 221 1 - v1 error format 222 2 - v2 error format 223 224Returns: 225 An object of the form: 226 227 { # Public API: Resources.calendars 228 "etag": "A String", # ETag of the resource. 229 "items": [ # The CalendarResources in this page of results. 230 { # Public API: Resources.calendars 231 "buildingId": "A String", # Unique ID for the building a resource is located in. 232 "capacity": 42, # Capacity of a resource, number of seats in a room. 233 "etags": "A String", # ETag of the resource. 234 "featureInstances": "", # Instances of features for the calendar resource. 235 "floorName": "A String", # Name of the floor a resource is located on. 236 "floorSection": "A String", # Name of the section within a floor a resource is located in. 237 "generatedResourceName": "A 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)". 238 "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is `admin#directory#resources#calendars#CalendarResource`. 239 "resourceCategory": "A String", # The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN. 240 "resourceDescription": "A String", # Description of the resource, visible only to admins. 241 "resourceEmail": "A String", # The read-only email for the calendar resource. Generated as part of creating a new calendar resource. 242 "resourceId": "A String", # The unique ID for the calendar resource. 243 "resourceName": "A String", # The name of the calendar resource. For example, "Training Room 1A". 244 "resourceType": "A String", # The type of the calendar resource, intended for non-room resources. 245 "userVisibleDescription": "A String", # Description of the resource, visible to users and admins. 246 }, 247 ], 248 "kind": "admin#directory#resources#calendars#calendarResourcesList", # Identifies this as a collection of CalendarResources. This is always `admin#directory#resources#calendars#calendarResourcesList`. 249 "nextPageToken": "A 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. 250}</pre> 251</div> 252 253<div class="method"> 254 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 255 <pre>Retrieves the next page of results. 256 257Args: 258 previous_request: The request for the previous page. (required) 259 previous_response: The response from the request for the previous page. (required) 260 261Returns: 262 A request object that you can call 'execute()' on to request the next 263 page. Returns None if there are no more items in the collection. 264 </pre> 265</div> 266 267<div class="method"> 268 <code class="details" id="patch">patch(customer, calendarResourceId, body=None, x__xgafv=None)</code> 269 <pre>Patches a calendar resource. 270 271Args: 272 customer: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID. (required) 273 calendarResourceId: string, The unique ID of the calendar resource to update. (required) 274 body: object, The request body. 275 The object takes the form of: 276 277{ # Public API: Resources.calendars 278 "buildingId": "A String", # Unique ID for the building a resource is located in. 279 "capacity": 42, # Capacity of a resource, number of seats in a room. 280 "etags": "A String", # ETag of the resource. 281 "featureInstances": "", # Instances of features for the calendar resource. 282 "floorName": "A String", # Name of the floor a resource is located on. 283 "floorSection": "A String", # Name of the section within a floor a resource is located in. 284 "generatedResourceName": "A 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)". 285 "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is `admin#directory#resources#calendars#CalendarResource`. 286 "resourceCategory": "A String", # The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN. 287 "resourceDescription": "A String", # Description of the resource, visible only to admins. 288 "resourceEmail": "A String", # The read-only email for the calendar resource. Generated as part of creating a new calendar resource. 289 "resourceId": "A String", # The unique ID for the calendar resource. 290 "resourceName": "A String", # The name of the calendar resource. For example, "Training Room 1A". 291 "resourceType": "A String", # The type of the calendar resource, intended for non-room resources. 292 "userVisibleDescription": "A String", # Description of the resource, visible to users and admins. 293} 294 295 x__xgafv: string, V1 error format. 296 Allowed values 297 1 - v1 error format 298 2 - v2 error format 299 300Returns: 301 An object of the form: 302 303 { # Public API: Resources.calendars 304 "buildingId": "A String", # Unique ID for the building a resource is located in. 305 "capacity": 42, # Capacity of a resource, number of seats in a room. 306 "etags": "A String", # ETag of the resource. 307 "featureInstances": "", # Instances of features for the calendar resource. 308 "floorName": "A String", # Name of the floor a resource is located on. 309 "floorSection": "A String", # Name of the section within a floor a resource is located in. 310 "generatedResourceName": "A 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)". 311 "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is `admin#directory#resources#calendars#CalendarResource`. 312 "resourceCategory": "A String", # The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN. 313 "resourceDescription": "A String", # Description of the resource, visible only to admins. 314 "resourceEmail": "A String", # The read-only email for the calendar resource. Generated as part of creating a new calendar resource. 315 "resourceId": "A String", # The unique ID for the calendar resource. 316 "resourceName": "A String", # The name of the calendar resource. For example, "Training Room 1A". 317 "resourceType": "A String", # The type of the calendar resource, intended for non-room resources. 318 "userVisibleDescription": "A String", # Description of the resource, visible to users and admins. 319}</pre> 320</div> 321 322<div class="method"> 323 <code class="details" id="update">update(customer, calendarResourceId, body=None, x__xgafv=None)</code> 324 <pre>Updates a calendar resource. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved. 325 326Args: 327 customer: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID. (required) 328 calendarResourceId: string, The unique ID of the calendar resource to update. (required) 329 body: object, The request body. 330 The object takes the form of: 331 332{ # Public API: Resources.calendars 333 "buildingId": "A String", # Unique ID for the building a resource is located in. 334 "capacity": 42, # Capacity of a resource, number of seats in a room. 335 "etags": "A String", # ETag of the resource. 336 "featureInstances": "", # Instances of features for the calendar resource. 337 "floorName": "A String", # Name of the floor a resource is located on. 338 "floorSection": "A String", # Name of the section within a floor a resource is located in. 339 "generatedResourceName": "A 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)". 340 "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is `admin#directory#resources#calendars#CalendarResource`. 341 "resourceCategory": "A String", # The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN. 342 "resourceDescription": "A String", # Description of the resource, visible only to admins. 343 "resourceEmail": "A String", # The read-only email for the calendar resource. Generated as part of creating a new calendar resource. 344 "resourceId": "A String", # The unique ID for the calendar resource. 345 "resourceName": "A String", # The name of the calendar resource. For example, "Training Room 1A". 346 "resourceType": "A String", # The type of the calendar resource, intended for non-room resources. 347 "userVisibleDescription": "A String", # Description of the resource, visible to users and admins. 348} 349 350 x__xgafv: string, V1 error format. 351 Allowed values 352 1 - v1 error format 353 2 - v2 error format 354 355Returns: 356 An object of the form: 357 358 { # Public API: Resources.calendars 359 "buildingId": "A String", # Unique ID for the building a resource is located in. 360 "capacity": 42, # Capacity of a resource, number of seats in a room. 361 "etags": "A String", # ETag of the resource. 362 "featureInstances": "", # Instances of features for the calendar resource. 363 "floorName": "A String", # Name of the floor a resource is located on. 364 "floorSection": "A String", # Name of the section within a floor a resource is located in. 365 "generatedResourceName": "A 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)". 366 "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is `admin#directory#resources#calendars#CalendarResource`. 367 "resourceCategory": "A String", # The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN. 368 "resourceDescription": "A String", # Description of the resource, visible only to admins. 369 "resourceEmail": "A String", # The read-only email for the calendar resource. Generated as part of creating a new calendar resource. 370 "resourceId": "A String", # The unique ID for the calendar resource. 371 "resourceName": "A String", # The name of the calendar resource. For example, "Training Room 1A". 372 "resourceType": "A String", # The type of the calendar resource, intended for non-room resources. 373 "userVisibleDescription": "A String", # Description of the resource, visible to users and admins. 374}</pre> 375</div> 376 377</body></html>