Представляет календарь, которым владеет пользователь или на который он подписан.
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
create All Day Event(title, date) | Calendar Event | Создает новое событие на весь день. |
create All Day Event(title, startDate, endDate) | Calendar Event | Создает новое событие на весь день, которое может охватывать несколько дней. |
create All Day Event(title, startDate, endDate, options) | Calendar Event | Создает новое событие на весь день, которое может охватывать несколько дней. |
create All Day Event(title, date, options) | Calendar Event | Создает новое событие на весь день. |
create All Day Event Series(title, startDate, recurrence) | Calendar Event Series | Создает новую серию событий на весь день. |
create All Day Event Series(title, startDate, recurrence, options) | Calendar Event Series | Создает новую серию событий на весь день. |
create Event(title, startTime, endTime) | Calendar Event | Создает новое событие. |
create Event(title, startTime, endTime, options) | Calendar Event | Создает новое событие. |
create Event From Description(description) | Calendar Event | Создает событие из описания в свободной форме. |
create Event Series(title, startTime, endTime, recurrence) | Calendar Event Series | Создает новую серию событий. |
create Event Series(title, startTime, endTime, recurrence, options) | Calendar Event Series | Создает новую серию событий. |
delete Calendar() | void | Удаляет календарь навсегда. |
get Color() | String | Получает цвет календаря. |
get Description() | String | Получает описание календаря. |
get Event By Id(iCalId) | Calendar Event | Получает событие с заданным идентификатором. |
get Event Series By Id(iCalId) | Calendar Event Series | Получает серию событий с заданным идентификатором. |
get Events(startTime, endTime) | Calendar Event[] | Получает все события, происходящие в заданном диапазоне времени. |
get Events(startTime, endTime, options) | Calendar Event[] | Получает все события, происходящие в заданном диапазоне времени и соответствующие указанным критериям. |
get Events For Day(date) | Calendar Event[] | Получает все события, происходящие в определенный день. |
get Events For Day(date, options) | Calendar Event[] | Получает все события, происходящие в определенный день и соответствующие указанным критериям. |
get Id() | String | Получает идентификатор календаря. |
get Name() | String | Получает имя календаря. |
get Time Zone() | String | Получает часовой пояс календаря. |
is Hidden() | Boolean | Определяет, скрыт ли календарь в пользовательском интерфейсе. |
is My Primary Calendar() | Boolean | Определяет, является ли календарь основным календарем для эффективного пользователя. |
is Owned By Me() | Boolean | Определяет, принадлежит ли вам календарь. |
is Selected() | Boolean | Определяет, отображаются ли события календаря в пользовательском интерфейсе. |
set Color(color) | Calendar | Устанавливает цвет календаря. |
set Description(description) | Calendar | Устанавливает описание календаря. |
set Hidden(hidden) | Calendar | Устанавливает, отображается ли календарь в пользовательском интерфейсе. |
set Name(name) | Calendar | Устанавливает имя календаря. |
set Selected(selected) | Calendar | Определяет, отображаются ли события календаря в пользовательском интерфейсе. |
set Time Zone(timeZone) | Calendar | Устанавливает часовой пояс календаря. |
unsubscribe From Calendar() | void | Отписывает пользователя от календаря. |
Подробная документация
create All Day Event(title, date)
Создает новое событие на весь день.
// Creates an all-day event for the moon landing and logs the ID. const event = CalendarApp.getDefaultCalendar().createAllDayEvent( 'Apollo 11 Landing', new Date('July 20, 1969'), ); Logger.log(`Event ID: ${event.getId()}`);
Параметры
Имя | Тип | Описание |
---|---|---|
title | String | Название мероприятия. |
date | Date | Дата события (используется только день; время игнорируется). |
Возвращаться
Calendar Event
— созданное событие.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
create All Day Event(title, startDate, endDate)
Создает новое событие на весь день, которое может охватывать несколько дней.
// Creates an all-day event for the Woodstock festival (August 15th to 17th) and // logs the ID. const event = CalendarApp.getDefaultCalendar().createAllDayEvent( 'Woodstock Festival', new Date('August 15, 1969'), new Date('August 18, 1969'), ); Logger.log(`Event ID: ${event.getId()}`);
Параметры
Имя | Тип | Описание |
---|---|---|
title | String | Название мероприятия. |
start Date | Date | Дата начала события (используется только день; время игнорируется). |
end Date | Date | Дата окончания события (используется только день; время игнорируется). Дата окончания является эксклюзивной. |
Возвращаться
Calendar Event
— созданное событие.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
create All Day Event(title, startDate, endDate, options)
Создает новое событие на весь день, которое может охватывать несколько дней.
// Creates an all-day event for the Woodstock festival (August 15th to 17th) and // logs the ID. const 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 | Название мероприятия. |
start Date | Date | Дата начала события (используется только день; время игнорируется). |
end Date | Date | Дата окончания события (используется только день; время игнорируется). Дата окончания является эксклюзивной. |
options | Object | Объект JavaScript, задающий дополнительные параметры, как указано ниже. |
Расширенные параметры
Имя | Тип | Описание |
---|---|---|
description | String | Описание события. |
location | String | Место проведения мероприятия. |
guests | String | Список адресов электронной почты, разделенных запятыми, которые следует добавить в качестве гостей. |
send Invites | Boolean | Отправлять ли приглашения по электронной почте (по умолчанию: false ). |
Возвращаться
Calendar Event
— созданное событие.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
create All Day Event(title, date, options)
Создает новое событие на весь день.
// Creates an all-day event for the moon landing and logs the ID. const 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 | Список адресов электронной почты, разделенных запятыми, которые следует добавить в качестве гостей. |
send Invites | Boolean | Отправлять ли приглашения по электронной почте (по умолчанию: false ). |
Возвращаться
Calendar Event
— созданное событие.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
create All Day Event Series(title, startDate, recurrence)
Создает новую серию событий на весь день.
// Creates an event series for a no-meetings day, taking place every Wednesday // in 2013. const 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 | название событий в сериале |
start Date | Date | дата первого события в серии (используется только день; время игнорируется) |
recurrence | Event Recurrence | настройки повторения серии событий |
Возвращаться
Calendar Event Series
— созданная серия событий.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
create All Day Event Series(title, startDate, recurrence, options)
Создает новую серию событий на весь день.
// Creates an event series for a no-meetings day, taking place every Wednesday // in 2013. const 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: '[email protected]'}, ); Logger.log(`Event Series ID: ${eventSeries.getId()}`);
Параметры
Имя | Тип | Описание |
---|---|---|
title | String | название событий в сериале |
start Date | Date | дата первого события в серии (используется только день; время игнорируется) |
recurrence | Event Recurrence | настройки повторения серии событий |
options | Object | объект JavaScript, который определяет дополнительные параметры, как указано ниже |
Расширенные параметры
Имя | Тип | Описание |
---|---|---|
description | String | описание событий в сериале |
location | String | место событий сериала |
guests | String | разделенный запятыми список адресов электронной почты, которые следует добавить в качестве гостей на мероприятия серии. |
send Invites | Boolean | отправлять ли приглашения по электронной почте (по умолчанию: false ) |
Возвращаться
Calendar Event Series
— созданная серия событий.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
create Event(title, startTime, endTime)
Создает новое событие.
Если часовой пояс не указан, значения времени интерпретируются в контексте часового пояса скрипта, который может отличаться от часового пояса календаря.
// Creates an event for the moon landing and logs the ID. const 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 | название мероприятия |
start Time | Date | дата и время начала мероприятия |
end Time | Date | дата и время окончания мероприятия |
Возвращаться
Calendar Event
— созданное событие
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
create Event(title, startTime, endTime, options)
Создает новое событие.
Если часовой пояс не указан, значения времени интерпретируются в контексте часового пояса скрипта, который может отличаться от часового пояса календаря.
// Creates an event for the moon landing and logs the ID. const 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 | название мероприятия |
start Time | Date | дата и время начала мероприятия |
end Time | Date | дата и время окончания мероприятия |
options | Object | объект JavaScript, который определяет дополнительные параметры, как указано ниже |
Расширенные параметры
Имя | Тип | Описание |
---|---|---|
description | String | описание события |
location | String | место проведения мероприятия |
guests | String | список адресов электронной почты, разделенных запятыми, которые следует добавить в качестве гостей |
send Invites | Boolean | отправлять ли приглашения по электронной почте (по умолчанию: false ) |
Возвращаться
Calendar Event
— созданное событие
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
create Event From Description(description)
Создает событие из описания в свободной форме.
Описание должно использовать тот же формат, что и функция «Быстрое добавление» пользовательского интерфейса.
// Creates a new event and logs its ID. const event = CalendarApp.getDefaultCalendar().createEventFromDescription( 'Lunch with Mary, Friday at 1PM', ); Logger.log(`Event ID: ${event.getId()}`);
Параметры
Имя | Тип | Описание |
---|---|---|
description | String | описание мероприятия в свободной форме |
Возвращаться
Calendar Event
— созданное событие
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
create Event Series(title, startTime, endTime, recurrence)
Создает новую серию событий.
// Creates an event series for a team meeting, taking place every Tuesday and // Thursday in 2013. const 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 | название событий в сериале |
start Time | Date | дата и время начала первого события в серии |
end Time | Date | дата и время окончания первого события в серии |
recurrence | Event Recurrence | настройки повторения серии событий |
Возвращаться
Calendar Event Series
— созданная серия событий.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
create Event Series(title, startTime, endTime, recurrence, options)
Создает новую серию событий.
// Creates an event series for a team meeting, taking place every Tuesday and // Thursday in 2013. const 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 | название событий в сериале |
start Time | Date | дата и время начала первого события в серии |
end Time | Date | дата и время окончания первого события в серии |
recurrence | Event Recurrence | настройки повторения серии событий |
options | Object | объект JavaScript, который определяет дополнительные параметры, как указано ниже |
Расширенные параметры
Имя | Тип | Описание |
---|---|---|
description | String | описание событий в сериале |
location | String | место событий сериала |
guests | String | разделенный запятыми список адресов электронной почты, которые следует добавить в качестве гостей на мероприятия серии. |
send Invites | Boolean | отправлять ли приглашения по электронной почте (по умолчанию: false ) |
Возвращаться
Calendar Event Series
— созданная серия событий.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
delete Calendar()
Удаляет календарь навсегда. Пользователь может удалить только принадлежащий ему календарь.
// Creates a calendar to delete. const calendar = CalendarApp.createCalendar('Test'); // Deletes the 'Test' calendar permanently. calendar.deleteCalendar();
Броски
Error
— если это импортированный календарь.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
get Color()
Получает цвет календаря.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('[email protected]'); // Gets the color of the calendar and logs it to the console. // For the default calendar, you can use CalendarApp.getColor() instead. const calendarColor = calendar.getColor(); console.log(calendarColor);
Возвращаться
String
— шестнадцатеричная цветовая строка ("#rrggbb").
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
get Description()
Получает описание календаря.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('[email protected]'); // Sets the description of the calendar to 'Test description.' calendar.setDescription('Test description'); // Gets the description of the calendar and logs it to the console. // For the default calendar, you can use CalendarApp.getDescription() instead. const description = calendar.getDescription(); console.log(description);
Возвращаться
String
— Описание этого календаря.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
get Event By Id(iCalId)
Получает событие с заданным идентификатором. Если серия принадлежит календарю, отличному от календаря по умолчанию, этот метод необходимо вызывать из этого календаря. Вызов Calendar App.getEventById(iCalId)
возвращает событие только в календаре по умолчанию.
Несколько событий могут иметь один и тот же идентификатор, если они являются частью серии событий. В этом случае этот метод возвращает только первое событие из этой серии.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('[email protected]'); // Creates an event for the moon landing. const event = calendar.createEvent( 'Apollo 11 Landing', new Date('July 20, 1969 20:05:00 UTC'), new Date('July 20, 1969 20:17:00 UTC'), ); // Gets the calendar event ID and logs it to the console. const iCalId = event.getId(); console.log(iCalId); // Gets the event by its ID and logs the title of the event to the console. // For the default calendar, you can use CalendarApp.getEventById(iCalId) // instead. const myEvent = calendar.getEventById(iCalId); console.log(myEvent.getTitle());
Параметры
Имя | Тип | Описание |
---|---|---|
iCalId | String | Идентификатор события. |
Возвращаться
Calendar Event
— событие с заданным идентификатором или null
, если событие не существует или пользователь не может получить к нему доступ.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
get Event Series By Id(iCalId)
Получает серию событий с заданным идентификатором. Если указан идентификатор для одного Calendar Event
, то возвращается Calendar Event Series
с одним событием в серии. Обратите внимание: если серия событий принадлежит календарю, отличному от календаря по умолчанию, этот метод необходимо вызывать из этого Calendar
; прямой вызов Calendar App.getEventSeriesById(iCalId)
возвращает только серию событий, которая существует в календаре по умолчанию.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('[email protected]'); // Creates an event series for a daily team meeting from 1 PM to 2 PM. // The series adds the daily event from January 1, 2023 through December 31, // 2023. const eventSeries = calendar.createEventSeries( 'Team meeting', new Date('Jan 1, 2023 13:00:00'), new Date('Jan 1, 2023 14:00:00'), CalendarApp.newRecurrence().addDailyRule().until(new Date('Jan 1, 2024')), ); // Gets the ID of the event series. const iCalId = eventSeries.getId(); // Gets the event series by its ID and logs the series title to the console. // For the default calendar, you can use CalendarApp.getEventSeriesById(iCalId) // instead. console.log(calendar.getEventSeriesById(iCalId).getTitle());
Параметры
Имя | Тип | Описание |
---|---|---|
iCalId | String | Идентификатор серии событий. |
Возвращаться
Calendar Event Series
— серия с заданным идентификатором или null
, если серия не существует или пользователь не может получить к ней доступ.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
get Events(startTime, endTime)
Получает все события, происходящие в заданном диапазоне времени.
Этот метод возвращает события, которые начинаются в заданном диапазоне времени, заканчиваются в течение указанного диапазона времени или охватывают этот диапазон времени. Если часовой пояс не указан, значения времени интерпретируются в контексте часового пояса скрипта, который может отличаться от часового пояса календаря.
// Determines how many events are happening in the next two hours. const now = new Date(); const twoHoursFromNow = new Date(now.getTime() + 2 * 60 * 60 * 1000); const events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow); Logger.log(`Number of events: ${events.length}`);
Параметры
Имя | Тип | Описание |
---|---|---|
start Time | Date | начало временного диапазона |
end Time | Date | конец временного диапазона, не включительно |
Возвращаться
Calendar Event[]
— события, происходящие в указанном временном диапазоне.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
get Events(startTime, endTime, options)
Получает все события, происходящие в заданном диапазоне времени и соответствующие указанным критериям.
Этот метод возвращает события, которые начинаются в заданном диапазоне времени, заканчиваются в течение указанного диапазона времени или охватывают этот диапазон времени. Если часовой пояс не указан, значения времени интерпретируются в контексте часового пояса скрипта, который может отличаться от часового пояса календаря.
Имейте в виду, что фильтрация по author
, search
или status Filters
происходит после применения значений start
и max
. Это означает, что количество возвращаемых событий может быть меньше max
, даже если критериям соответствуют дополнительные события.
// Determines how many events are happening in the next two hours that contain // the term "meeting". const now = new Date(); const twoHoursFromNow = new Date(now.getTime() + 2 * 60 * 60 * 1000); const events = CalendarApp.getDefaultCalendar().getEvents( now, twoHoursFromNow, {search: 'meeting'}, ); Logger.log(`Number of events: ${events.length}`);
Параметры
Имя | Тип | Описание |
---|---|---|
start Time | Date | начало временного диапазона |
end Time | Date | конец временного диапазона, не включительно |
options | Object | объект JavaScript, который определяет дополнительные параметры, как указано ниже |
Расширенные параметры
Имя | Тип | Описание |
---|---|---|
start | Integer | индекс первого возвращаемого события |
max | Integer | максимальное количество возвращаемых событий |
author | String | адрес электронной почты, используемый создателем мероприятия для фильтрации результатов |
search | String | полнотекстовый поисковый запрос, используемый для фильтрации результатов |
status Filters[] | Guest Status | массив статусов, используемый для фильтрации результатов |
Возвращаться
Calendar Event[]
— события, происходящие в указанном временном диапазоне и соответствующие критериям.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
get Events For Day(date)
Получает все события, происходящие в определенный день.
Этот метод возвращает события, если они начинаются в течение данного дня, заканчиваются в течение дня или охватывают день.
Обратите внимание, что используется только часть даты объекта Date, а часть времени игнорируется. Дата интерпретируется как полночь этого дня до полуночи следующего дня в часовом поясе календаря.
// Determines how many events are happening today. const today = new Date(); const events = CalendarApp.getDefaultCalendar().getEventsForDay(today); Logger.log(`Number of events: ${events.length}`);
Параметры
Имя | Тип | Описание |
---|---|---|
date | Date | дата, для которой нужно получить события (используется только день; время игнорируется) |
Возвращаться
Calendar Event[]
— события, происходящие в указанную дату.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
get Events For Day(date, options)
Получает все события, происходящие в определенный день и соответствующие указанным критериям.
Этот метод возвращает события, если они начинаются в течение данного дня, заканчиваются в течение дня или охватывают день.
Обратите внимание, что используется только часть даты объекта Date, а часть времени игнорируется. Дата интерпретируется как полночь этого дня до полуночи следующего дня в часовом поясе календаря.
Имейте в виду, что фильтрация по author
, search
или status Filters
происходит после применения значений start
и max
. Это означает, что количество возвращаемых событий может быть меньше max
, даже если критериям соответствуют дополнительные события.
// Determines how many events are happening today and contain the term // "meeting". const today = new Date(); const 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 | полнотекстовый поисковый запрос, используемый для фильтрации результатов |
status Filters[] | Guest Status | массив статусов, используемый для фильтрации результатов |
Возвращаться
Calendar Event[]
— события, которые происходят в указанную дату и соответствуют критериям
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
get Id()
Получает идентификатор календаря. Идентификатором календаря пользователя по умолчанию является его адрес электронной почты.
// Opens the calendar by its ID. // To get the user's default calendar, use CalendarApp.getDefaultCalendar(). // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('[email protected]'); // Gets the ID of the calendar and logs it to the console. const calendarId = calendar.getId(); console.log(calendarId);
Возвращаться
String
— идентификатор календаря.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
get Name()
Получает имя календаря.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('[email protected]'); // Gets the name of the calendar and logs it to the console. // For the default calendar, you can use CalendarApp.getName() instead. const calendarName = calendar.getName(); console.log(calendarName);
Возвращаться
String
— имя этого календаря.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
get Time Zone()
Получает часовой пояс календаря.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('[email protected]'); // Gets the time zone of the calendar and logs it to the console. // For the default calendar, you can use CalendarApp.getTimeZone() instead. const timeZone = calendar.getTimeZone(); console.log(timeZone);
Возвращаться
String
— часовой пояс, указанный в «длинном» формате (например, «Америка/Нью_Йорк», как указано на Joda.org ).
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
is Hidden()
Определяет, скрыт ли календарь в пользовательском интерфейсе.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('[email protected]'); // Determines whether the calendar is hidden in the user interface and logs it // to the console. For the default calendar, you can use CalendarApp.isHidden() // instead. const isHidden = calendar.isHidden(); console.log(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
is My Primary Calendar()
Определяет, является ли календарь основным календарем для эффективного пользователя.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('[email protected]'); // Determines whether the calendar is the default calendar for // the effective user and logs it to the console. // For the default calendar, you can use CalendarApp.isMyPrimaryCalendar() // instead. const isMyPrimaryCalendar = calendar.isMyPrimaryCalendar(); console.log(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
is Owned By Me()
Определяет, принадлежит ли вам календарь.
// Gets a calendar by its ID. To get the user's default calendar, use // CalendarApp.getDefault() instead. // TODO(developer): Replace the ID with the calendar ID that you want to use. const calendar = CalendarApp.getCalendarById( '[email protected]', ); // Determines whether the calendar is owned by you and logs it. console.log(calendar.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
is Selected()
Определяет, отображаются ли события календаря в пользовательском интерфейсе.
// Gets the user's default calendar. To get a different calendar, // use getCalendarById() instead. const calendar = CalendarApp.getDefaultCalendar(); // Determines whether the calendar's events are displayed in the user interface // and logs it. console.log(calendar.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
set Color(color)
Устанавливает цвет календаря.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('[email protected]'); // Sets the color of the calendar to pink using the Calendar Color enum. // For the default calendar, you can use CalendarApp.setColor() instead. calendar.setColor(CalendarApp.Color.PINK);
Параметры
Имя | Тип | Описание |
---|---|---|
color | String | Calendar App.Color или шестнадцатеричная строка цвета ("#rrggbb"). |
Возвращаться
Calendar
— Это календарь для цепочки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
set Description(description)
Устанавливает описание календаря.
// Gets the user's default calendar. To get a different calendar, // use getCalendarById() instead. const calendar = CalendarApp.getDefaultCalendar(); // Sets the description of the calendar. // TODO(developer): Update the string with the description that you want to use. calendar.setDescription('Updated calendar description.');
Параметры
Имя | Тип | Описание |
---|---|---|
description | String | описание этого календаря |
Возвращаться
Calendar
— это календарь для цепочки
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
set Hidden(hidden)
Устанавливает, отображается ли календарь в пользовательском интерфейсе.
Параметры
Имя | Тип | Описание |
---|---|---|
hidden | Boolean | true чтобы скрыть календарь в пользовательском интерфейсе; false чтобы показать это |
Возвращаться
Calendar
— это календарь для цепочки
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
set Name(name)
Устанавливает имя календаря.
// Gets the user's default calendar. To get a different calendar, // use getCalendarById() instead. const calendar = CalendarApp.getDefaultCalendar(); // Sets the name of the calendar. // TODO(developer): Update the string with the name that you want to use. calendar.setName('Example calendar name');
Параметры
Имя | Тип | Описание |
---|---|---|
name | String | новое имя |
Возвращаться
Calendar
— это календарь для цепочки
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
set Selected(selected)
Определяет, отображаются ли события календаря в пользовательском интерфейсе.
// Gets the user's default calendar. To get a different calendar, // use getCalendarById() instead. const calendar = CalendarApp.getDefaultCalendar(); // Selects the calendar so that its events are displayed in the user interface. // To unselect the calendar, set the parameter to false. calendar.setSelected(true);
Параметры
Имя | Тип | Описание |
---|---|---|
selected | Boolean | true чтобы отображать события календаря в пользовательском интерфейсе; false чтобы скрыть их |
Возвращаться
Calendar
— это календарь для цепочки
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
set Time Zone(timeZone)
Устанавливает часовой пояс календаря.
// Gets the user's default calendar. To get a different calendar, // use getCalendarById() instead. const calendar = CalendarApp.getDefaultCalendar(); // Sets the time zone of the calendar to America/New York (US/Eastern) time. calendar.setTimeZone('America/New_York');
Параметры
Имя | Тип | Описание |
---|---|---|
time Zone | String | Часовой пояс, указанный в «длинном» формате (например, «Америка/Нью_Йорк», как указано на сайте Joda.org ). |
Возвращаться
Calendar
— Это календарь для цепочки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
unsubscribe From Calendar()
Отписывает пользователя от календаря. Пользователь не может отказаться от подписки на календари, перечисленные в списке « Мои календари» . Они могут отказаться от подписки на календари, перечисленные в разделе «Другие календари» .
// Gets the calendar by its ID. // TODO(developer): Replace the calendar ID with the calendar ID that you want // to get. const calendar = CalendarApp.getCalendarById( '[email protected]', ); // Unsubscribes the user from the calendar. const result = calendar.unsubscribeFromCalendar();
Броски
Error
— если это собственный календарь
Авторизация
Сценарии, использующие этот метод, требуют авторизации с использованием одной или нескольких из следующих областей или соответствующих областей из соответствующего REST API :
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds