Freebusy: query

注意： 這是選填授權。

傳回一組日曆的有空/忙碌資訊。 立即試用。

要求

HTTP 要求

POST https://www.googleapis.com/calendar/v3/freeBusy

授權

這項要求至少允許擁有下列其中一個範圍的授權：

範圍
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar

詳情請參閱「驗證與授權」網頁。

要求主體

在要求主體中，提供具有以下結構的資料：

{
  "timeMin": datetime,
  "timeMax": datetime,
  "timeZone": string,
  "groupExpansionMax": integer,
  "calendarExpansionMax": integer,
  "items": [
    {
      "id": string
    }
  ]
}

屬性名稱	值	說明	附註
timeMin	datetime	查詢間隔的開始時間，格式如下：RFC3339。
timeMax	datetime	查詢的間隔結尾，格式為 RFC3339。
timeZone	string	回應中使用的時區。選用設定。預設值為世界標準時間。
groupExpansionMax	integer	提供給單一群組的日曆 ID 數量上限。選用設定。如果群組的成員超過這個值，系統會傳回錯誤。最大值為 100。
calendarExpansionMax	integer	提供 FreeBusy 資訊的日曆數量上限。選用設定。最大值為 50。
items[]	list	要查詢的日曆和/或群組清單。
items[].id	string	日曆或群組的 ID。

回應

如果成功的話，這個方法會傳回回應內文，其結構如下：

{
  "kind": "calendar#freeBusy",
  "timeMin": datetime,
  "timeMax": datetime,
  "groups": {
    (key): {
      "errors": [
        {
          "domain": string,
          "reason": string
        }
      ],
      "calendars": [
        string
      ]
    }
  },
  "calendars": {
    (key): {
      "errors": [
        {
          "domain": string,
          "reason": string
        }
      ],
      "busy": [
        {
          "start": datetime,
          "end": datetime
        }
      ]
    }
  }
}

屬性名稱	值	說明	附註
kind	string	資源類型 (「calendar#freeBusy」)。
timeMin	datetime	間隔的開始時間。
timeMax	datetime	時間間隔的結束時間。
groups	object	擴充群組。
groups.(key)	nested object	群組成員的日曆清單。
groups.(key).errors[]	list	選用錯誤 (如果群組的運算失敗)。
groups.(key).errors[].domain	string	錯誤的網域或廣泛類別。
groups.(key).errors[].reason	string	錯誤具體原因。可能的值包括： 「groupTooBig」- 對單一查詢，所要求的使用者群組過大。 「tooManyCalendarsRequested」- 對於單一查詢，所要求的日曆數量過多。 「notFound」- 找不到要求的資源。 「internalError」- API 服務發生內部錯誤。 我們日後可能會新增更多錯誤類型，因此客戶應妥善處理未列於這份清單的其他錯誤狀態。
groups.(key).calendars[]	list	日曆清單或群組中的 ID
calendars	object	日曆的有空/忙碌資訊清單。
calendars.(key)	nested object	展開單一日曆的有空/忙碌狀態。
calendars.(key).errors[]	list	選用錯誤 (如果日曆運算失敗)。
calendars.(key).errors[].domain	string	錯誤的網域或廣泛類別。
calendars.(key).errors[].reason	string	錯誤具體原因。可能的值包括： 「groupTooBig」- 對單一查詢，所要求的使用者群組過大。 「tooManyCalendarsRequested」- 對於單一查詢，所要求的日曆數量過多。 「notFound」- 找不到要求的資源。 「internalError」- API 服務發生內部錯誤。 我們日後可能會新增更多錯誤類型，因此客戶應妥善處理未列於這份清單的其他錯誤狀態。
calendars.(key).busy[]	list	列出這份日曆處於忙碌狀態的時間範圍。
calendars.(key).busy[].start	datetime	時間範圍的開始時間 (含首尾)。
calendars.(key).busy[].end	datetime	時間範圍的結束時間 (不含)。

試試看！

使用下方的 APIs Explorer，針對即時資料呼叫這個方法，看看會有什麼結果。