Esta página foi traduzida pela API Cloud Translation.

Class Calendar

Representa uma agenda que o usuário possui ou assina.

Métodos

Método	Tipo de retorno	Breve descrição
`createAllDayEvent(title, date)`	`CalendarEvent`	Cria um novo evento de dia inteiro.
`createAllDayEvent(title, startDate, endDate)`	`CalendarEvent`	Cria um novo evento de dia inteiro que pode se estender por vários dias.
`createAllDayEvent(title, startDate, endDate, options)`	`CalendarEvent`	Cria um novo evento de dia inteiro que pode se estender por vários dias.
`createAllDayEvent(title, date, options)`	`CalendarEvent`	Cria um novo evento de dia inteiro.
`createAllDayEventSeries(title, startDate, recurrence)`	`CalendarEventSeries`	Cria uma nova série de eventos de dia inteiro.
`createAllDayEventSeries(title, startDate, recurrence, options)`	`CalendarEventSeries`	Cria uma nova série de eventos de dia inteiro.
`createEvent(title, startTime, endTime)`	`CalendarEvent`	Cria um novo evento.
`createEvent(title, startTime, endTime, options)`	`CalendarEvent`	Cria um novo evento.
`createEventFromDescription(description)`	`CalendarEvent`	Cria um evento a partir de uma descrição em formato livre.
`createEventSeries(title, startTime, endTime, recurrence)`	`CalendarEventSeries`	Cria uma nova série de eventos.
`createEventSeries(title, startTime, endTime, recurrence, options)`	`CalendarEventSeries`	Cria uma nova série de eventos.
`deleteCalendar()`	`void`	Exclui a agenda permanentemente.
`getColor()`	`String`	Recebe a cor da agenda.
`getDescription()`	`String`	Recebe a descrição da agenda.
`getEventById(iCalId)`	`CalendarEvent`	Extrai o evento com o ID fornecido.
`getEventSeriesById(iCalId)`	`CalendarEventSeries`	Extrai a série de eventos com o ID fornecido.
`getEvents(startTime, endTime)`	`CalendarEvent[]`	Recebe todos os eventos que ocorrem em um determinado período.
`getEvents(startTime, endTime, options)`	`CalendarEvent[]`	Recebe todos os eventos que ocorrem em um determinado período e que atendem aos critérios especificados.
`getEventsForDay(date)`	`CalendarEvent[]`	Recebe todos os eventos que ocorrem em um determinado dia.
`getEventsForDay(date, options)`	`CalendarEvent[]`	Recebe todos os eventos que ocorrem em um determinado dia e atendem aos critérios especificados.
`getId()`	`String`	Recebe o ID da agenda.
`getName()`	`String`	Recebe o nome da agenda.
`getTimeZone()`	`String`	Acessa o fuso horário da agenda.
`isHidden()`	`Boolean`	Determina se a agenda está oculta na interface do usuário.
`isMyPrimaryCalendar()`	`Boolean`	Determina se a agenda é a principal do usuário efetivo.
`isOwnedByMe()`	`Boolean`	Determina se a agenda é sua.
`isSelected()`	`Boolean`	Determina se os eventos da agenda são exibidos na interface do usuário.
`setColor(color)`	`Calendar`	Define a cor do calendário.
`setDescription(description)`	`Calendar`	Define a descrição de uma agenda.
`setHidden(hidden)`	`Calendar`	Define se a agenda ficará visível na interface do usuário.
`setName(name)`	`Calendar`	Define o nome da agenda.
`setSelected(selected)`	`Calendar`	Define se os eventos da agenda serão exibidos na interface do usuário.
`setTimeZone(timeZone)`	`Calendar`	Define o fuso horário da agenda.
`unsubscribeFromCalendar()`	`void`	Cancela a inscrição do usuário em uma agenda.

Documentação detalhada

`createAllDayEvent(title, date)`

Cria um novo evento de dia inteiro.

