Calendar Service

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Календарь

Эта служба позволяет сценарию получать доступ и изменять Календарь Google пользователя, включая дополнительные календари, на которые подписан пользователь.

Классы

Имя Краткое описание
Calendar Представляет календарь, которым владеет пользователь или на который он подписан.
CalendarApp Позволяет сценарию читать и обновлять Календарь Google пользователя.
CalendarEvent Представляет одно событие календаря.
CalendarEventSeries Представляет серию событий (повторяющееся событие).
Color Перечисление, представляющее именованные цвета, доступные в службе календаря.
EventColor Перечисление, представляющее цвета именованных событий, доступные в службе календаря.
EventGuest Представляет гостя мероприятия.
EventRecurrence Представляет параметры повторения для серии событий.
GuestStatus Перечисление, представляющее статусы, которые может иметь гость для события.
RecurrenceRule Представляет правило повторения для серии событий.
Visibility Перечисление, представляющее видимость события.

Calendar

Методы

Метод Тип возврата Краткое описание
createAllDayEvent(title, date) CalendarEvent Создает новое событие на весь день.
createAllDayEvent(title, startDate, endDate) CalendarEvent Создает новое событие на весь день.
createAllDayEvent(title, startDate, endDate, options) CalendarEvent Создает новое событие на весь день.
createAllDayEvent(title, date, options) CalendarEvent Создает новое событие на весь день.
createAllDayEventSeries(title, startDate, recurrence) CalendarEventSeries Создает новую серию событий на весь день.
createAllDayEventSeries(title, startDate, recurrence, options) CalendarEventSeries Создает новую серию событий на весь день.
createEvent(title, startTime, endTime) CalendarEvent Создает новое событие.
createEvent(title, startTime, endTime, options) CalendarEvent Создает новое событие.
createEventFromDescription(description) CalendarEvent Создает событие из описания в свободной форме.
createEventSeries(title, startTime, endTime, recurrence) CalendarEventSeries Создает новую серию событий.
createEventSeries(title, startTime, endTime, recurrence, options) CalendarEventSeries Создает новую серию событий.
deleteCalendar() void Безвозвратно удаляет календарь.
getColor() String Получает цвет календаря.
getDescription() String Получает описание календаря.
getEventById(iCalId) CalendarEvent Получает событие с заданным идентификатором.
getEventSeriesById(iCalId) CalendarEventSeries Получает серию событий с заданным идентификатором.
getEvents(startTime, endTime) CalendarEvent[] Получает все события, происходящие в заданном временном диапазоне.
getEvents(startTime, endTime, options) CalendarEvent[] Получает все события, происходящие в заданном временном диапазоне и соответствующие заданным критериям.
getEventsForDay(date) CalendarEvent[] Получает все события, происходящие в заданный день.
getEventsForDay(date, options) CalendarEvent[] Получает все события, происходящие в заданный день и соответствующие заданным критериям.
getId() String Получает идентификатор календаря.
getName() String Получает имя календаря.
getTimeZone() String Получает часовой пояс календаря.
isHidden() Boolean Определяет, скрыт ли календарь в пользовательском интерфейсе.
isMyPrimaryCalendar() Boolean Определяет, является ли календарь календарем по умолчанию для действующего пользователя.
isOwnedByMe() Boolean Определяет, принадлежит ли календарь действующему пользователю.
isSelected() Boolean Определяет, отображаются ли события календаря в пользовательском интерфейсе.
setColor(color) Calendar Устанавливает цвет календаря.
setDescription(description) Calendar Устанавливает описание календаря.
setHidden(hidden) Calendar Устанавливает, отображается ли календарь в пользовательском интерфейсе.
setName(name) Calendar Устанавливает имя календаря.
setSelected(selected) Calendar Устанавливает, будут ли события календаря отображаться в пользовательском интерфейсе.
setTimeZone(timeZone) Calendar Устанавливает часовой пояс календаря.
unsubscribeFromCalendar() void Отписывает пользователя от календаря.

CalendarApp

Характеристики

