• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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, pageToken=None, maxResults=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. This method supports patch semantics.</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      "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
123      "resourceDescription": "A String", # The brief description of the calendar resource.
124      "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
125      "etags": "A String", # ETag of the resource.
126      "resourceId": "A String", # The unique ID for the calendar resource.
127      "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
128    }</pre>
129</div>
130
131<div class="method">
132    <code class="details" id="insert">insert(customer, body)</code>
133  <pre>Inserts a calendar resource.
134
135Args:
136  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)
137  body: object, The request body. (required)
138    The object takes the form of:
139
140{ # JSON template for Calendar Resource object in Directory API.
141    "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
142    "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
143    "resourceDescription": "A String", # The brief description of the calendar resource.
144    "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
145    "etags": "A String", # ETag of the resource.
146    "resourceId": "A String", # The unique ID for the calendar resource.
147    "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
148  }
149
150
151Returns:
152  An object of the form:
153
154    { # JSON template for Calendar Resource object in Directory API.
155      "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
156      "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
157      "resourceDescription": "A String", # The brief description of the calendar resource.
158      "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
159      "etags": "A String", # ETag of the resource.
160      "resourceId": "A String", # The unique ID for the calendar resource.
161      "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
162    }</pre>
163</div>
164
165<div class="method">
166    <code class="details" id="list">list(customer, pageToken=None, maxResults=None)</code>
167  <pre>Retrieves a list of calendar resources for an account.
168
169Args:
170  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)
171  pageToken: string, Token to specify the next page in the list.
172  maxResults: integer, Maximum number of results to return.
173
174Returns:
175  An object of the form:
176
177    { # JSON template for Calendar Resource List Response object in Directory API.
178    "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.
179    "items": [ # The CalendarResources in this page of results.
180      { # JSON template for Calendar Resource object in Directory API.
181          "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
182          "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
183          "resourceDescription": "A String", # The brief description of the calendar resource.
184          "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
185          "etags": "A String", # ETag of the resource.
186          "resourceId": "A String", # The unique ID for the calendar resource.
187          "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
188        },
189    ],
190    "kind": "admin#directory#resources#calendars#calendarResourcesList", # Identifies this as a collection of CalendarResources. This is always admin#directory#resources#calendars#calendarResourcesList.
191    "etag": "A String", # ETag of the resource.
192  }</pre>
193</div>
194
195<div class="method">
196    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
197  <pre>Retrieves the next page of results.
198
199Args:
200  previous_request: The request for the previous page. (required)
201  previous_response: The response from the request for the previous page. (required)
202
203Returns:
204  A request object that you can call 'execute()' on to request the next
205  page. Returns None if there are no more items in the collection.
206    </pre>
207</div>
208
209<div class="method">
210    <code class="details" id="patch">patch(customer, calendarResourceId, body)</code>
211  <pre>Updates a calendar resource. This method supports patch semantics.
212
213Args:
214  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)
215  calendarResourceId: string, The unique ID of the calendar resource to update. (required)
216  body: object, The request body. (required)
217    The object takes the form of:
218
219{ # JSON template for Calendar Resource object in Directory API.
220    "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
221    "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
222    "resourceDescription": "A String", # The brief description of the calendar resource.
223    "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
224    "etags": "A String", # ETag of the resource.
225    "resourceId": "A String", # The unique ID for the calendar resource.
226    "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
227  }
228
229
230Returns:
231  An object of the form:
232
233    { # JSON template for Calendar Resource object in Directory API.
234      "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
235      "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
236      "resourceDescription": "A String", # The brief description of the calendar resource.
237      "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
238      "etags": "A String", # ETag of the resource.
239      "resourceId": "A String", # The unique ID for the calendar resource.
240      "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
241    }</pre>
242</div>
243
244<div class="method">
245    <code class="details" id="update">update(customer, calendarResourceId, body)</code>
246  <pre>Updates a calendar resource.
247
248Args:
249  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)
250  calendarResourceId: string, The unique ID of the calendar resource to update. (required)
251  body: object, The request body. (required)
252    The object takes the form of:
253
254{ # JSON template for Calendar Resource object in Directory API.
255    "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
256    "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
257    "resourceDescription": "A String", # The brief description of the calendar resource.
258    "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
259    "etags": "A String", # ETag of the resource.
260    "resourceId": "A String", # The unique ID for the calendar resource.
261    "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
262  }
263
264
265Returns:
266  An object of the form:
267
268    { # JSON template for Calendar Resource object in Directory API.
269      "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
270      "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
271      "resourceDescription": "A String", # The brief description of the calendar resource.
272      "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
273      "etags": "A String", # ETag of the resource.
274      "resourceId": "A String", # The unique ID for the calendar resource.
275      "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
276    }</pre>
277</div>
278
279</body></html>