// 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());

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	O título do evento.
`date`	`Date`	A data do evento (somente o dia é usado, a hora é ignorada).

Retornar

CalendarEvent: o evento criado.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`createAllDayEvent(title, startDate, endDate)`

Cria um novo evento de dia inteiro que pode se estender por vários dias.

// 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());

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	O título do evento.
`startDate`	`Date`	A data em que o evento começa (somente o dia é usado, a hora é ignorada).
`endDate`	`Date`	A data de quando o evento termina (somente o dia é usado, a hora é ignorada). A a data de término é exclusiva.

Retornar

CalendarEvent: o evento criado.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`createAllDayEvent(title, startDate, endDate, options)`

Cria um novo evento de dia inteiro que pode se estender por vários dias.

// 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());

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	O título do evento.
`startDate`	`Date`	A data em que o evento começa (somente o dia é usado, a hora é ignorada).
`endDate`	`Date`	A data de quando o evento termina (somente o dia é usado, a hora é ignorada). A a data de término é exclusiva.
`options`	`Object`	Um objeto JavaScript que especifica parâmetros avançados, conforme listado abaixo.

Parâmetros avançados

Nome	Tipo	Descrição
`description`	`String`	A descrição do evento.
`location`	`String`	É o local do evento.
`guests`	`String`	Uma lista separada por vírgulas dos endereços de e-mail que devem ser adicionados como convidados.
`sendInvites`	`Boolean`	Se e-mails de convite serão enviados (padrão: `false`).

Retornar

CalendarEvent: o evento criado.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`createAllDayEvent(title, date, options)`

Cria um novo evento de dia inteiro.

// 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());

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	O título do evento.
`date`	`Date`	A data do evento (somente o dia é usado, a hora é ignorada).
`options`	`Object`	Um objeto JavaScript que especifica parâmetros avançados, conforme listado abaixo.

Parâmetros avançados

Nome	Tipo	Descrição
`description`	`String`	A descrição do evento.
`location`	`String`	É o local do evento.
`guests`	`String`	Uma lista separada por vírgulas dos endereços de e-mail que devem ser adicionados como convidados.
`sendInvites`	`Boolean`	Se e-mails de convite serão enviados (padrão: `false`).

Retornar

CalendarEvent: o evento criado.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`createAllDayEventSeries(title, startDate, recurrence)`

Cria uma nova série de eventos de dia inteiro.

// 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());

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	o título dos eventos da série
`startDate`	`Date`	a data do primeiro evento na série (somente o dia é usado; a hora é ignorada)
`recurrence`	`EventRecurrence`	as configurações de recorrência da série de eventos

Retornar

CalendarEventSeries: a série de eventos criada

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`createAllDayEventSeries(title, startDate, recurrence, options)`

Cria uma nova série de eventos de dia inteiro.

// 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());

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	o título dos eventos da série
`startDate`	`Date`	a data do primeiro evento na série (somente o dia é usado; a hora é ignorada)
`recurrence`	`EventRecurrence`	as configurações de recorrência da série de eventos
`options`	`Object`	um objeto JavaScript que especifica parâmetros avançados, como listado abaixo

Parâmetros avançados

Nome	Tipo	Descrição
`description`	`String`	a descrição dos eventos da série
`location`	`String`	o local dos eventos na série
`guests`	`String`	uma lista separada por vírgulas de endereços de e-mail que devem ser adicionados como convidados dos eventos da série
`sendInvites`	`Boolean`	se quer enviar e-mails de convite (padrão: `false`)

Retornar

CalendarEventSeries: a série de eventos criada

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`createEvent(title, startTime, endTime)`

Cria um novo evento.

Se nenhum fuso horário for especificado, os valores de tempo serão interpretados no contexto da solicitação que pode ser diferente do fuso horário da agenda.

// 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());

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	o título do evento
`startTime`	`Date`	a data e a hora de início do evento
`endTime`	`Date`	a data e a hora de término do evento

