get(customer, buildingId, x__xgafv=None)

Retrieves a building.

Args:
  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)
  buildingId: string, The unique ID of the building to retrieve. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Public API: Resources.buildings
  "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.
    "addressLines": [ # Unstructured address lines describing the lower levels of an address.
      "A String",
    ],
    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
    "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.
    "postalCode": "A String", # Optional. Postal code of the address.
    "regionCode": "A String", # Required. CLDR region code of the country/region of the address.
    "sublocality": "A String", # Optional. Sublocality of the address.
  },
  "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters.
  "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": { # Public API: Resources.buildings # 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.
  },
  "description": "A String", # A brief description of the building. For example, "Chelsea Market".
  "etags": "A String", # ETag of the resource.
  "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",
  ],
  "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is.
}

insert(customer, body=None, coordinatesSource=None, x__xgafv=None)

Inserts a building.

Args:
  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)
  body: object, The request body.
    The object takes the form of:

{ # Public API: Resources.buildings
  "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.
    "addressLines": [ # Unstructured address lines describing the lower levels of an address.
      "A String",
    ],
    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
    "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.
    "postalCode": "A String", # Optional. Postal code of the address.
    "regionCode": "A String", # Required. CLDR region code of the country/region of the address.
    "sublocality": "A String", # Optional. Sublocality of the address.
  },
  "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters.
  "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": { # Public API: Resources.buildings # 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.
  },
  "description": "A String", # A brief description of the building. For example, "Chelsea Market".
  "etags": "A String", # ETag of the resource.
  "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",
  ],
  "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is.
}

  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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Public API: Resources.buildings
  "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.
    "addressLines": [ # Unstructured address lines describing the lower levels of an address.
      "A String",
    ],
    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
    "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.
    "postalCode": "A String", # Optional. Postal code of the address.
    "regionCode": "A String", # Required. CLDR region code of the country/region of the address.
    "sublocality": "A String", # Optional. Sublocality of the address.
  },
  "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters.
  "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": { # Public API: Resources.buildings # 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.
  },
  "description": "A String", # A brief description of the building. For example, "Chelsea Market".
  "etags": "A String", # ETag of the resource.
  "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",
  ],
  "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is.
}

list(customer, maxResults=None, pageToken=None, x__xgafv=None)

Retrieves a list of buildings for an account.

Args:
  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)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Token to specify the next page in the list.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Public API: Resources.buildings
  "buildings": [ # The Buildings in this page of results.
    { # Public API: Resources.buildings
      "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.
        "addressLines": [ # Unstructured address lines describing the lower levels of an address.
          "A String",
        ],
        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
        "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.
        "postalCode": "A String", # Optional. Postal code of the address.
        "regionCode": "A String", # Required. CLDR region code of the country/region of the address.
        "sublocality": "A String", # Optional. Sublocality of the address.
      },
      "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters.
      "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": { # Public API: Resources.buildings # 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.
      },
      "description": "A String", # A brief description of the building. For example, "Chelsea Market".
      "etags": "A String", # ETag of the resource.
      "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",
      ],
      "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is.
    },
  ],
  "etag": "A String", # ETag of the resource.
  "kind": "admin#directory#resources#buildings#buildingsList", # Kind of resource this is.
  "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.
}

list_next()

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.

patch(customer, buildingId, body=None, coordinatesSource=None, x__xgafv=None)

Patches a building.

Args:
  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)
  buildingId: string, The id of the building to update. (required)
  body: object, The request body.
    The object takes the form of:

{ # Public API: Resources.buildings
  "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.
    "addressLines": [ # Unstructured address lines describing the lower levels of an address.
      "A String",
    ],
    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
    "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.
    "postalCode": "A String", # Optional. Postal code of the address.
    "regionCode": "A String", # Required. CLDR region code of the country/region of the address.
    "sublocality": "A String", # Optional. Sublocality of the address.
  },
  "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters.
  "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": { # Public API: Resources.buildings # 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.
  },
  "description": "A String", # A brief description of the building. For example, "Chelsea Market".
  "etags": "A String", # ETag of the resource.
  "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",
  ],
  "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is.
}

  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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Public API: Resources.buildings
  "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.
    "addressLines": [ # Unstructured address lines describing the lower levels of an address.
      "A String",
    ],
    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
    "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.
    "postalCode": "A String", # Optional. Postal code of the address.
    "regionCode": "A String", # Required. CLDR region code of the country/region of the address.
    "sublocality": "A String", # Optional. Sublocality of the address.
  },
  "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters.
  "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": { # Public API: Resources.buildings # 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.
  },
  "description": "A String", # A brief description of the building. For example, "Chelsea Market".
  "etags": "A String", # ETag of the resource.
  "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",
  ],
  "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is.
}

update(customer, buildingId, body=None, coordinatesSource=None, x__xgafv=None)

Updates a building.

Args:
  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)
  buildingId: string, The id of the building to update. (required)
  body: object, The request body.
    The object takes the form of:

{ # Public API: Resources.buildings
  "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.
    "addressLines": [ # Unstructured address lines describing the lower levels of an address.
      "A String",
    ],
    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
    "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.
    "postalCode": "A String", # Optional. Postal code of the address.
    "regionCode": "A String", # Required. CLDR region code of the country/region of the address.
    "sublocality": "A String", # Optional. Sublocality of the address.
  },
  "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters.
  "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": { # Public API: Resources.buildings # 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.
  },
  "description": "A String", # A brief description of the building. For example, "Chelsea Market".
  "etags": "A String", # ETag of the resource.
  "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",
  ],
  "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is.
}

  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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Public API: Resources.buildings
  "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.
    "addressLines": [ # Unstructured address lines describing the lower levels of an address.
      "A String",
    ],
    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
    "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.
    "postalCode": "A String", # Optional. Postal code of the address.
    "regionCode": "A String", # Required. CLDR region code of the country/region of the address.
    "sublocality": "A String", # Optional. Sublocality of the address.
  },
  "buildingId": "A String", # Unique identifier for the building. The maximum length is 100 characters.
  "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": { # Public API: Resources.buildings # 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.
  },
  "description": "A String", # A brief description of the building. For example, "Chelsea Market".
  "etags": "A String", # ETag of the resource.
  "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",
  ],
  "kind": "admin#directory#resources#buildings#Building", # Kind of resource this is.
}

Admin SDK API . resources . buildings

Instance Methods

Method Details