Имущество Тип Описание
Color Color Перечисление, представляющее именованные цвета, доступные в службе календаря.
EventColor EventColor Перечисление, представляющее цвета именованных событий, доступные в службе календаря.
GuestStatus GuestStatus Перечисление, представляющее статусы, которые может иметь гость для события.
Month Month Перечисление, представляющее месяцы года.
Visibility Visibility Перечисление, представляющее видимость события.
Weekday Weekday Перечисление, представляющее дни недели.

Методы

Метод Тип возврата Краткое описание
createAllDayEvent(title, date) CalendarEvent Создает новое событие на весь день.
createAllDayEvent(title, startDate, endDate) CalendarEvent Создает новое событие на весь день.
createAllDayEvent(title, startDate, endDate, options) CalendarEvent Создает новое событие на весь день.
createAllDayEvent(title, date, options) CalendarEvent Создает новое событие на весь день.
createAllDayEventSeries(title, startDate, recurrence) CalendarEventSeries Создает новую серию событий на весь день.
createAllDayEventSeries(title, startDate, recurrence, options) CalendarEventSeries Создает новую серию событий на весь день.
createCalendar(name) Calendar Создает новый календарь, принадлежащий пользователю.
createCalendar(name, options) Calendar Создает новый календарь, принадлежащий пользователю.
createEvent(title, startTime, endTime) CalendarEvent Создает новое событие.
createEvent(title, startTime, endTime, options) CalendarEvent Создает новое событие.
createEventFromDescription(description) CalendarEvent Создает событие из описания в свободной форме.
createEventSeries(title, startTime, endTime, recurrence) CalendarEventSeries Создает новую серию событий.
createEventSeries(title, startTime, endTime, recurrence, options) CalendarEventSeries Создает новую серию событий.
getAllCalendars() Calendar[] Получает все календари, которыми владеет пользователь или на которые он подписан.
getAllOwnedCalendars() Calendar[] Получает все календари, которыми владеет пользователь.
getCalendarById(id) Calendar Получает календарь с заданным идентификатором.
getCalendarsByName(name) Calendar[] Получает все календари с заданным именем, которыми владеет пользователь или на которые он подписан.
getColor() String Получает цвет календаря.
getDefaultCalendar() Calendar Получает календарь пользователя по умолчанию.
getDescription() String Получает описание календаря.
getEventById(iCalId) CalendarEvent Получает событие с заданным идентификатором.
getEventSeriesById(iCalId) CalendarEventSeries Получает серию событий с заданным идентификатором.
getEvents(startTime, endTime) CalendarEvent[] Получает все события, происходящие в заданном временном диапазоне.
getEvents(startTime, endTime, options) CalendarEvent[] Получает все события, происходящие в заданном временном диапазоне и соответствующие заданным критериям.
getEventsForDay(date) CalendarEvent[] Получает все события, происходящие в заданный день.
getEventsForDay(date, options) CalendarEvent[] Получает все события, происходящие в заданный день и соответствующие заданным критериям.
getId() String Получает идентификатор календаря.
getName() String Получает имя календаря.
getOwnedCalendarById(id) Calendar Получает календарь с заданным идентификатором, если он принадлежит пользователю.
getOwnedCalendarsByName(name) Calendar[] Получает все календари с заданным именем, которыми владеет пользователь.
getTimeZone() String Получает часовой пояс календаря.
isHidden() Boolean Определяет, скрыт ли календарь в пользовательском интерфейсе.
isMyPrimaryCalendar() Boolean Определяет, является ли календарь календарем по умолчанию для действующего пользователя.
isOwnedByMe() Boolean Определяет, принадлежит ли календарь действующему пользователю.
isSelected() Boolean Определяет, отображаются ли события календаря в пользовательском интерфейсе.
newRecurrence() EventRecurrence Создает новый объект повторения, который можно использовать для создания правил повторения событий.
setColor(color) Calendar Устанавливает цвет календаря.
setDescription(description) Calendar Устанавливает описание календаря.
setHidden(hidden) Calendar Устанавливает, отображается ли календарь в пользовательском интерфейсе.
setName(name) Calendar Устанавливает имя календаря.
setSelected(selected) Calendar Устанавливает, будут ли события календаря отображаться в пользовательском интерфейсе.
setTimeZone(timeZone) Calendar Устанавливает часовой пояс календаря.
subscribeToCalendar(id) Calendar Подписывает пользователя на календарь с заданным идентификатором, если пользователю разрешена подписка.
subscribeToCalendar(id, options) Calendar Подписывает пользователя на календарь с заданным идентификатором, если пользователю разрешена подписка.

CalendarEvent

Методы

Метод Тип возврата Краткое описание
addEmailReminder(minutesBefore) CalendarEvent Добавляет к событию новое напоминание по электронной почте.
addGuest(email) CalendarEvent Добавляет гостя на мероприятие.
addPopupReminder(minutesBefore) CalendarEvent Добавляет новое всплывающее напоминание к событию.
addSmsReminder(minutesBefore) CalendarEvent Добавляет к событию новое SMS-напоминание.
anyoneCanAddSelf() Boolean Определяет, может ли кто-либо пригласить себя.
deleteEvent() void Удаляет событие.
deleteTag(key) CalendarEvent Удаляет тег ключ/значение из события.
getAllDayEndDate() Date Получает дату окончания этого события календаря на весь день.
getAllDayStartDate() Date Получает дату начала этого события календаря на весь день.
getAllTagKeys() String[] Получает все ключи для тегов, которые были установлены для события.
getColor() String Возвращает цвет события календаря.
getCreators() String[] Получает создатели события.
getDateCreated() Date Получает дату создания события.
getDescription() String Получает описание события.
getEmailReminders() Integer[] Получает значения минут для всех напоминаний по электронной почте для события.
getEndTime() Date Получает дату и время окончания этого события календаря.
getEventSeries() CalendarEventSeries Получает серию повторяющихся событий, к которым принадлежит это событие.
getGuestByEmail(email) EventGuest Получает гостя по адресу электронной почты.
getGuestList() EventGuest[] Получает гостей для события, не включая владельца события.
getGuestList(includeOwner) EventGuest[] Получает гостей для мероприятия, потенциально включая владельцев мероприятия.
getId() String Получает уникальный iCalUID события.
getLastUpdated() Date Получает дату последнего обновления события.
getLocation() String Получает местоположение события.
getMyStatus() GuestStatus Получает статус события (посещение и т. д.) действующего пользователя.
getOriginalCalendarId() String Получите идентификатор календаря, в котором изначально было создано это событие.
getPopupReminders() Integer[] Получает значения минут для всех всплывающих напоминаний о событии.
getSmsReminders() Integer[] Получает значения минут для всех SMS-напоминаний о событии.
getStartTime() Date Получает дату и время начала этого события календаря.
getTag(key) String Получает значение тега события.
getTitle() String Получает название события.
getVisibility() Visibility Получает видимость события.
guestsCanInviteOthers() Boolean Определяет, могут ли гости приглашать других гостей.
guestsCanModify() Boolean Определяет, могут ли гости изменять событие.
guestsCanSeeGuests() Boolean Определяет, могут ли гости видеть других гостей.
isAllDayEvent() Boolean Определяет, является ли это событием на весь день.
isOwnedByMe() Boolean Определяет, принадлежит ли событие действующему пользователю.
isRecurringEvent() Boolean Определяет, является ли событие частью серии событий.
removeAllReminders() CalendarEvent Удаляет все напоминания о событии.
removeGuest(email) CalendarEvent Удаляет гостя с мероприятия.
resetRemindersToDefault() CalendarEvent Сбрасывает напоминания, используя настройки календаря по умолчанию.
setAllDayDate(date) CalendarEvent Устанавливает дату события.
setAllDayDates(startDate, endDate) CalendarEvent Устанавливает даты события.
setAnyoneCanAddSelf(anyoneCanAddSelf) CalendarEvent Устанавливает, могут ли не гости добавлять себя к событию.
setColor(color) CalendarEvent Устанавливает цвет события календаря.
setDescription(description) CalendarEvent Устанавливает описание события.
setGuestsCanInviteOthers(guestsCanInviteOthers) CalendarEvent Устанавливает, могут ли гости приглашать других гостей.
setGuestsCanModify(guestsCanModify) CalendarEvent Устанавливает, могут ли гости изменять мероприятие.
setGuestsCanSeeGuests(guestsCanSeeGuests) CalendarEvent Устанавливает, могут ли гости видеть других гостей.
setLocation(location) CalendarEvent Устанавливает место события.
setMyStatus(status) CalendarEvent Устанавливает статус события (посещение и т. д.) действующего пользователя.
setTag(key, value) CalendarEvent Устанавливает тег ключ/значение для события для хранения пользовательских метаданных.
setTime(startTime, endTime) CalendarEvent Устанавливает даты и время начала и окончания события.
setTitle(title) CalendarEvent Устанавливает заголовок события.
setVisibility(visibility) CalendarEvent Устанавливает видимость события.

CalendarEventSeries

Методы

Метод Тип возврата Краткое описание
addEmailReminder(minutesBefore) CalendarEventSeries Добавляет к событию новое напоминание по электронной почте.
addGuest(email) CalendarEventSeries Добавляет гостя на мероприятие.
addPopupReminder(minutesBefore) CalendarEventSeries Добавляет новое всплывающее напоминание к событию.
addSmsReminder(minutesBefore) CalendarEventSeries Добавляет к событию новое SMS-напоминание.
anyoneCanAddSelf() Boolean Определяет, может ли кто-либо пригласить себя.
deleteEventSeries() void Удаляет серию событий.
deleteTag(key) CalendarEventSeries Удаляет тег ключ/значение из события.
getAllTagKeys() String[] Получает все ключи для тегов, которые были установлены для события.
getColor() String Возвращает цвет события календаря.
getCreators() String[] Получает создатели события.
getDateCreated() Date Получает дату создания события.
getDescription() String Получает описание события.
getEmailReminders() Integer[] Получает значения минут для всех напоминаний по электронной почте для события.
getGuestByEmail(email) EventGuest Получает гостя по адресу электронной почты.
getGuestList() EventGuest[] Получает гостей для события, не включая владельца события.
getGuestList(includeOwner) EventGuest[] Получает гостей для мероприятия, потенциально включая владельцев мероприятия.
getId() String Получает уникальный iCalUID события.
getLastUpdated() Date Получает дату последнего обновления события.
getLocation() String Получает местоположение события.
getMyStatus() GuestStatus Получает статус события (посещение и т. д.) действующего пользователя.
getOriginalCalendarId() String Получите идентификатор календаря, в котором изначально было создано это событие.
getPopupReminders() Integer[] Получает значения минут для всех всплывающих напоминаний о событии.
getSmsReminders() Integer[] Получает значения минут для всех SMS-напоминаний о событии.
getTag(key) String Получает значение тега события.
getTitle() String Получает название события.
getVisibility() Visibility Получает видимость события.
guestsCanInviteOthers() Boolean Определяет, могут ли гости приглашать других гостей.
guestsCanModify() Boolean Определяет, могут ли гости изменять событие.
guestsCanSeeGuests() Boolean Определяет, могут ли гости видеть других гостей.
isOwnedByMe() Boolean Определяет, принадлежит ли событие действующему пользователю.
removeAllReminders() CalendarEventSeries Удаляет все напоминания о событии.
removeGuest(email) CalendarEventSeries Удаляет гостя с мероприятия.
resetRemindersToDefault() CalendarEventSeries Сбрасывает напоминания, используя настройки календаря по умолчанию.
setAnyoneCanAddSelf(anyoneCanAddSelf) CalendarEventSeries Устанавливает, могут ли не гости добавлять себя к событию.
setColor(color) CalendarEventSeries Устанавливает цвет события календаря.
setDescription(description) CalendarEventSeries Устанавливает описание события.
setGuestsCanInviteOthers(guestsCanInviteOthers) CalendarEventSeries Устанавливает, могут ли гости приглашать других гостей.
setGuestsCanModify(guestsCanModify) CalendarEventSeries Устанавливает, могут ли гости изменять мероприятие.
setGuestsCanSeeGuests(guestsCanSeeGuests) CalendarEventSeries Устанавливает, могут ли гости видеть других гостей.
setLocation(location) CalendarEventSeries Устанавливает место события.
setMyStatus(status) CalendarEventSeries Устанавливает статус события (посещение и т. д.) действующего пользователя.
setRecurrence(recurrence, startDate) CalendarEventSeries Задает правила повторения для серии событий на весь день.
setRecurrence(recurrence, startTime, endTime) CalendarEventSeries Задает правила повторения для этой серии событий.
setTag(key, value) CalendarEventSeries Устанавливает тег ключ/значение для события для хранения пользовательских метаданных.
setTitle(title) CalendarEventSeries Устанавливает заголовок события.
setVisibility(visibility) CalendarEventSeries Устанавливает видимость события.