Retornar

CalendarEvent: o evento criado.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`createEvent(title, startTime, endTime, options)`

Cria um novo evento.

Se nenhum fuso horário for especificado, os valores de tempo serão interpretados no contexto da solicitação que pode ser diferente do fuso horário da agenda.

// 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());

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	o título do evento
`startTime`	`Date`	a data e a hora de início do evento
`endTime`	`Date`	a data e a hora de término do evento
`options`	`Object`	um objeto JavaScript que especifica parâmetros avançados, como listado abaixo

Parâmetros avançados

Nome	Tipo	Descrição
`description`	`String`	a descrição do evento
`location`	`String`	o local do evento
`guests`	`String`	uma lista separada por vírgulas de endereços de e-mail que devem ser adicionados como convidados
`sendInvites`	`Boolean`	se quer enviar e-mails de convite (padrão: `false`)

Retornar

CalendarEvent: o evento criado.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`createEventFromDescription(description)`

Cria um evento a partir de uma descrição em formato livre.

A descrição deve usar o mesmo formato do recurso "Adição rápida" da interface.

// 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());

Parâmetros

Nome	Tipo	Descrição
`description`	`String`	uma descrição em formato livre do evento

Retornar

CalendarEvent: o evento criado.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`createEventSeries(title, startTime, endTime, recurrence)`

Cria uma nova série de eventos.

// 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());

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	o título dos eventos da série
`startTime`	`Date`	a data e a hora em que o primeiro evento da série começa
`endTime`	`Date`	a data e a hora em que o primeiro evento da série termina
`recurrence`	`EventRecurrence`	as configurações de recorrência da série de eventos

Retornar

CalendarEventSeries: a série de eventos criada

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`createEventSeries(title, startTime, endTime, recurrence, options)`

Cria uma nova série de eventos.

// 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());

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	o título dos eventos da série
`startTime`	`Date`	a data e a hora em que o primeiro evento da série começa
`endTime`	`Date`	a data e a hora em que o primeiro evento da série termina
`recurrence`	`EventRecurrence`	as configurações de recorrência da série de eventos
`options`	`Object`	um objeto JavaScript que especifica parâmetros avançados, como listado abaixo

Parâmetros avançados

Nome	Tipo	Descrição
`description`	`String`	a descrição dos eventos da série
`location`	`String`	o local dos eventos na série
`guests`	`String`	uma lista separada por vírgulas de endereços de e-mail que devem ser adicionados como convidados dos eventos da série
`sendInvites`	`Boolean`	se quer enviar e-mails de convite (padrão: `false`)

Retornar

CalendarEventSeries: a série de eventos criada

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`deleteCalendar()`

Exclui a agenda permanentemente. Um usuário só pode excluir a própria agenda.

// Creates a calendar to delete.
const calendar = CalendarApp.createCalendar('Test');

// Deletes the 'Test' calendar permanently.
calendar.deleteCalendar();

Gera

Error: se a agenda for importada.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`getColor()`

Recebe a cor da agenda.

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

Retornar

String: uma string de cor hexadecimal ("#rrggbb").

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`getDescription()`

Recebe a descrição da agenda.

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

Retornar

String: a descrição da agenda.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`getEventById(iCalId)`

Extrai o evento com o ID fornecido. Se a série pertence a uma agenda diferente da padrão agenda, será necessário chamar esse método usando essa agenda. Ligando apenas para CalendarApp.getEventById(iCalId) retorna um evento da agenda padrão.

Vários eventos poderão ter o mesmo ID se fizerem parte de uma série de eventos. Nesse caso, retorna apenas o primeiro evento dessa série.

// 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());

Parâmetros

Nome	Tipo	Descrição
`iCalId`	`String`	ID do evento.

Retornar

CalendarEvent: o evento com o ID fornecido ou null se o evento não existir ou o usuário não pode acessá-lo.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`getEventSeriesById(iCalId)`

