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 Мероприятие является общедоступным, и подробности о нем видны всем читателям календаря.