Class Calendar

Календарь

Представляет собой календарь, которым владеет пользователь или на который он подписан.

Методы

Метод Тип возвращаемого значения Краткое описание
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 Получает событие с заданным ID.
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 Отменяет подписку пользователя на календарь.

Подробная документация

createAllDayEvent(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 Дата события (используется только день; время не указывается).

Возвращаться

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.
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 Дата окончания события (используется только день; время игнорируется). Дата окончания исключается из общего правила.

Возвращаться

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.
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 ).

Возвращаться

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.
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 ).

Возвращаться

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.
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 параметры повторения серии событий

Возвращаться

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.
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: 'everyone@example.com'},
);
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 )

Возвращаться

CalendarEventSeries — созданная серия событий.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего 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.
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 дата и время окончания мероприятия

Возвращаться

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.
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 )

Возвращаться

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.
const 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.
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 параметры повторения серии событий

Возвращаться

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.
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 )

Возвращаться

CalendarEventSeries — созданная серия событий.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

deleteCalendar()

Удаляет календарь безвозвратно. Пользователь может удалить только тот календарь, который ему принадлежит. 

// 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

getColor()

Получает цвет календаря. 

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// 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

getDescription()

Получает описание календаря. 

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// 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

getEventById(iCalId)

Получает событие с заданным ID. Если серия событий относится к календарю, отличному от календаря по умолчанию, этот метод необходимо вызывать из этого календаря. Вызов метода CalendarApp.getEventById(iCalId) возвращает событие только из календаря по умолчанию.

Если несколько событий являются частью серии событий, то один и тот же идентификатор может совпадать. В этом случае данный метод возвращает только первое событие из этой серии. 

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// 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 Идентификатор события.

Возвращаться

CalendarEvent — Событие с заданным ID, или null если событие не существует или пользователь не может получить к нему доступ.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEventSeriesById(iCalId)

Получает серию событий с заданным ID. Если заданный ID относится к одному CalendarEvent , то возвращается CalendarEventSeries , содержащий одно событие в серии. Обратите внимание, что если серия событий принадлежит календарю, отличному от календаря по умолчанию, этот метод необходимо вызывать из этого Calendar ; прямой вызов CalendarApp.getEventSeriesById(iCalId) возвращает только серию событий, существующую в календаре по умолчанию. 

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// 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 Идентификатор серии событий.

Возвращаться

CalendarEventSeries — Серия с заданным ID или 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.
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 конец временного диапазона, не включающий в себя

Возвращаться

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".
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 массив статусов, используемый для фильтрации результатов.

Возвращаться

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.
const today = new Date();
const 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".
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 массив статусов, используемый для фильтрации результатов.

Возвращаться

CalendarEvent[] — события, происходящие в указанную дату и соответствующие критериям.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getId()

Получает идентификатор календаря. Идентификатор календаря по умолчанию для пользователя — это его адрес электронной почты. 

// 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('222larabrown@gmail.com');

// 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

getName()

Получает название календаря. 

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// 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

getTimeZone()

Получает часовой пояс календаря. 

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// 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 — Часовой пояс, указанный в формате "long" (например, "America/New_York", как указано на Joda.org ).

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

isHidden()

Определяет, скрыт ли календарь в пользовательском интерфейсе. 

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// 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

isMyPrimaryCalendar()

Определяет, является ли данный календарь основным для фактического пользователя. 

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// 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

isOwnedByMe()

Определяет, принадлежит ли календарь вам. 

// 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(
    'abc123456@group.calendar.google.com',
);

// 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

isSelected()

Определяет, отображаются ли события календаря в пользовательском интерфейсе. 

// 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

setColor(color)

Задает цвет календаря. 

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// 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

setDescription(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

setHidden(hidden)

Определяет, будет ли календарь отображаться в пользовательском интерфейсе.

Параметры

Имя Тип Описание
hidden Boolean true скрывает календарь в пользовательском интерфейсе; false отображает его.

Возвращаться

Calendar — этот календарь для составления цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setName(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

setSelected(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

setTimeZone(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 Часовой пояс, указанный в "длинном" формате (например, "America/New_York", как указано на Joda.org ).

Возвращаться

Calendar — Этот календарь предназначен для составления цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия или в соответствующих областях действия соответствующего REST API :

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

unsubscribeFromCalendar()

Отменяет подписку пользователя на календарь. Пользователь не может отписаться от календарей, перечисленных в списке « Мои календари» . Он может отписаться от календарей, перечисленных в разделе «Другие календари» . 

// 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(
    'abc123456@group.calendar.google.com',
);

// 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