REST Resource: resources.buildings

リソース: Building

公開 API: Resources.buildings

JSON 表現
{
  "buildingId": string,
  "buildingName": string,
  "description": string,
  "coordinates": {
    object (BuildingCoordinates)
  },
  "kind": string,
  "etags": string,
  "floorNames": [
    string
  ],
  "address": {
    object (BuildingAddress)
  }
}
フィールド
buildingId

string

建物の一意の識別子。最大で 100 文字です。

buildingName

string

カレンダーのユーザーに表示される建物の名前。お客様に対して一意である必要があります。例: 「NYC-CHEL」。最大で 100 文字です。

description

string

建物の簡単な説明。例: 「チェルシー マーケット」。

coordinates

object (BuildingCoordinates)

緯度と経度で表される 10 進数表記の建物の中心の地理座標。

kind

string

これはリソースの一種です。

etags

string

リソースの ETag。

floorNames[]

string

この建物のすべての階の表示名。各階は、最低階から最高階の昇順で表示されます。例: ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] には、少なくとも 1 つのエントリを含める必要があります。

address

object (BuildingAddress)

建物の住所。詳しくは、PostalAddress をご覧ください。住所と地域コードは 1 行のみ必要です。

BuildingCoordinates

公開 API: Resources.buildings

JSON 表現
{
  "latitude": number,
  "longitude": number
}
フィールド
latitude

number

10 進法の緯度。

longitude

number

10 進法の経度。

BuildingAddress

公開 API: Resources.buildings

JSON 表現
{
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ]
}
フィールド
regionCode

string

必須。住所の国/地域の CLDR リージョン コード。

languageCode

string

(省略可)この住所の内容の BCP-47 言語コード(わかっている場合)。

postalCode

string

(省略可)住所の郵便番号。

administrativeArea

string

(省略可)国または地域の住所の最上位の行政区域。

locality

string

(省略可)通常は住所の市区町村の部分を指します。たとえば、米国の市、イタリアのコムーネ、英国の郵便町名などがこれに該当します。地域区分が適切に定義されていないところや、この構造にうまく適合しない地域では、locality を空のままにして addressLines を使用してください。

sublocality

string

(省略可)住所の下位区分。

addressLines[]

string

構造化されていない住所の下位部分を記述する行。

Methods

delete

建物を削除します。

get

建物を取得します。

insert

建物を挿入します。

list

アカウントのビルディングのリストを取得します。

patch

建物にパッチを適用します。

update

建物を更新します。