Esta página foi traduzida pela API Cloud Translation.

Class CalendarApp

Permite que um script leia e atualize o Google Agenda do usuário. Essa classe oferece acesso direto à agenda padrão do usuário, além da capacidade de recuperar outras agendas que o usuário possui ou está inscrito.

Propriedades

Propriedade	Tipo	Descrição
`Color`	`Color`	Um tipo enumerado que representa as cores nomeadas disponíveis no serviço de agenda.
`EventColor`	`EventColor`	Um tipo enumerado que representa as cores de eventos nomeados disponíveis no serviço de agenda.
`EventType`	`EventType`	A enumeração `EventType`.
`GuestStatus`	`GuestStatus`	Um tipo enumerado que representa os status que um convidado pode ter em um evento.
`Month`	`Month`	Um tipo enumerado que representa os meses do ano.
`Visibility`	`Visibility`	Um tipo enumerado que representa a visibilidade de um evento.
`Weekday`	`Weekday`	Um tipo enumerado que representa os dias da semana.

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 durar vários dias.
`createAllDayEvent(title, startDate, endDate, options)`	`CalendarEvent`	Cria um novo evento de dia inteiro que pode durar 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.
`createCalendar(name)`	`Calendar`	Cria uma nova agenda, que é de propriedade do usuário.
`createCalendar(name, options)`	`Calendar`	Cria uma nova agenda, que é de propriedade do usuário.
`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 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.
`getAllCalendars()`	`Calendar[]`	Retorna todas as agendas que o usuário possui ou a que está inscrito.
`getAllOwnedCalendars()`	`Calendar[]`	Retorna todas as agendas do usuário.
`getCalendarById(id)`	`Calendar`	Consegue a agenda com o ID fornecido.
`getCalendarsByName(name)`	`Calendar[]`	Recebe todas as agendas com um determinado nome que o usuário possui ou em que está inscrito.
`getColor()`	`String`	Recebe a cor da agenda.
`getDefaultCalendar()`	`Calendar`	Consegue a agenda padrão do usuário.
`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[]`	Mostra 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`	Consegue o ID da agenda.
`getName()`	`String`	Recebe o nome da agenda.
`getOwnedCalendarById(id)`	`Calendar`	Recupera a agenda com o ID fornecido, se o usuário for o proprietário.
`getOwnedCalendarsByName(name)`	`Calendar[]`	Recebe todas as agendas com um determinado nome que pertencem ao usuário.
`getTimeZone()`	`String`	Recebe o fuso horário da agenda.
`isHidden()`	`Boolean`	Determina se o calendário está oculto 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.
`newRecurrence()`	`EventRecurrence`	Cria um novo objeto de recorrência, que pode ser usado para criar regras de recorrência de eventos.
`setColor(color)`	`Calendar`	Define a cor do calendário.
`setDescription(description)`	`Calendar`	Define a descrição de uma agenda.
`setHidden(hidden)`	`Calendar`	Define se o calendário está 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.
`subscribeToCalendar(id)`	`Calendar`	Inscreve o usuário na agenda com o ID fornecido, se ele tiver permissão para isso.
`subscribeToCalendar(id, options)`	`Calendar`	Inscreve o usuário na agenda com o ID fornecido, se ele tiver permissão para isso.

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.
const 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 seguintes escopos ou escopos adequados 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 durar vários dias.

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

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, a hora é ignorada).
`endDate`	`Date`	A data em que o evento termina (somente o dia é usado; 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 seguintes escopos ou escopos adequados 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 durar vários dias.

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

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, a hora é ignorada).
`endDate`	`Date`	A data em que o evento termina (somente o dia é usado; o horário é ignorado). 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 de endereços de e-mail que precisam ser adicionados como convidados.
`sendInvites`	`Boolean`	Define 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 seguintes escopos ou escopos adequados 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.
const 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 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 de endereços de e-mail que precisam ser adicionados como convidados.
`sendInvites`	`Boolean`	Define 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 seguintes escopos ou escopos adequados 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.
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()}`);

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, 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 exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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.
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()}`);

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, 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, conforme 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 da série
`guests`	`String`	uma lista de endereços de e-mail separados por vírgulas que precisam ser adicionados como convidados aos eventos da 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 seguintes escopos ou escopos adequados da API REST relacionada:

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