Extrai a série de eventos com o ID fornecido. Se o ID fornecido for para uma única CalendarEvent, um CalendarEventSeries é retornado com um único evento na série. Observe que, se a série de eventos pertencer a uma agenda diferente da agenda padrão, esse método deverá ser chamados nesse Calendar; ligando para CalendarApp.getEventSeriesById(iCalId) retorna diretamente somente uma série de eventos que existe na agenda padrão.

// 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());

Parâmetros

Nome	Tipo	Descrição
`iCalId`	`String`	ID da série de eventos.

Retornar

CalendarEventSeries: a série com o ID fornecido ou null se a série não existir ou o usuário não pode acessá-lo.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`getEvents(startTime, endTime)`

Recebe todos os eventos que ocorrem em um determinado período.

Esse método retorna eventos que começam durante o período especificado e terminam durante o período ou abranger o período. Se nenhum fuso horário for especificado, os valores de tempo serão interpretado no contexto do fuso horário do script, que pode ser diferente do fuso horário fuso horário da agenda.

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

Parâmetros

Nome	Tipo	Descrição
`startTime`	`Date`	o início do período
`endTime`	`Date`	o fim do período, não inclusivos

Retornar

CalendarEvent[]: os eventos que ocorrem no período

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`getEvents(startTime, endTime, options)`

Recebe todos os eventos que ocorrem em um determinado período e que atendem aos critérios especificados.

Esse método retorna eventos que começam durante o período especificado e terminam durante o período ou abrange o período. Se nenhum fuso horário for especificado, os valores de tempo serão interpretado no contexto do fuso horário do script, que pode ser diferente do fuso horário fuso horário da agenda.

A filtragem de author, search ou statusFilters leva depois de aplicar start e max. Isso significa que o número de eventos retornados podem ser menores que max, mesmo que os eventos adicionais atendam aos critérios.

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

Parâmetros

Nome	Tipo	Descrição
`startTime`	`Date`	o início do período
`endTime`	`Date`	o fim do período, não inclusivos
`options`	`Object`	um objeto JavaScript que especifica parâmetros avançados, como listado abaixo

Parâmetros avançados

Nome	Tipo	Descrição
`start`	`Integer`	o índice do primeiro evento a ser retornado
`max`	`Integer`	o número máximo de eventos a serem retornados
`author`	`String`	um endereço de e-mail usado para filtrar resultados pelo criador do evento
`search`	`String`	uma consulta de pesquisa de texto completo usada para filtrar resultados
`statusFilters[]`	`GuestStatus`	uma matriz de status usada para filtrar resultados

Retornar

CalendarEvent[]: os eventos que ocorrem no período e correspondem aos critérios.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`getEventsForDay(date)`

Recebe todos os eventos que ocorrem em um determinado dia.

Esse método retorna eventos se eles começarem durante o dia especificado, terminarem durante o dia ou que abrangem o dia.

Observe que apenas a parte da data do objeto Date é usada, e a parte da hora é ignorada. A data é interpretada como meia-noite desse dia até meia-noite do dia seguinte no horário zona.

// Determines how many events are happening today.
var today = new Date();
var events = CalendarApp.getDefaultCalendar().getEventsForDay(today);
Logger.log('Number of events: ' + events.length);

Parâmetros

Nome	Tipo	Descrição
`date`	`Date`	a data para a qual recuperar eventos (somente o dia é usado; a hora é ignorada)

Retornar

CalendarEvent[]: os eventos que ocorrem na data especificada

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`getEventsForDay(date, options)`

Recebe todos os eventos que ocorrem em um determinado dia e atendem aos critérios especificados.

Esse método retorna eventos se eles começarem durante o dia especificado, terminarem durante o dia ou que abrangem o dia.

Observe que apenas a parte da data do objeto Date é usada, e a parte da hora é ignorada. A data é interpretada como meia-noite desse dia até meia-noite do dia seguinte no horário zona.

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

