Freebusy: query

Возвращает информацию о занятости для набора календарей. Попробуйте сейчас .

Запрос

HTTP-запрос 

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

Авторизация

Этот запрос разрешает авторизацию хотя бы с одной из следующих областей:

Объем
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events.freebusy
https://www.googleapis.com/auth/calendar.freebusy

Дополнительную информацию см. на странице аутентификации и авторизации .

Тело запроса

В теле запроса укажите данные следующей структуры: 

{
  "timeMin": datetime,
  "timeMax": datetime,
  "timeZone": string,
  "groupExpansionMax": integer,
  "calendarExpansionMax": integer,
  "items": [
    {
      "id": string
    }
  ]
}
Имя свойства Ценить Описание Примечания
timeMin datetime Начало интервала запроса, отформатированного в соответствии с RFC3339 .
timeMax datetime Конец интервала запроса, отформатированного в соответствии с RFC3339 .
timeZone string Часовой пояс, использованный в ответе. Необязательный. По умолчанию используется UTC.
groupExpansionMax integer Максимальное количество идентификаторов календаря, предоставляемое для одной группы. Необязательный. Ошибка возвращается для группы, число членов которой превышает это значение. Максимальное значение — 100.
calendarExpansionMax integer Максимальное количество календарей, для которых должна быть предоставлена ​​информация FreeBusy. Необязательный. Максимальное значение — 50.
items[] list Список календарей и/или групп для запроса.
items[]. id string Идентификатор календаря или группы.

Ответ

В случае успеха этот метод возвращает тело ответа следующей структуры: 

{
  "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 Список идентификаторов календарей внутри группы.
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 (Эксклюзивное) окончание периода времени.

Попробуйте!

Используйте API-обозреватель ниже, чтобы вызвать этот метод для реальных данных и просмотреть ответ.