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.buildings.html">buildings</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#delete">delete(customer, buildingId)</a></code></p> 79<p class="firstline">Deletes a building.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(customer, buildingId)</a></code></p> 82<p class="firstline">Retrieves a building.</p> 83<p class="toc_element"> 84 <code><a href="#insert">insert(customer, body, coordinatesSource=None)</a></code></p> 85<p class="firstline">Inserts a building.</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 buildings 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, buildingId, body, coordinatesSource=None)</a></code></p> 94<p class="firstline">Updates a building. This method supports patch semantics.</p> 95<p class="toc_element"> 96 <code><a href="#update">update(customer, buildingId, body, coordinatesSource=None)</a></code></p> 97<p class="firstline">Updates a building.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="delete">delete(customer, buildingId)</code> 101 <pre>Deletes a building. 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 buildingId: string, The ID of the building to delete. (required) 106</pre> 107</div> 108 109<div class="method"> 110 <code class="details" id="get">get(customer, buildingId)</code> 111 <pre>Retrieves a building. 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 buildingId: string, The unique ID of the building to retrieve. (required) 116 117Returns: 118 An object of the form: 119 120 { # JSON template for Building object in Directory API. 121 "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is. 122 "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. 123 "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. 124 "latitude": 3.14, # Latitude in decimal degrees. 125 "longitude": 3.14, # Longitude in decimal degrees. 126 }, 127 "etags": "A String", # ETag of the resource. 128 "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. 129 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). 130 "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. 131 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. 132 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. 133 "addressLines": [ # Unstructured address lines describing the lower levels of an address. 134 "A String", 135 ], 136 "postalCode": "A String", # Optional. Postal code of the address. 137 "sublocality": "A String", # Optional. Sublocality of the address. 138 }, 139 "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. 140 "A String", 141 ], 142 "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters. 143 "description": "A String", # A brief description of the building. For example, "Chelsea Market". 144 }</pre> 145</div> 146 147<div class="method"> 148 <code class="details" id="insert">insert(customer, body, coordinatesSource=None)</code> 149 <pre>Inserts a building. 150 151Args: 152 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) 153 body: object, The request body. (required) 154 The object takes the form of: 155 156{ # JSON template for Building object in Directory API. 157 "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is. 158 "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. 159 "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. 160 "latitude": 3.14, # Latitude in decimal degrees. 161 "longitude": 3.14, # Longitude in decimal degrees. 162 }, 163 "etags": "A String", # ETag of the resource. 164 "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. 165 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). 166 "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. 167 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. 168 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. 169 "addressLines": [ # Unstructured address lines describing the lower levels of an address. 170 "A String", 171 ], 172 "postalCode": "A String", # Optional. Postal code of the address. 173 "sublocality": "A String", # Optional. Sublocality of the address. 174 }, 175 "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. 176 "A String", 177 ], 178 "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters. 179 "description": "A String", # A brief description of the building. For example, "Chelsea Market". 180 } 181 182 coordinatesSource: string, Source from which Building.coordinates are derived. 183 Allowed values 184 CLIENT_SPECIFIED - Building.coordinates are set to the coordinates included in the request. 185 RESOLVED_FROM_ADDRESS - Building.coordinates are automatically populated based on the postal address. 186 SOURCE_UNSPECIFIED - Defaults to RESOLVED_FROM_ADDRESS if postal address is provided. Otherwise, defaults to CLIENT_SPECIFIED if coordinates are provided. 187 188Returns: 189 An object of the form: 190 191 { # JSON template for Building object in Directory API. 192 "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is. 193 "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. 194 "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. 195 "latitude": 3.14, # Latitude in decimal degrees. 196 "longitude": 3.14, # Longitude in decimal degrees. 197 }, 198 "etags": "A String", # ETag of the resource. 199 "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. 200 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). 201 "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. 202 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. 203 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. 204 "addressLines": [ # Unstructured address lines describing the lower levels of an address. 205 "A String", 206 ], 207 "postalCode": "A String", # Optional. Postal code of the address. 208 "sublocality": "A String", # Optional. Sublocality of the address. 209 }, 210 "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. 211 "A String", 212 ], 213 "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters. 214 "description": "A String", # A brief description of the building. For example, "Chelsea Market". 215 }</pre> 216</div> 217 218<div class="method"> 219 <code class="details" id="list">list(customer, pageToken=None, maxResults=None)</code> 220 <pre>Retrieves a list of buildings for an account. 221 222Args: 223 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) 224 pageToken: string, Token to specify the next page in the list. 225 maxResults: integer, Maximum number of results to return. 226 227Returns: 228 An object of the form: 229 230 { # JSON template for Building List Response object in Directory API. 231 "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. 232 "buildings": [ # The Buildings in this page of results. 233 { # JSON template for Building object in Directory API. 234 "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is. 235 "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. 236 "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. 237 "latitude": 3.14, # Latitude in decimal degrees. 238 "longitude": 3.14, # Longitude in decimal degrees. 239 }, 240 "etags": "A String", # ETag of the resource. 241 "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. 242 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). 243 "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. 244 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. 245 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. 246 "addressLines": [ # Unstructured address lines describing the lower levels of an address. 247 "A String", 248 ], 249 "postalCode": "A String", # Optional. Postal code of the address. 250 "sublocality": "A String", # Optional. Sublocality of the address. 251 }, 252 "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. 253 "A String", 254 ], 255 "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters. 256 "description": "A String", # A brief description of the building. For example, "Chelsea Market". 257 }, 258 ], 259 "etag": "A String", # ETag of the resource. 260 "kind": "admin#directory#resources#buildings#buildingsList", # Kind of resource this is. 261 }</pre> 262</div> 263 264<div class="method"> 265 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 266 <pre>Retrieves the next page of results. 267 268Args: 269 previous_request: The request for the previous page. (required) 270 previous_response: The response from the request for the previous page. (required) 271 272Returns: 273 A request object that you can call 'execute()' on to request the next 274 page. Returns None if there are no more items in the collection. 275 </pre> 276</div> 277 278<div class="method"> 279 <code class="details" id="patch">patch(customer, buildingId, body, coordinatesSource=None)</code> 280 <pre>Updates a building. This method supports patch semantics. 281 282Args: 283 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) 284 buildingId: string, The ID of the building to update. (required) 285 body: object, The request body. (required) 286 The object takes the form of: 287 288{ # JSON template for Building object in Directory API. 289 "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is. 290 "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. 291 "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. 292 "latitude": 3.14, # Latitude in decimal degrees. 293 "longitude": 3.14, # Longitude in decimal degrees. 294 }, 295 "etags": "A String", # ETag of the resource. 296 "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. 297 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). 298 "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. 299 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. 300 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. 301 "addressLines": [ # Unstructured address lines describing the lower levels of an address. 302 "A String", 303 ], 304 "postalCode": "A String", # Optional. Postal code of the address. 305 "sublocality": "A String", # Optional. Sublocality of the address. 306 }, 307 "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. 308 "A String", 309 ], 310 "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters. 311 "description": "A String", # A brief description of the building. For example, "Chelsea Market". 312 } 313 314 coordinatesSource: string, Source from which Building.coordinates are derived. 315 Allowed values 316 CLIENT_SPECIFIED - Building.coordinates are set to the coordinates included in the request. 317 RESOLVED_FROM_ADDRESS - Building.coordinates are automatically populated based on the postal address. 318 SOURCE_UNSPECIFIED - Defaults to RESOLVED_FROM_ADDRESS if postal address is provided. Otherwise, defaults to CLIENT_SPECIFIED if coordinates are provided. 319 320Returns: 321 An object of the form: 322 323 { # JSON template for Building object in Directory API. 324 "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is. 325 "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. 326 "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. 327 "latitude": 3.14, # Latitude in decimal degrees. 328 "longitude": 3.14, # Longitude in decimal degrees. 329 }, 330 "etags": "A String", # ETag of the resource. 331 "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. 332 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). 333 "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. 334 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. 335 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. 336 "addressLines": [ # Unstructured address lines describing the lower levels of an address. 337 "A String", 338 ], 339 "postalCode": "A String", # Optional. Postal code of the address. 340 "sublocality": "A String", # Optional. Sublocality of the address. 341 }, 342 "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. 343 "A String", 344 ], 345 "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters. 346 "description": "A String", # A brief description of the building. For example, "Chelsea Market". 347 }</pre> 348</div> 349 350<div class="method"> 351 <code class="details" id="update">update(customer, buildingId, body, coordinatesSource=None)</code> 352 <pre>Updates a building. 353 354Args: 355 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) 356 buildingId: string, The ID of the building to update. (required) 357 body: object, The request body. (required) 358 The object takes the form of: 359 360{ # JSON template for Building object in Directory API. 361 "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is. 362 "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. 363 "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. 364 "latitude": 3.14, # Latitude in decimal degrees. 365 "longitude": 3.14, # Longitude in decimal degrees. 366 }, 367 "etags": "A String", # ETag of the resource. 368 "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. 369 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). 370 "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. 371 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. 372 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. 373 "addressLines": [ # Unstructured address lines describing the lower levels of an address. 374 "A String", 375 ], 376 "postalCode": "A String", # Optional. Postal code of the address. 377 "sublocality": "A String", # Optional. Sublocality of the address. 378 }, 379 "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. 380 "A String", 381 ], 382 "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters. 383 "description": "A String", # A brief description of the building. For example, "Chelsea Market". 384 } 385 386 coordinatesSource: string, Source from which Building.coordinates are derived. 387 Allowed values 388 CLIENT_SPECIFIED - Building.coordinates are set to the coordinates included in the request. 389 RESOLVED_FROM_ADDRESS - Building.coordinates are automatically populated based on the postal address. 390 SOURCE_UNSPECIFIED - Defaults to RESOLVED_FROM_ADDRESS if postal address is provided. Otherwise, defaults to CLIENT_SPECIFIED if coordinates are provided. 391 392Returns: 393 An object of the form: 394 395 { # JSON template for Building object in Directory API. 396 "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is. 397 "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. 398 "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. 399 "latitude": 3.14, # Latitude in decimal degrees. 400 "longitude": 3.14, # Longitude in decimal degrees. 401 }, 402 "etags": "A String", # ETag of the resource. 403 "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. 404 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). 405 "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. 406 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. 407 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. 408 "addressLines": [ # Unstructured address lines describing the lower levels of an address. 409 "A String", 410 ], 411 "postalCode": "A String", # Optional. Postal code of the address. 412 "sublocality": "A String", # Optional. Sublocality of the address. 413 }, 414 "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. 415 "A String", 416 ], 417 "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters. 418 "description": "A String", # A brief description of the building. For example, "Chelsea Market". 419 }</pre> 420</div> 421 422</body></html>