Parâmetros

Nome	Tipo	Descrição
`date`	`Date`	a data para a qual recuperar eventos (somente o dia é usado; a hora é ignorada)
`options`	`Object`	opções de filtragem avançada

Parâmetros avançados

Nome	Tipo	Descrição
`start`	`Integer`	o índice do primeiro evento a ser retornado
`max`	`Integer`	o número máximo de eventos a serem retornados
`author`	`String`	um endereço de e-mail usado para filtrar resultados pelo criador do evento
`search`	`String`	uma consulta de pesquisa de texto completo usada para filtrar resultados
`statusFilters[]`	`GuestStatus`	uma matriz de status usada para filtrar resultados

Retornar

CalendarEvent[]: os eventos que ocorrem na data especificada e correspondem aos critérios.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`getId()`

Recebe o ID da agenda. O ID da agenda padrão de um usuário é o endereço de e-mail dele.

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

Retornar

String: o ID da agenda.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`getName()`

Recebe o nome da agenda.

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

Retornar

String: o nome desta agenda.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`getTimeZone()`

Acessa o fuso horário da agenda.

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

Retornar

String: o fuso horário, especificado em "longo" formato (por exemplo, "America/New_York", conforme listado por Joda.org).

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`isHidden()`

Determina se a agenda está oculta na interface do usuário.

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

Retornar

Boolean: true se a agenda estiver oculta na interface do usuário. false se não é.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`isMyPrimaryCalendar()`

Determina se a agenda é a principal do usuário efetivo.

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

Retornar

Boolean: true se a agenda for a padrão do usuário em vigor. false, se não for.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`isOwnedByMe()`

Determina se a agenda é sua.

// 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());

Retornar

Boolean: true se a agenda pertencer a você Caso contrário, false.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`isSelected()`

Determina se os eventos da agenda são exibidos na interface do usuário.

// 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());

Retornar

Boolean: true se os eventos da agenda forem exibidos na interface do usuário. false se não for

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`setColor(color)`

Define a cor do calendário.

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

Parâmetros

Nome	Tipo	Descrição
`color`	`String`	Uma `CalendarApp.Color` ou uma string de cor hexadecimal (#rrggbb).

Retornar

Calendar: é a agenda para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`setDescription(description)`

Define a descrição de uma agenda.

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

Parâmetros

Nome	Tipo	Descrição
`description`	`String`	a descrição desta agenda

Retornar

Calendar: esta agenda para encadeamento

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`setHidden(hidden)`

Define se a agenda ficará visível na interface do usuário.

Parâmetros

Nome	Tipo	Descrição
`hidden`	`Boolean`	`true` para ocultar a agenda na interface do usuário. `false` para mostrar

Retornar

Calendar: esta agenda para encadeamento

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`setName(name)`

Define o nome da agenda.

// 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');

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	o novo nome

Retornar

Calendar: esta agenda para encadeamento

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`setSelected(selected)`

Define se os eventos da agenda serão exibidos na interface do usuário.

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

Parâmetros

Nome	Tipo	Descrição
`selected`	`Boolean`	`true` para mostrar os eventos da agenda na interface do usuário. `false` para ocultá-los

Retornar

Calendar: esta agenda para encadeamento

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`setTimeZone(timeZone)`

Define o fuso horário da agenda.

// 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');

Parâmetros

Nome	Tipo	Descrição
`timeZone`	`String`	O fuso horário, especificado em "longo" formato (como "América/Nova_York", como listados por Joda.org).

Retornar

Calendar: é a agenda para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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

`unsubscribeFromCalendar()`

Cancela a inscrição do usuário em uma agenda. Um usuário não pode cancelar a inscrição nas agendas listadas no Minhas agendas. Eles podem cancelar a inscrição nas agendas listadas em Outros agendas.

// 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();

Gera

Error: se a agenda for própria

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

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