`createCalendar(name)`

Cria uma nova agenda, que é de propriedade do usuário.

// Creates a new calendar named "Travel Plans".
const calendar = CalendarApp.createCalendar('Travel Plans');
Logger.log(
    'Created the calendar "%s", with the ID "%s".',
    calendar.getName(),
    calendar.getId(),
);

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	o nome da nova agenda;

Retornar

Calendar: a agenda recém-criada

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

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

`createCalendar(name, options)`

Cria uma nova agenda, que é de propriedade do usuário.

// Creates a new calendar named "Travel Plans" with a description and color.
const calendar = CalendarApp.createCalendar('Travel Plans', {
  description: 'A calendar to plan my travel schedule.',
  color: CalendarApp.Color.BLUE,
});
Logger.log(
    'Created the calendar "%s", with the ID "%s".',
    calendar.getName(),
    calendar.getId(),
);

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	o nome da nova agenda;
`options`	`Object`	um objeto JavaScript que especifica parâmetros avançados, conforme listado abaixo

Parâmetros avançados

Nome	Tipo	Descrição
`location`	`String`	o local da agenda
`description`	`String`	a descrição da agenda;
`timeZone`	`String`	o fuso horário para definir a agenda, especificado no formato "long" (por exemplo, "América/Nova_York", conforme listado em Joda.org.
`color`	`String`	uma string de cor hexadecimal ("#rrggbb") ou um valor de `CalendarApp.Colors`
`hidden`	`Boolean`	se o calendário está oculto na interface do usuário (padrão: `false`)
`selected`	`Boolean`	Indica se os eventos da agenda são mostrados na interface do usuário (padrão: `true`)

Retornar

Calendar: a agenda recém-criada

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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 horário serão interpretados no contexto do fuso horário do script, que pode ser diferente do fuso horário do calendário.

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

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 seguintes escopos ou escopos adequados 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 horário serão interpretados no contexto do fuso horário do script, que pode ser diferente do fuso horário do calendário.

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

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 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 de endereços de e-mail separados por vírgulas 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 seguintes escopos ou escopos adequados 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 Adicionar rapidamente da interface.

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

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 exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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.
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()}`);

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 exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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.
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()}`);

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, conforme 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 da série
`guests`	`String`	uma lista de endereços de e-mail separados por vírgulas que precisam ser adicionados como convidados aos eventos da 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 seguintes escopos ou escopos adequados da API REST relacionada:

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

`getAllCalendars()`

Retorna todas as agendas que o usuário possui ou a que está inscrito.

// Determines how many calendars the user can access.
const calendars = CalendarApp.getAllCalendars();
Logger.log(
    'This user owns or is subscribed to %s calendars.',
    calendars.length,
);

Retornar

Calendar[]: todas as agendas que o usuário pode acessar

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

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

`getAllOwnedCalendars()`

Retorna todas as agendas do usuário.

// Determines how many calendars the user owns.
const calendars = CalendarApp.getAllOwnedCalendars();
Logger.log('This user owns %s calendars.', calendars.length);

Retornar

Calendar[]: todas as agendas que pertencem ao usuário

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

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

`getCalendarById(id)`

Consegue a agenda com o ID fornecido.

// Gets the public calendar "US Holidays" by ID.
const calendar = CalendarApp.getCalendarById(
    'en.usa#holiday@group.v.calendar.google.com',
);
Logger.log('The calendar is named "%s".', calendar.getName());

Parâmetros

