1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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.buildings.html">buildings</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(customer, buildingId)</a></code></p>
<p class="firstline">Deletes a building.</p>
<p class="toc_element">
<code><a href="#get">get(customer, buildingId)</a></code></p>
<p class="firstline">Retrieves a building.</p>
<p class="toc_element">
<code><a href="#insert">insert(customer, body, coordinatesSource=None)</a></code></p>
<p class="firstline">Inserts a building.</p>
<p class="toc_element">
<code><a href="#list">list(customer, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">Retrieves a list of buildings for an account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(customer, buildingId, body, coordinatesSource=None)</a></code></p>
<p class="firstline">Updates a building. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(customer, buildingId, body, coordinatesSource=None)</a></code></p>
<p class="firstline">Updates a building.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(customer, buildingId)</code>
<pre>Deletes a building.
Args:
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)
buildingId: string, The ID of the building to delete. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(customer, buildingId)</code>
<pre>Retrieves a building.
Args:
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)
buildingId: string, The unique ID of the building to retrieve. (required)
Returns:
An object of the form:
{ # JSON template for Building object in Directory API.
"kind": "admin#directory#resources#buildings#Building", # Kind of resource this is.
"buildingName": "A String", # The building name as seen by users in Calendar. Must be unique for the customer. For example, "NYC-CHEL". The maximum length is 100 characters.
"coordinates": { # JSON template for coordinates of a building in Directory API. # The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees.
"latitude": 3.14, # Latitude in decimal degrees.
"longitude": 3.14, # Longitude in decimal degrees.
},
"etags": "A String", # ETag of the resource.
"address": { # JSON template for the postal address of a building in Directory API. # The postal address of the building. See PostalAddress for details. Note that only a single address line and region code are required.
"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known).
"locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines.
"regionCode": "A String", # Required. CLDR region code of the country/region of the address.
"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
"addressLines": [ # Unstructured address lines describing the lower levels of an address.
"A String",
],
"postalCode": "A String", # Optional. Postal code of the address.
"sublocality": "A String", # Optional. Sublocality of the address.
},
"floorNames": [ # The display names for all floors in this building. The floors are expected to be sorted in ascending order, from lowest floor to highest floor. For example, ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] Must contain at least one entry.
"A String",
],
"buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters.
"description": "A String", # A brief description of the building. For example, "Chelsea Market".
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(customer, body, coordinatesSource=None)</code>
<pre>Inserts a building.
Args:
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)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Building object in Directory API.
"kind": "admin#directory#resources#buildings#Building", # Kind of resource this is.
"buildingName": "A String", # The building name as seen by users in Calendar. Must be unique for the customer. For example, "NYC-CHEL". The maximum length is 100 characters.
"coordinates": { # JSON template for coordinates of a building in Directory API. # The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees.
"latitude": 3.14, # Latitude in decimal degrees.
"longitude": 3.14, # Longitude in decimal degrees.
},
"etags": "A String", # ETag of the resource.
"address": { # JSON template for the postal address of a building in Directory API. # The postal address of the building. See PostalAddress for details. Note that only a single address line and region code are required.
"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known).
"locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines.
"regionCode": "A String", # Required. CLDR region code of the country/region of the address.
"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
"addressLines": [ # Unstructured address lines describing the lower levels of an address.
"A String",
],
"postalCode": "A String", # Optional. Postal code of the address.
"sublocality": "A String", # Optional. Sublocality of the address.
},
"floorNames": [ # The display names for all floors in this building. The floors are expected to be sorted in ascending order, from lowest floor to highest floor. For example, ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] Must contain at least one entry.
"A String",
],
"buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters.
"description": "A String", # A brief description of the building. For example, "Chelsea Market".
}
coordinatesSource: string, Source from which Building.coordinates are derived.
Allowed values
CLIENT_SPECIFIED - Building.coordinates are set to the coordinates included in the request.
RESOLVED_FROM_ADDRESS - Building.coordinates are automatically populated based on the postal address.
SOURCE_UNSPECIFIED - Defaults to RESOLVED_FROM_ADDRESS if postal address is provided. Otherwise, defaults to CLIENT_SPECIFIED if coordinates are provided.
Returns:
An object of the form:
{ # JSON template for Building object in Directory API.
"kind": "admin#directory#resources#buildings#Building", # Kind of resource this is.
"buildingName": "A String", # The building name as seen by users in Calendar. Must be unique for the customer. For example, "NYC-CHEL". The maximum length is 100 characters.
"coordinates": { # JSON template for coordinates of a building in Directory API. # The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees.
"latitude": 3.14, # Latitude in decimal degrees.
"longitude": 3.14, # Longitude in decimal degrees.
},
"etags": "A String", # ETag of the resource.
"address": { # JSON template for the postal address of a building in Directory API. # The postal address of the building. See PostalAddress for details. Note that only a single address line and region code are required.
"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known).
"locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines.
"regionCode": "A String", # Required. CLDR region code of the country/region of the address.
"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
"addressLines": [ # Unstructured address lines describing the lower levels of an address.
"A String",
],
"postalCode": "A String", # Optional. Postal code of the address.
"sublocality": "A String", # Optional. Sublocality of the address.
},
"floorNames": [ # The display names for all floors in this building. The floors are expected to be sorted in ascending order, from lowest floor to highest floor. For example, ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] Must contain at least one entry.
"A String",
],
"buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters.
"description": "A String", # A brief description of the building. For example, "Chelsea Market".
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(customer, pageToken=None, maxResults=None)</code>
<pre>Retrieves a list of buildings for an account.
Args:
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)
pageToken: string, Token to specify the next page in the list.
maxResults: integer, Maximum number of results to return.
Returns:
An object of the form:
{ # JSON template for Building List Response object in Directory API.
"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.
"buildings": [ # The Buildings in this page of results.
{ # JSON template for Building object in Directory API.
"kind": "admin#directory#resources#buildings#Building", # Kind of resource this is.
"buildingName": "A String", # The building name as seen by users in Calendar. Must be unique for the customer. For example, "NYC-CHEL". The maximum length is 100 characters.
"coordinates": { # JSON template for coordinates of a building in Directory API. # The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees.
"latitude": 3.14, # Latitude in decimal degrees.
"longitude": 3.14, # Longitude in decimal degrees.
},
"etags": "A String", # ETag of the resource.
"address": { # JSON template for the postal address of a building in Directory API. # The postal address of the building. See PostalAddress for details. Note that only a single address line and region code are required.
"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known).
"locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines.
"regionCode": "A String", # Required. CLDR region code of the country/region of the address.
"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
"addressLines": [ # Unstructured address lines describing the lower levels of an address.
"A String",
],
"postalCode": "A String", # Optional. Postal code of the address.
"sublocality": "A String", # Optional. Sublocality of the address.
},
"floorNames": [ # The display names for all floors in this building. The floors are expected to be sorted in ascending order, from lowest floor to highest floor. For example, ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] Must contain at least one entry.
"A String",
],
"buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters.
"description": "A String", # A brief description of the building. For example, "Chelsea Market".
},
],
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#resources#buildings#buildingsList", # Kind of resource this is.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(customer, buildingId, body, coordinatesSource=None)</code>
<pre>Updates a building. This method supports patch semantics.
Args:
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)
buildingId: string, The ID of the building to update. (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Building object in Directory API.
"kind": "admin#directory#resources#buildings#Building", # Kind of resource this is.
"buildingName": "A String", # The building name as seen by users in Calendar. Must be unique for the customer. For example, "NYC-CHEL". The maximum length is 100 characters.
"coordinates": { # JSON template for coordinates of a building in Directory API. # The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees.
"latitude": 3.14, # Latitude in decimal degrees.
"longitude": 3.14, # Longitude in decimal degrees.
},
"etags": "A String", # ETag of the resource.
"address": { # JSON template for the postal address of a building in Directory API. # The postal address of the building. See PostalAddress for details. Note that only a single address line and region code are required.
"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known).
"locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines.
"regionCode": "A String", # Required. CLDR region code of the country/region of the address.
"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
"addressLines": [ # Unstructured address lines describing the lower levels of an address.
"A String",
],
"postalCode": "A String", # Optional. Postal code of the address.
"sublocality": "A String", # Optional. Sublocality of the address.
},
"floorNames": [ # The display names for all floors in this building. The floors are expected to be sorted in ascending order, from lowest floor to highest floor. For example, ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] Must contain at least one entry.
"A String",
],
"buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters.
"description": "A String", # A brief description of the building. For example, "Chelsea Market".
}
coordinatesSource: string, Source from which Building.coordinates are derived.
Allowed values
CLIENT_SPECIFIED - Building.coordinates are set to the coordinates included in the request.
RESOLVED_FROM_ADDRESS - Building.coordinates are automatically populated based on the postal address.
SOURCE_UNSPECIFIED - Defaults to RESOLVED_FROM_ADDRESS if postal address is provided. Otherwise, defaults to CLIENT_SPECIFIED if coordinates are provided.
Returns:
An object of the form:
{ # JSON template for Building object in Directory API.
"kind": "admin#directory#resources#buildings#Building", # Kind of resource this is.
"buildingName": "A String", # The building name as seen by users in Calendar. Must be unique for the customer. For example, "NYC-CHEL". The maximum length is 100 characters.
"coordinates": { # JSON template for coordinates of a building in Directory API. # The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees.
"latitude": 3.14, # Latitude in decimal degrees.
"longitude": 3.14, # Longitude in decimal degrees.
},
"etags": "A String", # ETag of the resource.
"address": { # JSON template for the postal address of a building in Directory API. # The postal address of the building. See PostalAddress for details. Note that only a single address line and region code are required.
"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known).
"locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines.
"regionCode": "A String", # Required. CLDR region code of the country/region of the address.
"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
"addressLines": [ # Unstructured address lines describing the lower levels of an address.
"A String",
],
"postalCode": "A String", # Optional. Postal code of the address.
"sublocality": "A String", # Optional. Sublocality of the address.
},
"floorNames": [ # The display names for all floors in this building. The floors are expected to be sorted in ascending order, from lowest floor to highest floor. For example, ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] Must contain at least one entry.
"A String",
],
"buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters.
"description": "A String", # A brief description of the building. For example, "Chelsea Market".
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(customer, buildingId, body, coordinatesSource=None)</code>
<pre>Updates a building.
Args:
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)
buildingId: string, The ID of the building to update. (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Building object in Directory API.
"kind": "admin#directory#resources#buildings#Building", # Kind of resource this is.
"buildingName": "A String", # The building name as seen by users in Calendar. Must be unique for the customer. For example, "NYC-CHEL". The maximum length is 100 characters.
"coordinates": { # JSON template for coordinates of a building in Directory API. # The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees.
"latitude": 3.14, # Latitude in decimal degrees.
"longitude": 3.14, # Longitude in decimal degrees.
},
"etags": "A String", # ETag of the resource.
"address": { # JSON template for the postal address of a building in Directory API. # The postal address of the building. See PostalAddress for details. Note that only a single address line and region code are required.
"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known).
"locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines.
"regionCode": "A String", # Required. CLDR region code of the country/region of the address.
"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
"addressLines": [ # Unstructured address lines describing the lower levels of an address.
"A String",
],
"postalCode": "A String", # Optional. Postal code of the address.
"sublocality": "A String", # Optional. Sublocality of the address.
},
"floorNames": [ # The display names for all floors in this building. The floors are expected to be sorted in ascending order, from lowest floor to highest floor. For example, ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] Must contain at least one entry.
"A String",
],
"buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters.
"description": "A String", # A brief description of the building. For example, "Chelsea Market".
}
coordinatesSource: string, Source from which Building.coordinates are derived.
Allowed values
CLIENT_SPECIFIED - Building.coordinates are set to the coordinates included in the request.
RESOLVED_FROM_ADDRESS - Building.coordinates are automatically populated based on the postal address.
SOURCE_UNSPECIFIED - Defaults to RESOLVED_FROM_ADDRESS if postal address is provided. Otherwise, defaults to CLIENT_SPECIFIED if coordinates are provided.
Returns:
An object of the form:
{ # JSON template for Building object in Directory API.
"kind": "admin#directory#resources#buildings#Building", # Kind of resource this is.
"buildingName": "A String", # The building name as seen by users in Calendar. Must be unique for the customer. For example, "NYC-CHEL". The maximum length is 100 characters.
"coordinates": { # JSON template for coordinates of a building in Directory API. # The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees.
"latitude": 3.14, # Latitude in decimal degrees.
"longitude": 3.14, # Longitude in decimal degrees.
},
"etags": "A String", # ETag of the resource.
"address": { # JSON template for the postal address of a building in Directory API. # The postal address of the building. See PostalAddress for details. Note that only a single address line and region code are required.
"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known).
"locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines.
"regionCode": "A String", # Required. CLDR region code of the country/region of the address.
"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
"addressLines": [ # Unstructured address lines describing the lower levels of an address.
"A String",
],
"postalCode": "A String", # Optional. Postal code of the address.
"sublocality": "A String", # Optional. Sublocality of the address.
},
"floorNames": [ # The display names for all floors in this building. The floors are expected to be sorted in ascending order, from lowest floor to highest floor. For example, ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] Must contain at least one entry.
"A String",
],
"buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters.
"description": "A String", # A brief description of the building. For example, "Chelsea Market".
}</pre>
</div>
</body></html>
|
