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 Directory 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="#delete">delete(customer, calendarResourceId)</a></code></p>
79<p class="firstline">Deletes a calendar resource.</p>
80<p class="toc_element">
81  <code><a href="#get">get(customer, calendarResourceId)</a></code></p>
82<p class="firstline">Retrieves a calendar resource.</p>
83<p class="toc_element">
84  <code><a href="#insert">insert(customer, body)</a></code></p>
85<p class="firstline">Inserts a calendar resource.</p>
86<p class="toc_element">
87  <code><a href="#list">list(customer, orderBy=None, pageToken=None, maxResults=None, query=None)</a></code></p>
88<p class="firstline">Retrieves a list of calendar resources for an account.</p>
89<p class="toc_element">
90  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93  <code><a href="#patch">patch(customer, calendarResourceId, body)</a></code></p>
94<p class="firstline">Updates a calendar resource.</p>
95<p class="toc_element">
96  <code><a href="#update">update(customer, calendarResourceId, body)</a></code></p>
97<p class="firstline">Updates a calendar resource.</p>
98<h3>Method Details</h3>
99<div class="method">
100    <code class="details" id="delete">delete(customer, calendarResourceId)</code>
101  <pre>Deletes a calendar resource.
102
103Args:
104  customer: 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. (required)
105  calendarResourceId: string, The unique ID of the calendar resource to delete. (required)
106</pre>
107</div>
108
109<div class="method">
110    <code class="details" id="get">get(customer, calendarResourceId)</code>
111  <pre>Retrieves a calendar resource.
112
113Args:
114  customer: 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. (required)
115  calendarResourceId: string, The unique ID of the calendar resource to retrieve. (required)
116
117Returns:
118  An object of the form:
119
120    { # JSON template for Calendar Resource object in Directory API.
121      "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
122      "capacity": 42, # Capacity of a resource, number of seats in a room.
123      "resourceType": "A String", # The type of the calendar resource, intended for non-room resources.
124      "resourceDescription": "A String", # Description of the resource, visible only to admins.
125      "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)".
126      "etags": "A String", # ETag of the resource.
127      "resourceName": "A String", # The name of the calendar resource. For example, "Training Room 1A".
128      "resourceEmail": "A String", # The read-only email for the calendar resource. Generated as part of creating a new calendar resource.
129      "resourceCategory": "A String", # The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN.
130      "featureInstances": "",
131      "userVisibleDescription": "A String", # Description of the resource, visible to users and admins.
132      "resourceId": "A String", # The unique ID for the calendar resource.
133      "buildingId": "A String", # Unique ID for the building a resource is located in.
134      "floorName": "A String", # Name of the floor a resource is located on.
135      "floorSection": "A String", # Name of the section within a floor a resource is located in.
136    }</pre>
137</div>
138
139<div class="method">
140    <code class="details" id="insert">insert(customer, body)</code>
141  <pre>Inserts a calendar resource.
142
143Args:
144  customer: 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. (required)
145  body: object, The request body. (required)
146    The object takes the form of:
147
148{ # JSON template for Calendar Resource object in Directory API.
149    "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
150    "capacity": 42, # Capacity of a resource, number of seats in a room.
151    "resourceType": "A String", # The type of the calendar resource, intended for non-room resources.
152    "resourceDescription": "A String", # Description of the resource, visible only to admins.
153    "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)".
154    "etags": "A String", # ETag of the resource.
155    "resourceName": "A String", # The name of the calendar resource. For example, "Training Room 1A".
156    "resourceEmail": "A String", # The read-only email for the calendar resource. Generated as part of creating a new calendar resource.
157    "resourceCategory": "A String", # The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN.
158    "featureInstances": "",
159    "userVisibleDescription": "A String", # Description of the resource, visible to users and admins.
160    "resourceId": "A String", # The unique ID for the calendar resource.
161    "buildingId": "A String", # Unique ID for the building a resource is located in.
162    "floorName": "A String", # Name of the floor a resource is located on.
163    "floorSection": "A String", # Name of the section within a floor a resource is located in.
164  }
165
166
167Returns:
168  An object of the form:
169
170    { # JSON template for Calendar Resource object in Directory API.
171      "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
172      "capacity": 42, # Capacity of a resource, number of seats in a room.
173      "resourceType": "A String", # The type of the calendar resource, intended for non-room resources.
174      "resourceDescription": "A String", # Description of the resource, visible only to admins.
175      "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)".
176      "etags": "A String", # ETag of the resource.
177      "resourceName": "A String", # The name of the calendar resource. For example, "Training Room 1A".
178      "resourceEmail": "A String", # The read-only email for the calendar resource. Generated as part of creating a new calendar resource.
179      "resourceCategory": "A String", # The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN.
180      "featureInstances": "",
181      "userVisibleDescription": "A String", # Description of the resource, visible to users and admins.
182      "resourceId": "A String", # The unique ID for the calendar resource.
183      "buildingId": "A String", # Unique ID for the building a resource is located in.
184      "floorName": "A String", # Name of the floor a resource is located on.
185      "floorSection": "A String", # Name of the section within a floor a resource is located in.
186    }</pre>
187</div>
188
189<div class="method">
190    <code class="details" id="list">list(customer, orderBy=None, pageToken=None, maxResults=None, query=None)</code>
191  <pre>Retrieves a list of calendar resources for an account.
192
193Args:
194  customer: 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. (required)
195  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.
196  pageToken: string, Token to specify the next page in the list.
197  maxResults: integer, Maximum number of results to return.
198  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 and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Supported fields include generatedResourceName, name, buildingId, featureInstances.feature.name. For example buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone.
199
200Returns:
201  An object of the form:
202
203    { # JSON template for Calendar Resource List Response object in Directory API.
204    "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.
205    "items": [ # The CalendarResources in this page of results.
206      { # JSON template for Calendar Resource object in Directory API.
207          "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
208          "capacity": 42, # Capacity of a resource, number of seats in a room.
209          "resourceType": "A String", # The type of the calendar resource, intended for non-room resources.
210          "resourceDescription": "A String", # Description of the resource, visible only to admins.
211          "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)".
212          "etags": "A String", # ETag of the resource.
213          "resourceName": "A String", # The name of the calendar resource. For example, "Training Room 1A".
214          "resourceEmail": "A String", # The read-only email for the calendar resource. Generated as part of creating a new calendar resource.
215          "resourceCategory": "A String", # The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN.
216          "featureInstances": "",
217          "userVisibleDescription": "A String", # Description of the resource, visible to users and admins.
218          "resourceId": "A String", # The unique ID for the calendar resource.
219          "buildingId": "A String", # Unique ID for the building a resource is located in.
220          "floorName": "A String", # Name of the floor a resource is located on.
221          "floorSection": "A String", # Name of the section within a floor a resource is located in.
222        },
223    ],
224    "kind": "admin#directory#resources#calendars#calendarResourcesList", # Identifies this as a collection of CalendarResources. This is always admin#directory#resources#calendars#calendarResourcesList.
225    "etag": "A String", # ETag of the resource.
226  }</pre>
227</div>
228
229<div class="method">
230    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
231  <pre>Retrieves the next page of results.
232
233Args:
234  previous_request: The request for the previous page. (required)
235  previous_response: The response from the request for the previous page. (required)
236
237Returns:
238  A request object that you can call 'execute()' on to request the next
239  page. Returns None if there are no more items in the collection.
240    </pre>
241</div>
242
243<div class="method">
244    <code class="details" id="patch">patch(customer, calendarResourceId, body)</code>
245  <pre>Updates a calendar resource.
246
247This 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. This method supports patch semantics.
248
249Args:
250  customer: 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. (required)
251  calendarResourceId: string, The unique ID of the calendar resource to update. (required)
252  body: object, The request body. (required)
253    The object takes the form of:
254
255{ # JSON template for Calendar Resource object in Directory API.
256    "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
257    "capacity": 42, # Capacity of a resource, number of seats in a room.
258    "resourceType": "A String", # The type of the calendar resource, intended for non-room resources.
259    "resourceDescription": "A String", # Description of the resource, visible only to admins.
260    "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)".
261    "etags": "A String", # ETag of the resource.
262    "resourceName": "A String", # The name of the calendar resource. For example, "Training Room 1A".
263    "resourceEmail": "A String", # The read-only email for the calendar resource. Generated as part of creating a new calendar resource.
264    "resourceCategory": "A String", # The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN.
265    "featureInstances": "",
266    "userVisibleDescription": "A String", # Description of the resource, visible to users and admins.
267    "resourceId": "A String", # The unique ID for the calendar resource.
268    "buildingId": "A String", # Unique ID for the building a resource is located in.
269    "floorName": "A String", # Name of the floor a resource is located on.
270    "floorSection": "A String", # Name of the section within a floor a resource is located in.
271  }
272
273
274Returns:
275  An object of the form:
276
277    { # JSON template for Calendar Resource object in Directory API.
278      "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
279      "capacity": 42, # Capacity of a resource, number of seats in a room.
280      "resourceType": "A String", # The type of the calendar resource, intended for non-room resources.
281      "resourceDescription": "A String", # Description of the resource, visible only to admins.
282      "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)".
283      "etags": "A String", # ETag of the resource.
284      "resourceName": "A String", # The name of the calendar resource. For example, "Training Room 1A".
285      "resourceEmail": "A String", # The read-only email for the calendar resource. Generated as part of creating a new calendar resource.
286      "resourceCategory": "A String", # The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN.
287      "featureInstances": "",
288      "userVisibleDescription": "A String", # Description of the resource, visible to users and admins.
289      "resourceId": "A String", # The unique ID for the calendar resource.
290      "buildingId": "A String", # Unique ID for the building a resource is located in.
291      "floorName": "A String", # Name of the floor a resource is located on.
292      "floorSection": "A String", # Name of the section within a floor a resource is located in.
293    }</pre>
294</div>
295
296<div class="method">
297    <code class="details" id="update">update(customer, calendarResourceId, body)</code>
298  <pre>Updates a calendar resource.
299
300This 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.
301
302Args:
303  customer: 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. (required)
304  calendarResourceId: string, The unique ID of the calendar resource to update. (required)
305  body: object, The request body. (required)
306    The object takes the form of:
307
308{ # JSON template for Calendar Resource object in Directory API.
309    "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
310    "capacity": 42, # Capacity of a resource, number of seats in a room.
311    "resourceType": "A String", # The type of the calendar resource, intended for non-room resources.
312    "resourceDescription": "A String", # Description of the resource, visible only to admins.
313    "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)".
314    "etags": "A String", # ETag of the resource.
315    "resourceName": "A String", # The name of the calendar resource. For example, "Training Room 1A".
316    "resourceEmail": "A String", # The read-only email for the calendar resource. Generated as part of creating a new calendar resource.
317    "resourceCategory": "A String", # The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN.
318    "featureInstances": "",
319    "userVisibleDescription": "A String", # Description of the resource, visible to users and admins.
320    "resourceId": "A String", # The unique ID for the calendar resource.
321    "buildingId": "A String", # Unique ID for the building a resource is located in.
322    "floorName": "A String", # Name of the floor a resource is located on.
323    "floorSection": "A String", # Name of the section within a floor a resource is located in.
324  }
325
326
327Returns:
328  An object of the form:
329
330    { # JSON template for Calendar Resource object in Directory API.
331      "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
332      "capacity": 42, # Capacity of a resource, number of seats in a room.
333      "resourceType": "A String", # The type of the calendar resource, intended for non-room resources.
334      "resourceDescription": "A String", # Description of the resource, visible only to admins.
335      "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)".
336      "etags": "A String", # ETag of the resource.
337      "resourceName": "A String", # The name of the calendar resource. For example, "Training Room 1A".
338      "resourceEmail": "A String", # The read-only email for the calendar resource. Generated as part of creating a new calendar resource.
339      "resourceCategory": "A String", # The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN.
340      "featureInstances": "",
341      "userVisibleDescription": "A String", # Description of the resource, visible to users and admins.
342      "resourceId": "A String", # The unique ID for the calendar resource.
343      "buildingId": "A String", # Unique ID for the building a resource is located in.
344      "floorName": "A String", # Name of the floor a resource is located on.
345      "floorSection": "A String", # Name of the section within a floor a resource is located in.
346    }</pre>
347</div>
348
349</body></html>