Esta página foi traduzida pela API Cloud Translation.

Class Calendar

Representa um calendário do qual o usuário é proprietário ou está inscrito.

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 com duração de vários dias.
`createAllDayEvent(title, startDate, endDate, options)`	`CalendarEvent`	Cria um novo evento de dia inteiro com duração de 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 evento.
`createEvent(title, startTime, endTime, options)`	`CalendarEvent`	Cria um evento.
`createEventFromDescription(description)`	`CalendarEvent`	Cria um evento com base em 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`	Recebe o evento com o ID fornecido.
`getEventSeriesById(iCalId)`	`CalendarEventSeries`	Recebe 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 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 o calendário é o padrão para o usuário efetivo.
`isOwnedByMe()`	`Boolean`	Determina se o usuário é o proprietário da agenda.
`isSelected()`	`Boolean`	Determina se os eventos da agenda são exibidos na interface do usuário.
`setColor(color)`	`Calendar`	Define a cor da agenda.
`setDescription(description)`	`Calendar`	Define a descrição da agenda.
`setHidden(hidden)`	`Calendar`	Define se a agenda é visível na interface do usuário.
`setName(name)`	`Calendar`	Define o nome da agenda.
`setSelected(selected)`	`Calendar`	Define se os eventos da agenda sã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 na 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, o horário é ignorado).

Retornar

CalendarEvent: o evento criado.

Autorização

Os scripts que usam esse método exigem 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 com duração de 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 de início do evento (somente o dia é usado, o horário é ignorado).
`endDate`	`Date`	A data de término do evento (somente o dia, o horário ignorado). A data de término é exclusiva.

Retornar

CalendarEvent: o evento criado.

Autorização

Os scripts que usam esse método exigem 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 com duração de 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 de início do evento (somente o dia é usado, o horário é ignorado).
`endDate`	`Date`	A data de término do evento (somente o dia, o horário ignorado). A data de término é exclusiva.
`options`	`Object`	Um objeto JavaScript que especifica os 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 precisam ser adicionados como convidados.
`sendInvites`	`Boolean`	Se os e-mails de convite serão enviados (padrão: `false`).

Retornar

CalendarEvent: o evento criado.

Autorização

Os scripts que usam esse método exigem 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, o horário é ignorado).
`options`	`Object`	Um objeto JavaScript que especifica os 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 precisam ser adicionados como convidados.
`sendInvites`	`Boolean`	Se os e-mails de convite serão enviados (padrão: `false`).

Retornar

CalendarEvent: o evento criado.

Autorização

Os scripts que usam esse método exigem 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 da série (somente o dia é usado, o horário é ignorado);
`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 exigem 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 da série (somente o dia é usado, o horário é ignorado);
`recurrence`	`EventRecurrence`	as configurações de recorrência da série de eventos
`options`	`Object`	um objeto JavaScript que especifica os 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 precisam ser adicionados como convidados aos eventos na série
`sendInvites`	`Boolean`	se os e-mails de convite serão enviados (padrão: `false`)

Retornar

CalendarEventSeries: a série de eventos criada.

Autorização

Os scripts que usam esse método exigem 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 evento.

Se nenhum fuso horário for especificado, os valores serão interpretados no contexto do fuso horário do script, 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 em que o evento começa;
`endTime`	`Date`	a data e a hora em que o evento termina

Retornar

CalendarEvent: o evento criado.

Autorização

Os scripts que usam esse método exigem 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 evento.

Se nenhum fuso horário for especificado, os valores serão interpretados no contexto do fuso horário do script, 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 em que o evento começa;
`endTime`	`Date`	a data e a hora em que o evento termina
`options`	`Object`	um objeto JavaScript que especifica os 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 precisam ser adicionados como convidados
`sendInvites`	`Boolean`	se os e-mails de convite serão enviados (padrão: `false`)

Retornar

CalendarEvent: o evento criado.

Autorização

Os scripts que usam esse método exigem 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 com base em uma descrição em formato livre.

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

// 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 livre do evento

Retornar

CalendarEvent: o evento criado.

Autorização

Os scripts que usam esse método exigem 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 o horário 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 exigem 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 o horário 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 os 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 precisam ser adicionados como convidados aos eventos na série
`sendInvites`	`Boolean`	se os e-mails de convite serão enviados (padrão: `false`)

Retornar

CalendarEventSeries: a série de eventos criada.

Autorização

Os scripts que usam esse método exigem 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.

Gera

Error: se esta for uma agenda importada.

Autorização

Os scripts que usam esse método exigem 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.

Retornar

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

Autorização

Os scripts que usam esse método exigem 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.

Retornar

String: a descrição desta agenda

Autorização