Nome	Tipo	Descrição
`id`	`String`	o ID da agenda

Retornar

Calendar: a agenda com o ID fornecido ou null se ela não existir, se o usuário não puder acessá-la ou se não estiver inscrito nela.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

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

`getCalendarsByName(name)`

Recebe todas as agendas com um determinado nome que o usuário possui ou em que está inscrito. Os nomes não diferenciam maiúsculas de minúsculas.

// Gets the public calendar named "US Holidays".
const calendars = CalendarApp.getCalendarsByName('US Holidays');
Logger.log('Found %s matching calendars.', calendars.length);

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	o nome da agenda

Retornar

Calendar[]: todas as agendas com esse nome que o usuário pode acessar

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
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 exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

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

`getDefaultCalendar()`

Consegue a agenda padrão do usuário.

// Determines the time zone of the user's default calendar.
const calendar = CalendarApp.getDefaultCalendar();
Logger.log(
    'My default calendar is set to the time zone "%s".',
    calendar.getTimeZone(),
);

Retornar

Calendar: a agenda padrão do usuário

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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 do calendário.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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 um calendário diferente do padrão, este método precisará ser chamado desse calendário. Chamar 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 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 existe ou o usuário não pode acessá-lo.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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 um único CalendarEvent, um CalendarEventSeries será retornado com um único evento na série. Se a série de eventos pertencer a uma agenda diferente da padrão, esse método precisará ser chamado dessa CalendarApp. Chamar getEventSeriesById(iCalId) diretamente só retornará 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 puder acessá-la.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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, terminam ou englobam o período de tempo especificado. Se nenhum fuso horário for especificado, os valores de tempo serão interpretados no contexto do fuso horário do script, que pode ser diferente do do calendário.

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

Parâmetros

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

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 seguintes escopos ou escopos adequados 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 a aplicação de 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".
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}`);

Parâmetros

Nome	Tipo	Descrição
`startTime`	`Date`	o início do período
`endTime`	`Date`	o fim do período, não incluído
`options`	`Object`	um objeto JavaScript que especifica parâmetros avançados, conforme 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 usados 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 seguintes escopos ou escopos adequados 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)`

Mostra todos os eventos que ocorrem em um determinado dia.

Esse método retorna eventos se eles começarem, terminarem ou abarcarem o dia.

Somente a parte de data do objeto Date é usada, e a parte de hora é ignorada. A data é interpretada como a meia-noite daquele dia até a meia-noite do dia seguinte no fuso horário do calendário.

// Determines how many events are happening today.
const today = new Date();
const events = CalendarApp.getDefaultCalendar().getEventsForDay(today);
Logger.log(`Number of events: ${events.length}`);

Parâmetros

Nome	Tipo	Descrição
`date`	`Date`	a data para 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 exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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, terminarem ou abarcarem o dia.

Somente a parte de data do objeto Date é usada, e a parte de hora é ignorada. A data é interpretada como a meia-noite daquele dia até a meia-noite do dia seguinte no fuso horário do calendário.

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

Parâmetros

Nome	Tipo	Descrição
`date`	`Date`	a data para 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 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 usados 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 seguintes escopos ou escopos adequados da API REST relacionada:

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

`getId()`

Consegue 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 exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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 da agenda.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

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

`getOwnedCalendarById(id)`

Recupera a agenda com o ID fornecido, se o usuário for o proprietário.

Para encontrar um ID, clique na seta ao lado do nome da agenda no Google Agenda e selecione Configurações da agenda. O ID aparece na parte de baixo da página de configurações.

// Gets a (non-existent) private calendar by ID.
const calendar = CalendarApp.getOwnedCalendarById(
    '123456789@group.calendar.google.com',
);
Logger.log('The calendar is named "%s".', calendar.getName());

Parâmetros

Nome	Tipo	Descrição
`id`	`String`	o ID da agenda

Retornar