Color

Характеристики

Имущество Тип Описание
BLUE Enum
Синий ( #2952A3 ).
BROWN Enum
Браун ( #8D6F47 ).
CHARCOAL Enum
Древесный уголь ( #4E5D6C ).
CHESTNUT Enum
Каштан ( #865A5A ).
GRAY Enum
Серый ( #5A6986 ).
GREEN Enum
Зеленый ( #0D7813 ).
INDIGO Enum
Индиго ( #5229A3 ).
LIME Enum
Лайм ( #528800 ).
MUSTARD Enum
Горчица ( #88880E ).
OLIVE Enum
Оливковое ( #6E6E41 ).
ORANGE Enum
Оранжевый ( #BE6D00 ).
PINK Enum
Розовый ( #B1365F ).
PLUM Enum
Слива ( #705770 ).
PURPLE Enum
Фиолетовый ( #7A367A ).
RED Enum
Красный ( #A32929 ).
RED_ORANGE Enum
Красно-оранжевый ( #B1440E ).
SEA_BLUE Enum
Морская лазурь ( #29527A ).
SLATE Enum
Сланец ( #4A716C ).
TEAL Enum
Бирюзовый ( #28754E ).
TURQOISE Enum
Бирюзовый ( #1B887A ).
YELLOW Enum
Желтый ( #AB8B00 ).

EventColor

Характеристики

Имущество Тип Описание
PALE_BLUE Enum
Бледно-голубой ( "1" ).
PALE_GREEN Enum
Бледно-зеленый ( "2" ).
MAUVE Enum
Лиловый ( "3" ).
PALE_RED Enum
Бледно-красный ( "4" ).
YELLOW Enum
Желтый ( "5" ).
ORANGE Enum
Оранжевый ( "6" ).
CYAN Enum
Голубой ( "7" ).
GRAY Enum
Серый ( "8" ).
BLUE Enum
Синий ( "9" ).
GREEN Enum
Зеленый ( "10" ).
RED Enum
Красный ( "11" ).

EventGuest

Методы

Метод Тип возврата Краткое описание
getAdditionalGuests() Integer Получает количество дополнительных людей, которых, по словам этого гостя, посещают.
getEmail() String Получает адрес электронной почты гостя.
getGuestStatus() GuestStatus Получает статус гостя на мероприятии.
getName() String Получает имя гостя.

EventRecurrence

Методы

Метод Тип возврата Краткое описание
addDailyExclusion() RecurrenceRule Добавляет правило, исключающее вхождения на ежедневной основе.
addDailyRule() RecurrenceRule Добавляет правило, которое заставляет событие повторяться ежедневно.
addDate(date) EventRecurrence Добавляет правило, по которому событие повторяется в определенную дату.
addDateExclusion(date) EventRecurrence Добавляет правило, исключающее вхождение на определенную дату.
addMonthlyExclusion() RecurrenceRule Добавляет правило, исключающее вхождения ежемесячно.
addMonthlyRule() RecurrenceRule Добавляет правило, по которому событие повторяется ежемесячно.
addWeeklyExclusion() RecurrenceRule Добавляет правило, исключающее вхождения на еженедельной основе.
addWeeklyRule() RecurrenceRule Добавляет правило, по которому событие повторяется еженедельно.
addYearlyExclusion() RecurrenceRule Добавляет правило, исключающее вхождения на ежегодной основе.
addYearlyRule() RecurrenceRule Добавляет правило, которое вызывает ежегодное повторение события.
setTimeZone(timeZone) EventRecurrence Устанавливает часовой пояс для этого повторения.

GuestStatus

Характеристики

Имущество Тип Описание
INVITED Enum Гость был приглашен, но не указал, присутствует ли он.
MAYBE Enum Гость указал, что они могут присутствовать.
NO Enum Гость указал, что не приедет.
OWNER Enum Гость является владельцем мероприятия.
YES Enum Гость указал, что они присутствуют.

RecurrenceRule

Методы

Метод Тип возврата Краткое описание
addDailyExclusion() RecurrenceRule Добавляет правило, исключающее вхождения на ежедневной основе.
addDailyRule() RecurrenceRule Добавляет правило, которое заставляет событие повторяться ежедневно.
addDate(date) EventRecurrence Добавляет правило, по которому событие повторяется в определенную дату.
addDateExclusion(date) EventRecurrence Добавляет правило, исключающее вхождение на определенную дату.
addMonthlyExclusion() RecurrenceRule Добавляет правило, исключающее вхождения ежемесячно.
addMonthlyRule() RecurrenceRule Добавляет правило, по которому событие повторяется ежемесячно.
addWeeklyExclusion() RecurrenceRule Добавляет правило, исключающее вхождения на еженедельной основе.
addWeeklyRule() RecurrenceRule Добавляет правило, по которому событие повторяется еженедельно.
addYearlyExclusion() RecurrenceRule Добавляет правило, исключающее вхождения на ежегодной основе.
addYearlyRule() RecurrenceRule Добавляет правило, которое вызывает ежегодное повторение события.
interval(interval) RecurrenceRule Настраивает правило для применения только в этот интервал единицы времени правила.
onlyInMonth(month) RecurrenceRule Настраивает правило так, чтобы оно применялось только к определенному месяцу.
onlyInMonths(months) RecurrenceRule Настраивает правило так, чтобы оно применялось только к определенным месяцам.
onlyOnMonthDay(day) RecurrenceRule Настраивает правило для применения только к определенному дню месяца.
onlyOnMonthDays(days) RecurrenceRule Настраивает правило так, чтобы оно применялось только к определенным дням месяца.
onlyOnWeek(week) RecurrenceRule Настраивает правило так, чтобы оно применялось только к определенной неделе года.
onlyOnWeekday(day) RecurrenceRule Настраивает правило для применения только к определенному дню недели.
onlyOnWeekdays(days) RecurrenceRule Настраивает правило так, чтобы оно применялось только к определенным дням недели.
onlyOnWeeks(weeks) RecurrenceRule Настраивает правило так, чтобы оно применялось только к определенным неделям года.
onlyOnYearDay(day) RecurrenceRule Настраивает правило так, чтобы оно применялось только к определенному дню в году.
onlyOnYearDays(days) RecurrenceRule Настраивает правило так, чтобы оно применялось только к определенным дням в году.
setTimeZone(timeZone) EventRecurrence Устанавливает часовой пояс для этого повторения.
times(times) RecurrenceRule Настраивает действие правила на завершение после заданного количества повторений.
until(endDate) RecurrenceRule Настраивает действие правила так, чтобы оно заканчивалось в заданную дату (включительно).
weekStartsOn(day) RecurrenceRule Настраивает, с какого дня начинается неделя, для целей применения правила.

Visibility

Характеристики

Имущество Тип Описание
CONFIDENTIAL Enum Мероприятие является частным.
DEFAULT Enum Использует видимость по умолчанию для событий в календаре.
PRIVATE Enum Мероприятие является закрытым, и только его участники могут просматривать сведения о мероприятии.
PUBLIC Enum Событие является общедоступным, и сведения о событии видны всем читателям календаря.