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.buildings.html">buildings</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, buildingId, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes a building.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(customer, buildingId, x__xgafv=None)</a></code></p> 85<p class="firstline">Retrieves a building.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(customer, body=None, coordinatesSource=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Inserts a building.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(customer, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Retrieves a list of buildings 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, buildingId, body=None, coordinatesSource=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Patches a building.</p> 98<p class="toc_element"> 99 <code><a href="#update">update(customer, buildingId, body=None, coordinatesSource=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Updates a building.</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, buildingId, x__xgafv=None)</code> 109 <pre>Deletes a building. 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 buildingId: string, The id of the building 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, buildingId, x__xgafv=None)</code> 123 <pre>Retrieves a building. 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 buildingId: string, The unique ID of the building 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.buildings 137 "address": { # Public API: Resources.buildings # The postal address of the building. See [`PostalAddress`](/my-business/reference/rest/v4/PostalAddress) for details. Note that only a single address line and region code are required. 138 "addressLines": [ # Unstructured address lines describing the lower levels of an address. 139 "A String", 140 ], 141 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. 142 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). 143 "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. 144 "postalCode": "A String", # Optional. Postal code of the address. 145 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. 146 "sublocality": "A String", # Optional. Sublocality of the address. 147 }, 148 "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters. 149 "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. 150 "coordinates": { # Public API: Resources.buildings # The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees. 151 "latitude": 3.14, # Latitude in decimal degrees. 152 "longitude": 3.14, # Longitude in decimal degrees. 153 }, 154 "description": "A String", # A brief description of the building. For example, "Chelsea Market". 155 "etags": "A String", # ETag of the resource. 156 "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. 157 "A String", 158 ], 159 "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is. 160}</pre> 161</div> 162 163<div class="method"> 164 <code class="details" id="insert">insert(customer, body=None, coordinatesSource=None, x__xgafv=None)</code> 165 <pre>Inserts a building. 166 167Args: 168 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) 169 body: object, The request body. 170 The object takes the form of: 171 172{ # Public API: Resources.buildings 173 "address": { # Public API: Resources.buildings # The postal address of the building. See [`PostalAddress`](/my-business/reference/rest/v4/PostalAddress) for details. Note that only a single address line and region code are required. 174 "addressLines": [ # Unstructured address lines describing the lower levels of an address. 175 "A String", 176 ], 177 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. 178 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). 179 "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. 180 "postalCode": "A String", # Optional. Postal code of the address. 181 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. 182 "sublocality": "A String", # Optional. Sublocality of the address. 183 }, 184 "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters. 185 "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. 186 "coordinates": { # Public API: Resources.buildings # The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees. 187 "latitude": 3.14, # Latitude in decimal degrees. 188 "longitude": 3.14, # Longitude in decimal degrees. 189 }, 190 "description": "A String", # A brief description of the building. For example, "Chelsea Market". 191 "etags": "A String", # ETag of the resource. 192 "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. 193 "A String", 194 ], 195 "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is. 196} 197 198 coordinatesSource: string, Source from which Building.coordinates are derived. 199 Allowed values 200 CLIENT_SPECIFIED - Building.coordinates are set to the coordinates included in the request. 201 RESOLVED_FROM_ADDRESS - Building.coordinates are automatically populated based on the postal address. 202 SOURCE_UNSPECIFIED - Defaults to `RESOLVED_FROM_ADDRESS` if postal address is provided. Otherwise, defaults to `CLIENT_SPECIFIED` if coordinates are provided. 203 x__xgafv: string, V1 error format. 204 Allowed values 205 1 - v1 error format 206 2 - v2 error format 207 208Returns: 209 An object of the form: 210 211 { # Public API: Resources.buildings 212 "address": { # Public API: Resources.buildings # The postal address of the building. See [`PostalAddress`](/my-business/reference/rest/v4/PostalAddress) for details. Note that only a single address line and region code are required. 213 "addressLines": [ # Unstructured address lines describing the lower levels of an address. 214 "A String", 215 ], 216 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. 217 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). 218 "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. 219 "postalCode": "A String", # Optional. Postal code of the address. 220 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. 221 "sublocality": "A String", # Optional. Sublocality of the address. 222 }, 223 "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters. 224 "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. 225 "coordinates": { # Public API: Resources.buildings # The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees. 226 "latitude": 3.14, # Latitude in decimal degrees. 227 "longitude": 3.14, # Longitude in decimal degrees. 228 }, 229 "description": "A String", # A brief description of the building. For example, "Chelsea Market". 230 "etags": "A String", # ETag of the resource. 231 "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. 232 "A String", 233 ], 234 "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is. 235}</pre> 236</div> 237 238<div class="method"> 239 <code class="details" id="list">list(customer, maxResults=None, pageToken=None, x__xgafv=None)</code> 240 <pre>Retrieves a list of buildings for an account. 241 242Args: 243 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) 244 maxResults: integer, Maximum number of results to return. 245 pageToken: string, Token to specify the next page in the list. 246 x__xgafv: string, V1 error format. 247 Allowed values 248 1 - v1 error format 249 2 - v2 error format 250 251Returns: 252 An object of the form: 253 254 { # Public API: Resources.buildings 255 "buildings": [ # The Buildings in this page of results. 256 { # Public API: Resources.buildings 257 "address": { # Public API: Resources.buildings # The postal address of the building. See [`PostalAddress`](/my-business/reference/rest/v4/PostalAddress) for details. Note that only a single address line and region code are required. 258 "addressLines": [ # Unstructured address lines describing the lower levels of an address. 259 "A String", 260 ], 261 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. 262 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). 263 "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. 264 "postalCode": "A String", # Optional. Postal code of the address. 265 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. 266 "sublocality": "A String", # Optional. Sublocality of the address. 267 }, 268 "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters. 269 "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. 270 "coordinates": { # Public API: Resources.buildings # The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees. 271 "latitude": 3.14, # Latitude in decimal degrees. 272 "longitude": 3.14, # Longitude in decimal degrees. 273 }, 274 "description": "A String", # A brief description of the building. For example, "Chelsea Market". 275 "etags": "A String", # ETag of the resource. 276 "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. 277 "A String", 278 ], 279 "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is. 280 }, 281 ], 282 "etag": "A String", # ETag of the resource. 283 "kind": "admin#directory#resources#buildings#buildingsList", # Kind of resource this is. 284 "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. 285}</pre> 286</div> 287 288<div class="method"> 289 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 290 <pre>Retrieves the next page of results. 291 292Args: 293 previous_request: The request for the previous page. (required) 294 previous_response: The response from the request for the previous page. (required) 295 296Returns: 297 A request object that you can call 'execute()' on to request the next 298 page. Returns None if there are no more items in the collection. 299 </pre> 300</div> 301 302<div class="method"> 303 <code class="details" id="patch">patch(customer, buildingId, body=None, coordinatesSource=None, x__xgafv=None)</code> 304 <pre>Patches a building. 305 306Args: 307 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) 308 buildingId: string, The id of the building to update. (required) 309 body: object, The request body. 310 The object takes the form of: 311 312{ # Public API: Resources.buildings 313 "address": { # Public API: Resources.buildings # The postal address of the building. See [`PostalAddress`](/my-business/reference/rest/v4/PostalAddress) for details. Note that only a single address line and region code are required. 314 "addressLines": [ # Unstructured address lines describing the lower levels of an address. 315 "A String", 316 ], 317 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. 318 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). 319 "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. 320 "postalCode": "A String", # Optional. Postal code of the address. 321 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. 322 "sublocality": "A String", # Optional. Sublocality of the address. 323 }, 324 "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters. 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": { # Public API: Resources.buildings # 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 "description": "A String", # A brief description of the building. For example, "Chelsea Market". 331 "etags": "A String", # ETag of the resource. 332 "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. 333 "A String", 334 ], 335 "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is. 336} 337 338 coordinatesSource: string, Source from which Building.coordinates are derived. 339 Allowed values 340 CLIENT_SPECIFIED - Building.coordinates are set to the coordinates included in the request. 341 RESOLVED_FROM_ADDRESS - Building.coordinates are automatically populated based on the postal address. 342 SOURCE_UNSPECIFIED - Defaults to `RESOLVED_FROM_ADDRESS` if postal address is provided. Otherwise, defaults to `CLIENT_SPECIFIED` if coordinates are provided. 343 x__xgafv: string, V1 error format. 344 Allowed values 345 1 - v1 error format 346 2 - v2 error format 347 348Returns: 349 An object of the form: 350 351 { # Public API: Resources.buildings 352 "address": { # Public API: Resources.buildings # The postal address of the building. See [`PostalAddress`](/my-business/reference/rest/v4/PostalAddress) for details. Note that only a single address line and region code are required. 353 "addressLines": [ # Unstructured address lines describing the lower levels of an address. 354 "A String", 355 ], 356 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. 357 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). 358 "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. 359 "postalCode": "A String", # Optional. Postal code of the address. 360 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. 361 "sublocality": "A String", # Optional. Sublocality of the address. 362 }, 363 "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters. 364 "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. 365 "coordinates": { # Public API: Resources.buildings # The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees. 366 "latitude": 3.14, # Latitude in decimal degrees. 367 "longitude": 3.14, # Longitude in decimal degrees. 368 }, 369 "description": "A String", # A brief description of the building. For example, "Chelsea Market". 370 "etags": "A String", # ETag of the resource. 371 "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. 372 "A String", 373 ], 374 "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is. 375}</pre> 376</div> 377 378<div class="method"> 379 <code class="details" id="update">update(customer, buildingId, body=None, coordinatesSource=None, x__xgafv=None)</code> 380 <pre>Updates a building. 381 382Args: 383 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) 384 buildingId: string, The id of the building to update. (required) 385 body: object, The request body. 386 The object takes the form of: 387 388{ # Public API: Resources.buildings 389 "address": { # Public API: Resources.buildings # The postal address of the building. See [`PostalAddress`](/my-business/reference/rest/v4/PostalAddress) for details. Note that only a single address line and region code are required. 390 "addressLines": [ # Unstructured address lines describing the lower levels of an address. 391 "A String", 392 ], 393 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. 394 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). 395 "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. 396 "postalCode": "A String", # Optional. Postal code of the address. 397 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. 398 "sublocality": "A String", # Optional. Sublocality of the address. 399 }, 400 "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters. 401 "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. 402 "coordinates": { # Public API: Resources.buildings # The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees. 403 "latitude": 3.14, # Latitude in decimal degrees. 404 "longitude": 3.14, # Longitude in decimal degrees. 405 }, 406 "description": "A String", # A brief description of the building. For example, "Chelsea Market". 407 "etags": "A String", # ETag of the resource. 408 "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. 409 "A String", 410 ], 411 "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is. 412} 413 414 coordinatesSource: string, Source from which Building.coordinates are derived. 415 Allowed values 416 CLIENT_SPECIFIED - Building.coordinates are set to the coordinates included in the request. 417 RESOLVED_FROM_ADDRESS - Building.coordinates are automatically populated based on the postal address. 418 SOURCE_UNSPECIFIED - Defaults to `RESOLVED_FROM_ADDRESS` if postal address is provided. Otherwise, defaults to `CLIENT_SPECIFIED` if coordinates are provided. 419 x__xgafv: string, V1 error format. 420 Allowed values 421 1 - v1 error format 422 2 - v2 error format 423 424Returns: 425 An object of the form: 426 427 { # Public API: Resources.buildings 428 "address": { # Public API: Resources.buildings # The postal address of the building. See [`PostalAddress`](/my-business/reference/rest/v4/PostalAddress) for details. Note that only a single address line and region code are required. 429 "addressLines": [ # Unstructured address lines describing the lower levels of an address. 430 "A String", 431 ], 432 "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. 433 "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). 434 "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. 435 "postalCode": "A String", # Optional. Postal code of the address. 436 "regionCode": "A String", # Required. CLDR region code of the country/region of the address. 437 "sublocality": "A String", # Optional. Sublocality of the address. 438 }, 439 "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters. 440 "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. 441 "coordinates": { # Public API: Resources.buildings # The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees. 442 "latitude": 3.14, # Latitude in decimal degrees. 443 "longitude": 3.14, # Longitude in decimal degrees. 444 }, 445 "description": "A String", # A brief description of the building. For example, "Chelsea Market". 446 "etags": "A String", # ETag of the resource. 447 "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. 448 "A String", 449 ], 450 "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is. 451}</pre> 452</div> 453 454</body></html>