Calendar: a agenda com o ID fornecido ou null se a agenda não existir ou o usuário não for o proprietário

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

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

`getOwnedCalendarsByName(name)`

Recebe todas as agendas com um determinado nome que pertencem ao usuário. Os nomes não diferenciam maiúsculas de minúsculas.

// Gets a private calendar named "Travel Plans".
const calendars = CalendarApp.getOwnedCalendarsByName('Travel Plans');
Logger.log('Found %s matching calendars.', calendars.length);

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	o nome da agenda

Retornar

Calendar[]: todas as agendas com esse nome que pertencem ao usuário

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

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

`getTimeZone()`

Recebe 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 no formato "long" (por exemplo, "America/New_York", conforme listado por Joda.org).

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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 o calendário está oculto 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 estiver.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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 é a padrão do 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 seguintes escopos ou escopos adequados 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 for sua; false, caso contrário.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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 são exibidos na interface do usuário; false, caso contrário.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

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

`newRecurrence()`

Cria um novo objeto de recorrência, que pode ser usado para criar regras de recorrência de eventos.

// Creates an event series for a no-meetings day, taking place every Wednesday
// in 2013.
const recurrence = CalendarApp.newRecurrence()
                       .addWeeklyRule()
                       .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
                       .until(new Date('January 1, 2014'));
const eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries(
    'No Meetings',
    new Date('January 2, 2013 03:00:00 PM EST'),
    recurrence,
);
Logger.log(`Event Series ID: ${eventSeries.getId()}`);

Retornar

EventRecurrence: um novo objeto de recorrência sem regras definidas (se comporta como uma recorrência semanal)

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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: esta agenda para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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 exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

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

`setHidden(hidden)`

Define se o calendário está 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 mostrar.

Retornar

Calendar: esta agenda para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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 exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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.

// 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 e `false` para ocultá-los.

Retornar

Calendar: esta agenda para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados 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 no formato "longo" (por exemplo, "América/Nova_York", conforme listado pela Joda.org).

Retornar

Calendar: esta agenda para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

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

`subscribeToCalendar(id)`

Inscreve o usuário na agenda com o ID fornecido, se ele tiver permissão para isso.

// Subscribe to the calendar "US Holidays".
const calendar = CalendarApp.subscribeToCalendar(
    'en.usa#holiday@group.v.calendar.google.com',
);
Logger.log('Subscribed to the calendar "%s".', calendar.getName());

Parâmetros

Nome	Tipo	Descrição
`id`	`String`	o ID da agenda para assinar

Retornar

Calendar: a agenda que você acabou de assinar

Gera

Error: se não houver uma agenda com esse ID

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

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

`subscribeToCalendar(id, options)`

Inscreve o usuário na agenda com o ID fornecido, se ele tiver permissão para isso.

// Subscribe to the calendar "US Holidays", and set it to the color blue.
const calendar = CalendarApp.subscribeToCalendar(
    'en.usa#holiday@group.v.calendar.google.com',
    {color: CalendarApp.Color.BLUE},
);
Logger.log('Subscribed to the calendar "%s".', calendar.getName());

Parâmetros

Nome	Tipo	Descrição
`id`	`String`	O ID da agenda para assinar.
`options`	`Object`	Um objeto JavaScript que especifica parâmetros avançados, conforme listado abaixo.

Parâmetros avançados

Nome	Tipo	Descrição
`color`	`String`	Uma string de cor hexadecimal ("#rrggbb") ou um valor de `CalendarApp.Colors`.
`hidden`	`Boolean`	Indica se o calendário está oculto na interface do usuário (padrão: `false`).
`selected`	`Boolean`	Indica se os eventos da agenda são mostrados na interface do usuário (padrão: `true` se `color` também for especificado, `false` caso contrário).

Retornar

Calendar: a agenda que você acabou de assinar.

Gera

Error: se não houver uma agenda com esse ID

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

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