Os scripts que usam esse método exigem 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)`

Recebe o evento com o ID fornecido. Se a série pertencer a uma agenda diferente da agenda padrão, esse método precisará ser chamado nessa agenda. Chamar CalendarApp.getEventById(iCalId) só retorna um evento na agenda padrão.

Vários eventos podem ter o mesmo ID se fizerem parte de uma série de eventos. Nesse caso, esse método retorna apenas o primeiro evento da série.

Parâmetros

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

Retornar

CalendarEvent: o evento com o código fornecido ou null se o evento não existir ou se o usuário não puder acessá-lo.

Autorização

Os scripts que usam esse método exigem 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)`

Recebe a série de eventos com o ID fornecido. Se o ID fornecido for para uma única CalendarEvent, uma CalendarEventSeries será retornada com um único evento na série. Se a série de eventos pertencer a uma agenda diferente da agenda padrão, esse método precisará ser chamado a partir dessa Calendar. Chamar CalendarApp.getEventSeriesById(iCalId) retorna diretamente apenas uma série de eventos que existe na agenda padrão.

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 se o usuário não conseguir acessá-la

Autorização

Os scripts que usam esse método exigem 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, terminam durante o período ou abrangem o intervalo de tempo. Se nenhum fuso horário for especificado, os valores serão interpretados no contexto do fuso horário do script, que pode ser diferente do 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 inclusivo

Retornar

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

Autorização

Os scripts que usam esse método exigem 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 atendem aos critérios especificados.

A filtragem em author, search ou statusFilters ocorre após aplicar start e max. Isso significa que o número de eventos retornados pode ser menor que max, mesmo que outros eventos 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 inclusivo
`options`	`Object`	um objeto JavaScript que especifica os 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 os 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 exigem 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 que começam durante o dia especificado, terminam durante o dia ou abrangem o dia.

Somente a parte da data do objeto de data é usada e a parte da hora é ignorada. A data é interpretada como meia-noite do dia seguinte à meia-noite do dia seguinte no fuso horário da agenda.

// 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 os eventos serão recuperados (somente o dia é usado, o horário é ignorado).

Retornar

CalendarEvent[]: os eventos que ocorrem na data especificada.

Autorização

Os scripts que usam esse método exigem 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 que começam durante o dia especificado, terminam durante o dia ou abrangem o dia.

Somente a parte da data do objeto de data é usada e a parte da hora é ignorada. A data é interpretada como meia-noite do dia seguinte à meia-noite do dia seguinte no fuso horário da agenda.

// 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 os eventos serão recuperados (somente o dia é usado, o horário é ignorado).
`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 os 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 exigem 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.

Retornar

String: o ID da agenda

Autorização

Os scripts que usam esse método exigem 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.

Retornar

String: nome desta agenda

Autorização

Os scripts que usam esse método exigem 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.

Retornar

String: o fuso horário, especificado no formato "longo" (por exemplo, "EUA/Nova_York", conforme listado por Joda.org)

Autorização

Os scripts que usam esse método exigem 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.

Retornar

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

Autorização

Os scripts que usam esse método exigem 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 o calendário é o padrão para o usuário efetivo.

Retornar

Boolean: true se a agenda for a agenda padrão do usuário efetivo. Caso contrário, será false

Autorização

Os scripts que usam esse método exigem 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 o usuário é o proprietário da agenda.

Retornar

Boolean — true se a agenda pertencer ao usuário efetivo. false se não for

Autorização

Os scripts que usam esse método exigem 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.

Retornar

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

Autorização

Os scripts que usam esse método exigem 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 da agenda.

Parâmetros

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

Retornar

Calendar: esta agenda para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 da agenda.

Parâmetros

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

Retornar

Calendar: esta agenda para encadeamentos

Autorização

Os scripts que usam esse método exigem 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 é 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 e `false` para a mostrar

Retornar

Calendar: esta agenda para encadeamentos

Autorização

Os scripts que usam esse método exigem 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.

Parâmetros

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

Retornar

Calendar: esta agenda para encadeamentos

Autorização

Os scripts que usam esse método exigem 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 são exibidos na interface do usuário.

Parâmetros

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

Retornar

Calendar: esta agenda para encadeamentos

Autorização

Os scripts que usam esse método exigem 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.

Parâmetros

Nome	Tipo	Descrição
`timeZone`	`String`	o fuso horário, especificado no formato "longo" (por exemplo, "EUA/Nova_York", conforme listado por Joda.org)

Retornar

Calendar: esta agenda para encadeamentos

Autorização

Os scripts que usam esse método exigem 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 na agenda. Um usuário não pode cancelar a inscrição em uma agenda que pertence a ele.

Gera

Error: se a agenda for sua.

Autorização

Os scripts que usam esse método exigem 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