Позволяет сценарию читать и обновлять Календарь Google пользователя. Этот класс обеспечивает прямой доступ к календарю пользователя по умолчанию, а также возможность получения дополнительных календарей, которыми владеет пользователь или на которые он подписан.
Характеристики
Имущество | Тип | Описание |
---|---|---|
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 | Подписывает пользователя на календарь с заданным идентификатором, если пользователю разрешена подписка. |
Подробная документация
createAllDayEvent(title, date)
Создает новое событие на весь день.
// Creates an all-day event for the moon landing and logs the ID. var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Apollo 11 Landing', new Date('July 20, 1969')); Logger.log('Event ID: ' + event.getId());
Параметры
Имя | Тип | Описание |
---|---|---|
title | String | название мероприятия |
date | Date | дата события (используется только день, время игнорируется) |
Возвращаться
CalendarEvent
— созданное событие
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, startDate, endDate)
Создает новое событие на весь день.
// Creates an all-day event for the Woodstock festival (August 15th to 17th) and logs the ID. var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Woodstock Festival', new Date('August 15, 1969'), new Date('August 18, 1969')); Logger.log('Event ID: ' + event.getId());
Параметры
Имя | Тип | Описание |
---|---|---|
title | String | название мероприятия |
startDate | Date | дата начала события (используется только день, время игнорируется) |
endDate | Date | дата окончания события (используется только день, время игнорируется) |
Возвращаться
CalendarEvent
— созданное событие
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, startDate, endDate, options)
Создает новое событие на весь день.
// Creates an all-day event for the Woodstock festival (August 15th to 17th) and logs the ID. var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Woodstock Festival', new Date('August 15, 1969'), new Date('August 18, 1969'), {location: 'Bethel, White Lake, New York, U.S.', sendInvites: true}); Logger.log('Event ID: ' + event.getId());
Параметры
Имя | Тип | Описание |
---|---|---|
title | String | название мероприятия |
startDate | Date | дата начала события (используется только день, время игнорируется) |
endDate | Date | дата окончания события (используется только день, время игнорируется) |
options | Object | объект JavaScript, который указывает расширенные параметры, как указано ниже |
Расширенные параметры
Имя | Тип | Описание |
---|---|---|
description | String | описание события |
location | String | место проведения |
guests | String | разделенный запятыми список адресов электронной почты, которые следует добавить в качестве гостей |
sendInvites | Boolean | отправлять ли приглашения по электронной почте (по умолчанию: false ) |
Возвращаться
CalendarEvent
— созданное событие
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, date, options)
Создает новое событие на весь день.
// Creates an all-day event for the moon landing and logs the ID. var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Apollo 11 Landing', new Date('July 20, 1969'), {location: 'The Moon'}); Logger.log('Event ID: ' + event.getId());
Параметры
Имя | Тип | Описание |
---|---|---|
title | String | название мероприятия |
date | Date | дата события (используется только день, время игнорируется) |
options | Object | объект JavaScript, который указывает расширенные параметры, как указано ниже |
Расширенные параметры
Имя | Тип | Описание |
---|---|---|
description | String | описание события |
location | String | место проведения |
guests | String | разделенный запятыми список адресов электронной почты, которые следует добавить в качестве гостей |
sendInvites | Boolean | отправлять ли приглашения по электронной почте (по умолчанию: false ) |
Возвращаться
CalendarEvent
— созданное событие
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEventSeries(title, startDate, recurrence)
Создает новую серию событий на весь день.
// Creates an event series for a no-meetings day, taking place every Wednesday in 2013. var eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries('No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014'))); Logger.log('Event Series ID: ' + eventSeries.getId());
Параметры
Имя | Тип | Описание |
---|---|---|
title | String | название событий в сериале |
startDate | Date | дата первого события в серии (используется только день, время игнорируется) |
recurrence | EventRecurrence | настройки повторения серии событий |
Возвращаться
CalendarEventSeries
— созданная серия событий
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEventSeries(title, startDate, recurrence, options)
Создает новую серию событий на весь день.
// Creates an event series for a no-meetings day, taking place every Wednesday in 2013. var eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries('No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014')), {guests: 'everyone@example.com'}); Logger.log('Event Series ID: ' + eventSeries.getId());
Параметры
Имя | Тип | Описание |
---|---|---|
title | String | название событий в сериале |
startDate | Date | дата первого события в серии (используется только день, время игнорируется) |
recurrence | EventRecurrence | настройки повторения серии событий |
options | Object | объект JavaScript, который указывает расширенные параметры, как указано ниже |
Расширенные параметры
Имя | Тип | Описание |
---|---|---|
description | String | описание событий в сериале |
location | String | место событий в сериале |
guests | String | разделенный запятыми список адресов электронной почты, которые должны быть добавлены в качестве гостей на события в серии |
sendInvites | Boolean | отправлять ли приглашения по электронной почте (по умолчанию: false ) |
Возвращаться
CalendarEventSeries
— созданная серия событий
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createCalendar(name)
Создает новый календарь, принадлежащий пользователю.
// Creates a new calendar named "Travel Plans". var calendar = CalendarApp.createCalendar('Travel Plans'); Logger.log('Created the calendar "%s", with the ID "%s".', calendar.getName(), calendar.getId());
Параметры
Имя | Тип | Описание |
---|---|---|
name | String | название нового календаря |
Возвращаться
Calendar
— только что созданный календарь
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createCalendar(name, options)
Создает новый календарь, принадлежащий пользователю.
// Creates a new calendar named "Travel Plans" with a summary and color. var calendar = CalendarApp.createCalendar('Travel Plans', { summary: 'A calendar to plan my travel schedule.', color: CalendarApp.Color.BLUE }); Logger.log('Created the calendar "%s", with the ID "%s".', calendar.getName(), calendar.getId());
Параметры
Имя | Тип | Описание |
---|---|---|
name | String | название нового календаря |
options | Object | объект JavaScript, который указывает расширенные параметры, как указано ниже |
Расширенные параметры
Имя | Тип | Описание |
---|---|---|
location | String | местоположение календаря |
summary | String | описание календаря |
timeZone | String | часовой пояс для установки календаря, указанный в «длинном» формате (например, «Америка/Нью-Йорк», как указано на Joda.org ) |
color | String | шестнадцатеричная строка цвета ("#rrggbb") или значение из CalendarApp.Colors |
hidden | Boolean | скрыт ли календарь в пользовательском интерфейсе (по умолчанию: false ) |
selected | Boolean | отображаются ли события календаря в пользовательском интерфейсе (по умолчанию: true ) |
Возвращаться
Calendar
— только что созданный календарь
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEvent(title, startTime, endTime)
Создает новое событие.
Если часовой пояс не указан, значения времени интерпретируются в контексте часового пояса скрипта, который может отличаться от часового пояса календаря.
// Creates an event for the moon landing and logs the ID. var event = CalendarApp.getDefaultCalendar().createEvent('Apollo 11 Landing', new Date('July 20, 1969 20:00:00 UTC'), new Date('July 21, 1969 21:00:00 UTC')); Logger.log('Event ID: ' + event.getId());
Параметры
Имя | Тип | Описание |
---|---|---|
title | String | название мероприятия |
startTime | Date | дата и время начала мероприятия |
endTime | Date | дата и время окончания мероприятия |
Возвращаться
CalendarEvent
— созданное событие
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEvent(title, startTime, endTime, options)
Создает новое событие.
Если часовой пояс не указан, значения времени интерпретируются в контексте часового пояса скрипта, который может отличаться от часового пояса календаря.
// Creates an event for the moon landing and logs the ID. var event = CalendarApp.getDefaultCalendar().createEvent('Apollo 11 Landing', new Date('July 20, 1969 20:00:00 UTC'), new Date('July 20, 1969 21:00:00 UTC'), {location: 'The Moon'}); Logger.log('Event ID: ' + event.getId());
Параметры
Имя | Тип | Описание |
---|---|---|
title | String | название мероприятия |
startTime | Date | дата и время начала мероприятия |
endTime | Date | дата и время окончания мероприятия |
options | Object | объект JavaScript, который указывает расширенные параметры, как указано ниже |
Расширенные параметры
Имя | Тип | Описание |
---|---|---|
description | String | описание события |
location | String | место проведения |
guests | String | разделенный запятыми список адресов электронной почты, которые следует добавить в качестве гостей |
sendInvites | Boolean | отправлять ли приглашения по электронной почте (по умолчанию: false ) |
Возвращаться
CalendarEvent
— созданное событие
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventFromDescription(description)
Создает событие из описания в свободной форме.
Описание должно иметь тот же формат, что и функция «Быстрое добавление» пользовательского интерфейса.
// Creates a new event and logs its ID. var event = CalendarApp.getDefaultCalendar() .createEventFromDescription('Lunch with Mary, Friday at 1PM'); Logger.log('Event ID: ' + event.getId());
Параметры
Имя | Тип | Описание |
---|---|---|
description | String | описание события в свободной форме |
Возвращаться
CalendarEvent
— созданное событие
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventSeries(title, startTime, endTime, recurrence)
Создает новую серию событий.
// Creates an event series for a team meeting, taking place every Tuesday and Thursday in 2013. var eventSeries = CalendarApp.getDefaultCalendar().createEventSeries('Team Meeting', new Date('January 1, 2013 03:00:00 PM EST'), new Date('January 1, 2013 04:00:00 PM EST'), CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekdays([CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY]) .until(new Date('January 1, 2014'))); Logger.log('Event Series ID: ' + eventSeries.getId());
Параметры
Имя | Тип | Описание |
---|---|---|
title | String | название событий в сериале |
startTime | Date | дата и время начала первого события в серии |
endTime | Date | дата и время окончания первого события в серии |
recurrence | EventRecurrence | настройки повторения серии событий |
Возвращаться
CalendarEventSeries
— созданная серия событий
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventSeries(title, startTime, endTime, recurrence, options)
Создает новую серию событий.
// Creates an event series for a team meeting, taking place every Tuesday and Thursday in 2013. var eventSeries = CalendarApp.getDefaultCalendar().createEventSeries('Team Meeting', new Date('January 1, 2013 03:00:00 PM EST'), new Date('January 1, 2013 04:00:00 PM EST'), CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekdays([CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY]) .until(new Date('January 1, 2014')), {location: 'Conference Room'}); Logger.log('Event Series ID: ' + eventSeries.getId());
Параметры
Имя | Тип | Описание |
---|---|---|
title | String | название событий в сериале |
startTime | Date | дата и время начала первого события в серии |
endTime | Date | дата и время окончания первого события в серии |
recurrence | EventRecurrence | настройки повторения серии событий |
options | Object | объект JavaScript, который указывает расширенные параметры, как указано ниже |
Расширенные параметры
Имя | Тип | Описание |
---|---|---|
description | String | описание событий в сериале |
location | String | место событий в сериале |
guests | String | разделенный запятыми список адресов электронной почты, которые должны быть добавлены в качестве гостей на события в серии |
sendInvites | Boolean | отправлять ли приглашения по электронной почте (по умолчанию: false ) |
Возвращаться
CalendarEventSeries
— созданная серия событий
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
getAllCalendars()
Получает все календари, которыми владеет пользователь или на которые он подписан.
// Determines how many calendars the user can access. var calendars = CalendarApp.getAllCalendars(); Logger.log('This user owns or is subscribed to %s calendars.', calendars.length);
Возвращаться
Calendar[]
— все календари, к которым у пользователя есть доступ.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getAllOwnedCalendars()
Получает все календари, которыми владеет пользователь.
// Determines how many calendars the user owns. var calendars = CalendarApp.getAllOwnedCalendars(); Logger.log('This user owns %s calendars.', calendars.length);
Возвращаться
Calendar[]
— все календари, которыми владеет пользователь
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getCalendarById(id)
Получает календарь с заданным идентификатором.
// Gets the public calendar "US Holidays" by ID. var calendar = CalendarApp.getCalendarById( 'en.usa#holiday@group.v.calendar.google.com'); Logger.log('The calendar is named "%s".', calendar.getName());
Параметры
Имя | Тип | Описание |
---|---|---|
id | String | идентификатор календаря |
Возвращаться
Calendar
— календарь с заданным идентификатором или null
, если календарь не существует, если пользователь не может получить к нему доступ или если пользователь не подписан на календарь.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getCalendarsByName(name)
Получает все календари с заданным именем, которыми владеет пользователь или на которые он подписан. Имена не чувствительны к регистру.
// Gets the public calendar named "US Holidays". var calendars = CalendarApp.getCalendarsByName('US Holidays'); Logger.log('Found %s matching calendars.', calendars.length);
Параметры
Имя | Тип | Описание |
---|---|---|
name | String | название календаря |
Возвращаться
Calendar[]
— все календари с таким названием, к которым у пользователя есть доступ.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getColor()
Получает цвет календаря.
Возвращаться
String
— шестнадцатеричная строка цвета ("#rrggbb").
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getDefaultCalendar()
Получает календарь пользователя по умолчанию.
// Determines the time zone of the user's default calendar. var calendar = CalendarApp.getDefaultCalendar(); Logger.log('My default calendar is set to the time zone "%s".', calendar.getTimeZone());
Возвращаться
Calendar
— календарь пользователя по умолчанию.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getDescription()
Получает описание календаря.
Возвращаться
String
— описание этого календаря
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventById(iCalId)
Получает событие с заданным идентификатором. Если серия принадлежит календарю, отличному от календаря по умолчанию, этот метод необходимо вызывать из этого приложения CalendarApp
. Вызов getEventById(iCalId)
возвращает событие только в календаре по умолчанию.
Несколько событий могут иметь один и тот же идентификатор, если они являются частью серии событий. В этом случае этот метод возвращает только первое событие из этой серии.
Параметры
Имя | Тип | Описание |
---|---|---|
iCalId | String | идентификатор события |
Возвращаться
CalendarEvent
— событие с заданным идентификатором или null
, если событие не существует или пользователь не может получить к нему доступ.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventSeriesById(iCalId)
Получает серию событий с заданным идентификатором. Если заданный идентификатор относится к одному CalendarEvent
, то CalendarEventSeries
возвращается с одним событием в серии. Обратите внимание, что если серия событий принадлежит календарю, отличному от календаря по умолчанию, этот метод необходимо вызывать из этого приложения CalendarApp
; прямой вызов getEventSeriesById(iCalId)
возвращает только серию событий, которая существует в календаре по умолчанию.
Параметры
Имя | Тип | Описание |
---|---|---|
iCalId | String | ID серии событий |
Возвращаться
CalendarEventSeries
— серия с заданным идентификатором или null
, если серия не существует или пользователь не может получить к ней доступ
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEvents(startTime, endTime)
Получает все события, происходящие в заданном временном диапазоне.
Этот метод возвращает события, которые начинаются в указанном временном диапазоне, заканчиваются в этом временном диапазоне или охватывают временной диапазон. Если часовой пояс не указан, значения времени интерпретируются в контексте часового пояса скрипта, который может отличаться от часового пояса календаря.
// Determines how many events are happening in the next two hours. var now = new Date(); var twoHoursFromNow = new Date(now.getTime() + (2 * 60 * 60 * 1000)); var events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow); Logger.log('Number of events: ' + events.length);
Параметры
Имя | Тип | Описание |
---|---|---|
startTime | Date | начало диапазона времени |
endTime | Date | конец временного диапазона, не включительно |
Возвращаться
CalendarEvent[]
— события, происходящие во временном диапазоне
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEvents(startTime, endTime, options)
Получает все события, происходящие в заданном временном диапазоне и соответствующие заданным критериям.
Этот метод возвращает события, которые начинаются в указанном временном диапазоне, заканчиваются в этом временном диапазоне или охватывают временной диапазон. Если часовой пояс не указан, значения времени интерпретируются в контексте часового пояса скрипта, который может отличаться от часового пояса календаря.
Имейте в виду, что фильтрация по author
, search
или statusFilters
происходит после применения start
и max
. Это означает, что количество возвращенных событий может быть меньше max
, даже если дополнительные события соответствуют критериям.
// Determines how many events are happening in the next two hours that contain the term // "meeting". var now = new Date(); var twoHoursFromNow = new Date(now.getTime() + (2 * 60 * 60 * 1000)); var events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow, {search: 'meeting'}); Logger.log('Number of events: ' + events.length);
Параметры
Имя | Тип | Описание |
---|---|---|
startTime | Date | начало диапазона времени |
endTime | Date | конец временного диапазона, не включительно |
options | Object | объект JavaScript, который указывает расширенные параметры, как указано ниже |
Расширенные параметры
Имя | Тип | Описание |
---|---|---|
start | Integer | индекс первого возвращаемого события |
max | Integer | максимальное количество возвращаемых событий |
author | String | адрес электронной почты, используемый создателем события для фильтрации результатов |
search | String | запрос полнотекстового поиска, используемый для фильтрации результатов |
statusFilters[] | GuestStatus | массив статусов, используемый для фильтрации результатов |
Возвращаться
CalendarEvent[]
— события, происходящие во временном диапазоне и соответствующие критериям
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventsForDay(date)
Получает все события, происходящие в заданный день.
Этот метод возвращает события, если они начинаются в течение заданного дня, заканчиваются в течение дня или охватывают день.
Обратите внимание, что используется только часть даты объекта Date, а часть времени игнорируется. Дата интерпретируется как полночь этого дня до полуночи следующего дня в часовом поясе календаря.
// Determines how many events are happening today. var today = new Date(); var events = CalendarApp.getDefaultCalendar().getEventsForDay(today); Logger.log('Number of events: ' + events.length);
Параметры
Имя | Тип | Описание |
---|---|---|
date | Date | дата для получения событий (используется только день, время игнорируется) |
Возвращаться
CalendarEvent[]
— события, происходящие в указанную дату
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventsForDay(date, options)
Получает все события, происходящие в заданный день и соответствующие заданным критериям.
Этот метод возвращает события, если они начинаются в течение заданного дня, заканчиваются в течение дня или охватывают день.
Обратите внимание, что используется только часть даты объекта Date, а часть времени игнорируется. Дата интерпретируется как полночь этого дня до полуночи следующего дня в часовом поясе календаря.
Имейте в виду, что фильтрация по author
, search
или statusFilters
происходит после применения start
и max
. Это означает, что количество возвращенных событий может быть меньше max
, даже если дополнительные события соответствуют критериям.
// Determines how many events are happening today and contain the term "meeting". var today = new Date(); var events = CalendarApp.getDefaultCalendar().getEventsForDay(today, {search: 'meeting'}); Logger.log('Number of events: ' + events.length);
Параметры
Имя | Тип | Описание |
---|---|---|
date | Date | дата для получения событий (используется только день, время игнорируется) |
options | Object | расширенные параметры фильтрации |
Расширенные параметры
Имя | Тип | Описание |
---|---|---|
start | Integer | индекс первого возвращаемого события |
max | Integer | максимальное количество возвращаемых событий |
author | String | адрес электронной почты, используемый создателем события для фильтрации результатов |
search | String | запрос полнотекстового поиска, используемый для фильтрации результатов |
statusFilters[] | GuestStatus | массив статусов, используемый для фильтрации результатов |
Возвращаться
CalendarEvent[]
— события, которые происходят в указанную дату и соответствуют критериям
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getId()
Получает идентификатор календаря. Идентификатором календаря пользователя по умолчанию является его адрес электронной почты.
Возвращаться
String
— идентификатор календаря
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getName()
Получает имя календаря.
Возвращаться
String
— имя этого календаря
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getOwnedCalendarById(id)
Получает календарь с заданным идентификатором, если он принадлежит пользователю.
Чтобы найти идентификатор календаря, нажмите стрелку рядом с названием календаря в Календаре Google и выберите Настройки календаря . Идентификатор отображается в нижней части страницы настроек.
// Gets a (non-existent) private calendar by ID. var calendar = CalendarApp.getOwnedCalendarById( '123456789@group.calendar.google.com'); Logger.log('The calendar is named "%s".', calendar.getName());
Параметры
Имя | Тип | Описание |
---|---|---|
id | String | идентификатор календаря |
Возвращаться
Calendar
— календарь с заданным идентификатором или null
, если календарь не существует или он не принадлежит пользователю.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getOwnedCalendarsByName(name)
Получает все календари с заданным именем, которыми владеет пользователь. Имена не чувствительны к регистру.
// Gets a private calendar named "Travel Plans". var calendars = CalendarApp.getOwnedCalendarsByName('Travel Plans'); Logger.log('Found %s matching calendars.', calendars.length);
Параметры
Имя | Тип | Описание |
---|---|---|
name | String | название календаря |
Возвращаться
Calendar[]
— все календари с таким названием, которыми владеет пользователь
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getTimeZone()
Получает часовой пояс календаря.
Возвращаться
String
— часовой пояс, указанный в «длинном» формате (например, «Америка/Нью-Йорк», как указано на Joda.org )
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isHidden()
Определяет, скрыт ли календарь в пользовательском интерфейсе.
Возвращаться
Boolean
— true
, если календарь скрыт в пользовательском интерфейсе; false
, если нет
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isMyPrimaryCalendar()
Определяет, является ли календарь календарем по умолчанию для действующего пользователя.
Возвращаться
Boolean
— true
, если календарь является календарем по умолчанию для действующего пользователя; false
, если нет
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isOwnedByMe()
Определяет, принадлежит ли календарь действующему пользователю.
Возвращаться
Boolean
— true
, если календарь принадлежит действующему пользователю; false
, если нет
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isSelected()
Определяет, отображаются ли события календаря в пользовательском интерфейсе.
Возвращаться
Boolean
— true
, если события календаря отображаются в пользовательском интерфейсе; false
, если нет
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
newRecurrence()
Создает новый объект повторения, который можно использовать для создания правил повторения событий.
// Creates an event series for a no-meetings day, taking place every Wednesday in 2013. var recurrence = CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014')); var eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries('No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), recurrence); Logger.log('Event Series ID: ' + eventSeries.getId());
Возвращаться
EventRecurrence
— новый объект повторения без установленных правил (ведет себя как еженедельное повторение)
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
setColor(color)
Устанавливает цвет календаря.
Параметры
Имя | Тип | Описание |
---|---|---|
color | String | Шестнадцатеричная строка цвета ("#rrggbb") или значение из CalendarApp.Color . |
Возвращаться
Calendar
— Этот календарь для цепочки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setDescription(description)
Устанавливает описание календаря.
Параметры
Имя | Тип | Описание |
---|---|---|
description | String | описание этого календаря |
Возвращаться
Calendar
— этот календарь для цепочки
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setHidden(hidden)
Устанавливает, отображается ли календарь в пользовательском интерфейсе.
Параметры
Имя | Тип | Описание |
---|---|---|
hidden | Boolean | true , чтобы скрыть календарь в пользовательском интерфейсе; false , чтобы показать это |
Возвращаться
Calendar
— этот календарь для цепочки
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setName(name)
Устанавливает имя календаря.
Параметры
Имя | Тип | Описание |
---|---|---|
name | String | новое имя |
Возвращаться
Calendar
— этот календарь для цепочки
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setSelected(selected)
Устанавливает, будут ли события календаря отображаться в пользовательском интерфейсе.
Параметры
Имя | Тип | Описание |
---|---|---|
selected | Boolean | true , чтобы отображать события календаря в пользовательском интерфейсе; false , чтобы скрыть их |
Возвращаться
Calendar
— этот календарь для цепочки
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setTimeZone(timeZone)
Устанавливает часовой пояс календаря.
Параметры
Имя | Тип | Описание |
---|---|---|
timeZone | String | часовой пояс, указанный в «длинном» формате (например, «Америка/Нью-Йорк», как указано на Joda.org ) |
Возвращаться
Calendar
— этот календарь для цепочки
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
subscribeToCalendar(id)
Подписывает пользователя на календарь с заданным идентификатором, если пользователю разрешена подписка.
// Subscribe to the calendar "US Holidays". var calendar = CalendarApp.subscribeToCalendar( 'en.usa#holiday@group.v.calendar.google.com'); Logger.log('Subscribed to the calendar "%s".', calendar.getName());
Параметры
Имя | Тип | Описание |
---|---|---|
id | String | ID календаря для подписки |
Возвращаться
Calendar
— недавно подписанный на календарь
Броски
Error
— если календаря с таким идентификатором не существует
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
subscribeToCalendar(id, options)
Подписывает пользователя на календарь с заданным идентификатором, если пользователю разрешена подписка.
// Subscribe to the calendar "US Holidays", and set it to the color blue. var calendar = CalendarApp.subscribeToCalendar( 'en.usa#holiday@group.v.calendar.google.com', { color: CalendarApp.Color.BLUE }); Logger.log('Subscribed to the calendar "%s".', calendar.getName());
Параметры
Имя | Тип | Описание |
---|---|---|
id | String | ID календаря для подписки |
options | Object | объект JavaScript, который указывает расширенные параметры, как указано ниже |
Расширенные параметры
Имя | Тип | Описание |
---|---|---|
color | String | шестнадцатеричная строка цвета ("#rrggbb") или значение из CalendarApp.Colors |
hidden | Boolean | скрыт ли календарь в пользовательском интерфейсе (по умолчанию: false ) |
selected | Boolean | отображаются ли события календаря в пользовательском интерфейсе (по умолчанию: true ) |
Возвращаться
Calendar
— недавно подписанный календарь
Броски
Error
— если календаря с таким идентификатором не существует
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds