Esta página foi traduzida pela API Cloud Translation.

Class CalendarEvent

Representa um único evento da agenda.

Métodos

Método	Tipo de retorno	Breve descrição
`addEmailReminder(minutesBefore)`	`CalendarEvent`	Adiciona um novo lembrete por e-mail ao evento.
`addGuest(email)`	`CalendarEvent`	Adiciona um convidado ao evento.
`addPopupReminder(minutesBefore)`	`CalendarEvent`	Adiciona uma nova notificação pop-up ao evento.
`addSmsReminder(minutesBefore)`	`CalendarEvent`	Adiciona um novo lembrete por SMS ao evento.
`anyoneCanAddSelf()`	`Boolean`	Determina se as pessoas podem se adicionar como convidados a um evento da Agenda.
`deleteEvent()`	`void`	Exclui um evento do Google Agenda.
`deleteTag(key)`	`CalendarEvent`	Exclui uma tag de chave-valor do evento.
`getAllDayEndDate()`	`Date`	Recebe a data de término desse evento da agenda de dia inteiro.
`getAllDayStartDate()`	`Date`	Recebe a data de início desse evento de dia inteiro.
`getAllTagKeys()`	`String[]`	Recebe todas as chaves das tags que foram definidas no evento.
`getColor()`	`String`	Retorna a cor do evento da agenda.
`getCreators()`	`String[]`	Extrai os criadores de um evento.
`getDateCreated()`	`Date`	Recebe a data de criação do evento.
`getDescription()`	`String`	Extrai a descrição do evento.
`getEmailReminders()`	`Integer[]`	Recebe os valores dos minutos de todos os lembretes por e-mail para o evento.
`getEndTime()`	`Date`	Recebe a data e a hora de término deste evento da agenda.
`getEventSeries()`	`CalendarEventSeries`	Recebe a série de eventos recorrentes aos quais este evento pertence.
`getGuestByEmail(email)`	`EventGuest`	Recebe um convidado por endereço de e-mail.
`getGuestList()`	`EventGuest[]`	Extrai os convidados do evento, sem incluir o proprietário do evento.
`getGuestList(includeOwner)`	`EventGuest[]`	Extrai os convidados do evento, potencialmente incluindo os proprietários do evento.
`getId()`	`String`	Recebe o iCalUID exclusivo do evento.
`getLastUpdated()`	`Date`	Recebe a data em que o evento foi atualizado pela última vez.
`getLocation()`	`String`	Recebe o local do evento.
`getMyStatus()`	`GuestStatus`	Gera o status do evento (como comparecer ou convidado) do usuário em vigor.
`getOriginalCalendarId()`	`String`	Encontre o ID da agenda onde esse evento foi criado originalmente.
`getPopupReminders()`	`Integer[]`	Recebe os valores dos minutos de todos os lembretes pop-up para o evento.
`getSmsReminders()`	`Integer[]`	Recebe os valores dos minutos de todos os lembretes por SMS do evento.
`getStartTime()`	`Date`	Recupera a data e a hora de início do evento da agenda.
`getTag(key)`	`String`	Recebe um valor da tag do evento.
`getTitle()`	`String`	Extrai o título do evento.
`getVisibility()`	`Visibility`	Recebe a visibilidade do evento.
`guestsCanInviteOthers()`	`Boolean`	Determina se os convidados podem convidar outras pessoas.
`guestsCanModify()`	`Boolean`	Determina se os convidados podem modificar o evento.
`guestsCanSeeGuests()`	`Boolean`	Determina se convidados podem ver outros convidados.
`isAllDayEvent()`	`Boolean`	Determina se é um evento de dia inteiro.
`isOwnedByMe()`	`Boolean`	Determina se você é o proprietário do evento.
`isRecurringEvent()`	`Boolean`	Determina se o evento faz parte de uma série de eventos.
`removeAllReminders()`	`CalendarEvent`	Remove todos os lembretes do evento.
`removeGuest(email)`	`CalendarEvent`	Remove um convidado do evento.
`resetRemindersToDefault()`	`CalendarEvent`	Redefinir os lembretes usando as configurações padrão da agenda.
`setAllDayDate(date)`	`CalendarEvent`	Define a data do evento.
`setAllDayDates(startDate, endDate)`	`CalendarEvent`	Define as datas do evento.
`setAnyoneCanAddSelf(anyoneCanAddSelf)`	`CalendarEvent`	Define se pessoas que não são convidados podem se adicionar ao evento.
`setColor(color)`	`CalendarEvent`	Define a cor do evento da agenda.
`setDescription(description)`	`CalendarEvent`	Define a descrição do evento.
`setGuestsCanInviteOthers(guestsCanInviteOthers)`	`CalendarEvent`	Define se os convidados podem convidar outras pessoas.
`setGuestsCanModify(guestsCanModify)`	`CalendarEvent`	Define se os convidados podem modificar o evento.
`setGuestsCanSeeGuests(guestsCanSeeGuests)`	`CalendarEvent`	Define se os convidados podem ver outros convidados.
`setLocation(location)`	`CalendarEvent`	Define o local do evento.
`setMyStatus(status)`	`CalendarEvent`	Define o status do evento (como participar ou convidado) do usuário em vigor.
`setTag(key, value)`	`CalendarEvent`	Define uma tag de chave-valor no evento para armazenar metadados personalizados.
`setTime(startTime, endTime)`	`CalendarEvent`	Define as datas e os horários de início e término do evento.
`setTitle(title)`	`CalendarEvent`	Define o título do evento.
`setVisibility(visibility)`	`CalendarEvent`	Define a visibilidade do evento.

Documentação detalhada

`addEmailReminder(minutesBefore)`

Adiciona um novo lembrete por e-mail ao evento. O lembrete deve durar de 5 minutos e, no máximo, 4 semanas (40.320 minutos), antes do evento.

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Adds an email notification for 15 minutes before the event.
event.addEmailReminder(15);

Parâmetros

Nome	Tipo	Descrição
`minutesBefore`	`Integer`	o número de minutos antes do evento

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Gera

Error: se houver mais de cinco lembretes no evento ou se o horário não for dentro do intervalo legal

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

`addGuest(email)`

Adiciona um convidado ao evento.

// Example 1: Add a guest to one event
function addAttendeeToEvent() {
  // Replace the below values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to add
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar containing event
  let eventId = '123abc'; // ID of event instance

  let calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
    }
  let event = calendar.getEventById(eventId);
  if (event === null) {
    // Event not found
    console.log('Event not found', eventId);
    return;
    }
  event.addGuest(attendeeEmail);
  }

// Example 2: Add a guest to all events on a calendar within a specified timeframe
function addAttendeeToAllEvents(){
// Replace the following values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to add
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar with the events
  let startDate = new Date("YYYY-MM-DD"); // The first date to add the guest to the events
  let endDate = new Date("YYYY-MM-DD"); // The last date to add the guest to the events

  let calendar = CalendarApp.getCalendarById(calendarId);
    if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  // Get the events within the specified timeframe
  let calEvents = calendar.getEvents(startDate,endDate);
  console.log(calEvents.length); // Checks how many events are found
  // Loop through all events and add the attendee to each of them
  for (var i = 0; i < calEvents.length; i++) {
  let event = calEvents[i];
  event.addGuest(attendeeEmail);
  }
}

Parâmetros

Nome	Tipo	Descrição
`email`	`String`	O endereço de e-mail do convidado.

Retornar

CalendarEvent: este CalendarEvent 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

`addPopupReminder(minutesBefore)`

Adiciona uma nova notificação pop-up ao evento. A notificação precisa ter pelo menos cinco minutos. no máximo 4 semanas (40.320 minutos) antes do evento.

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Adds a pop-up notification for 15 minutes before the event.
event.addPopupReminder(15);

Parâmetros

Nome	Tipo	Descrição
`minutesBefore`	`Integer`	o número de minutos antes do evento

Retornar

CalendarEvent: este CalendarEvent 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

`addSmsReminder(minutesBefore)`

Adiciona um novo lembrete por SMS ao evento. O lembrete deve durar de 5 minutos e, no máximo, 4 semanas (40.320 minutos), antes do evento.

Parâmetros

Nome	Tipo	Descrição
`minutesBefore`	`Integer`	o número de minutos antes do evento

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Gera

Error: se houver mais de cinco lembretes no evento ou se o horário não for dentro do intervalo legal

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

`anyoneCanAddSelf()`

Determina se as pessoas podem se adicionar como convidados a um evento da Agenda.

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Determines whether people can add themselves as guests to the event and logs it.
console.log(event.anyoneCanAddSelf());

Retornar

Boolean: true se pessoas que não são convidados puderem se adicionar ao evento 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

`deleteEvent()`

Exclui um evento do Google Agenda.

// Gets an event by its ID.
// TODO(developer): Replace the string with the ID of the event that you want to delete.
const event = CalendarApp.getEventById('abc123456');

// Deletes the event.
event.deleteEvent();

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

`deleteTag(key)`

Exclui uma tag de chave-valor do evento.

Parâmetros

Nome	Tipo	Descrição
`key`	`String`	a chave de tag

Retornar

CalendarEvent: este CalendarEvent 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

`getAllDayEndDate()`

Recebe a data de término desse evento da agenda de dia inteiro. Se não for um evento de dia inteiro, esse método gera uma exceção. O Date retornado representa a meia-noite no início do dia após o término do evento no fuso horário do script. Para usar o fuso horário da agenda, chame getEndTime().

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Creates an event named 'My all-day event' for May 16, 2023.
const event = calendar.createAllDayEvent('My all-day event', new Date('May 16, 2023'));

// Gets the event's end date and logs it.
const endDate = event.getAllDayEndDate();
console.log(endDate);

Retornar

Date: a data de término deste evento da agenda de dia inteiro

Gera

Error: se o evento não for de dia inteiro

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

`getAllDayStartDate()`

Recebe a data de início desse evento de dia inteiro. Se não for um evento de dia inteiro, esse método gerará uma exceção.) O Date retornado representa a meia-noite no início do dia em que o evento começa no fuso horário do script. Para usar o fuso horário da agenda, chame getStartTime().

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Creates an event named 'My all-day event' for May 16, 2023.
const event = calendar.createAllDayEvent('My all-day event', new Date('May 16, 2023'));

// Gets the event's start date and logs it.
const startDate = event.getAllDayStartDate();
console.log(startDate);

Retornar

Date: a data de início deste evento da agenda de dia inteiro

Gera

Error: se o evento não for de dia inteiro

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

`getAllTagKeys()`

Recebe todas as chaves das tags que foram definidas no evento.

Retornar

String[]: uma matriz de chaves de string.

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

`getColor()`

Retorna a cor do evento da agenda.

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Gets the color of the calendar event and logs it.
const eventColor = event.getColor();
console.log(eventColor);

Retornar

String: a representação de string da cor do evento, como um índice (1 a 11) de valores de CalendarApp.EventColor.

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

`getCreators()`

Extrai os criadores de um evento.

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Gets a list of the creators of the event and logs it.
console.log(event.getCreators());

Retornar

String[]: os endereços de e-mail dos criadores do evento

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

`getDateCreated()`

Recebe a data de criação do evento. Você precisa ter acesso à agenda.

// Opens the calendar by using its ID.
// To get the user's default calendar use CalendarApp.getDefault() instead.
// TODO(developer): Replace the calendar ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 8:10 AM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 08:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, gets the date that the event
 // was created and logs it.
 const eventCreated = event.getDateCreated();
 console.log(eventCreated);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Retornar

Date: a data de criaçã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

`getDescription()`

Extrai a descrição do evento. Você precisa ter acesso para editar a agenda.

// Opens the calendar by its ID.
// To get the user's default calendar use CalendarApp.getDefault() instead.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 4th, 2023 that takes place
between 4:00 PM and 5:00 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 04, 2023 16:00:00'), new Date('Feb 04, 2023 17:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the description of the event.
 event.setDescription('Important meeting');

 // Gets the description of the event and logs it.
 const description = event.getDescription();
 console.log(description);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Retornar

String: a descriçã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

`getEmailReminders()`

Recebe os valores dos minutos de todos os lembretes por e-mail para o evento. Você precisa ter acesso para editar o agenda.

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

// Gets the first event from the calendar for February 4th, 2023 that takes place
between 5:00 PM and 6:00 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 04, 2023 15:00:00'), new Date('Feb 04, 2023 18:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, adds email reminders for the user to be
 // sent at 4 and 7 minutes before the event.
 event.addEmailReminder(4);
 event.addEmailReminder(7);

 // Gets the minute values for all email reminders that are set up for the user for this event
 // and logs it.
 const emailReminder = event.getEmailReminders();
 console.log(emailReminder);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Retornar

Integer[]: uma matriz em que cada valor corresponde ao número de minutos antes do evento que um lembrete é acionado

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

`getEndTime()`

Recebe a data e a hora de término deste evento da agenda. Você precisa ter acesso à agenda. Para eventos que não duram o dia inteiro, é o instante em que o evento foi definido como fim. Para eventos de dia inteiro que armazenam somente uma data de término (não data e hora), isso é meia-noite. No início do dia após o término do evento no fuso horário da agenda. Isso permite uma comparação significativa de horários de término para todos os tipos de eventos; No entanto, ela não preservar o dia do ano original sem modificações.

Para eventos de dia inteiro, getAllDayEndDate() deve quase sempre será chamado em preferência por esse método.

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

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:00 PM and 5:00 PM.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:00:00'), new Date('Feb 01, 2023 17:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, gets the date and time at which the
 // event ends and logs it.
 console.log(event.getEndTime());
} else {
 // If no event exists within the given time frame, logs that info to the console.
 console.log('No events exist for the specified range');
}

Retornar

Date: o horário de término deste evento 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

`getEventSeries()`

Recebe a série de eventos recorrentes aos quais este evento pertence. Você precisa ter acesso ao agenda. Um objeto CalendarEventSeries é retornado mesmo que esse evento não pertença ao uma série, para que você possa adicionar novas configurações de recorrência.

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

// Gets the first event from the calendar for February 18th, 2023 that takes place between
// 1:00 PM and 2:00 PM.
const event =
  calendar.getEvents(new Date('Feb 18, 2023 13:00:00'), new Date('Feb 18, 2023 14:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, gets the event series for the event
 // and sets the color to pale green.
 event.getEventSeries().setColor(CalendarApp.EventColor.PALE_GREEN);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Retornar

CalendarEventSeries: a série de eventos a que o evento pertence ou uma nova série de eventos, se ainda não pertencer a ele a uma série

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

`getGuestByEmail(email)`

Recebe um convidado por endereço de e-mail.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 25th, 2023 that takes place
// between 5:00 PM and 5:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 25,2023 17:00:00'), new Date('Feb 25,2023 17:25:00'))[0];

// Gets a guest by email address.
const guestEmailId = event.getGuestByEmail('alex@example.com');

// If the email address corresponds to an event guest, logs the email address.
if (guestEmailId) {
  console.log(guestEmailId.getEmail());
}

Parâmetros

Nome	Tipo	Descrição
`email`	`String`	o endereço do convidado.

Retornar

EventGuest: o convidado ou nulo se o endereço de e-mail não corresponder a um convidado

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

`getGuestList()`

Extrai os convidados do evento, sem incluir o proprietário do evento.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 25th, 2023 that takes place
// between 5:00 PM and 5:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 25,2023 17:00:00'), new Date('Feb 25,2023 17:25:00'))[0];

// Adds two guests to the event by using their email addresses.
event.addGuest('alex@example.com');
event.addGuest('cruz@example.com');

// Gets the guests list for the event.
const guestList = event.getGuestList();

// Loops through the list to get all the guests and logs their email addresses.
for (const guest of guestList){
  console.log(guest.getEmail());
}

Retornar

EventGuest[]: uma matriz dos convidados.

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

`getGuestList(includeOwner)`

Extrai os convidados do evento, potencialmente incluindo os proprietários do evento.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 25th, 2023 that takes place
// between 5:00 PM and 5:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 25,2023 17:00:00'), new Date('Feb 25,2023 17:25:00'))[0];

// Gets the guests list for the event, including the owner of the event.
const guestList = event.getGuestList(true);

// Loops through the list to get all the guests and logs it.
for (const guest of guestList) {
  console.log(guest.getEmail());
}

Parâmetros

Nome	Tipo	Descrição
`includeOwner`	`Boolean`	se quer incluir os proprietários como convidados

Retornar

EventGuest[]: uma matriz dos convidados.

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 iCalUID exclusivo do evento. Observe que o iCalUID e o evento id usados pelo A API Calendar v3 e o serviço avançado do Google Agenda não são idênticos e não podem ser usados alternadamente. Uma diferença na semântica deles é que, em eventos recorrentes, todas as ocorrências de um evento têm ids diferentes, enquanto todas compartilham os mesmos iiCUIDs.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for January 5th, 2023 that takes place
// between 9:00 AM and 9:25 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Jan 05, 2023 09:00:00'), new Date('Jan 05, 2023 09:25:00'))[0];

// Gets the ID of the event and logs it.
console.log(event.getId());

Retornar

String: o iCalUID do evento

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

`getLastUpdated()`

Recebe a data em que o evento foi atualizado pela última vez.

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
between 4:00 PM and 5:00 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:00:00'), new Date('Feb 01, 2023 17:00:00'))[0];

// Gets the date the event was last updated and logs it.
const eventUpdatedDate = event.getLastUpdated();
console.log(eventUpdatedDate);

Retornar

Date: a data da última atualizaçã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

`getLocation()`

Recebe o local do evento.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the location of the event to Mumbai.
 event.setLocation('Mumbai');

 // Gets the location of the event and logs it.
 const eventLocation = event.getLocation();
 console.log(eventLocation);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Retornar

String: o local do evento.

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

`getMyStatus()`

Gera o status do evento (como comparecer ou convidado) do usuário em vigor. Retorna sempre GuestStatus.OWNER se o usuário em vigor for o proprietário do evento.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, gets the event status of
 // the effective user and logs it.
 const myStatus = event.getMyStatus();
 console.log(myStatus.toString());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Retornar

GuestStatus: o status.

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

`getOriginalCalendarId()`

Encontre o ID da agenda onde esse evento foi criado originalmente.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 25th, 2023 that takes place
// between 4:00 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 25,2023 16:00:00'), new Date('Feb 25,2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, gets the ID of the calendar where the
 // event was originally created and logs it.
 const calendarId = event.getOriginalCalendarId();
 console.log(calendarId);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Retornar

String: o ID da agenda original

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

`getPopupReminders()`

Recebe os valores dos minutos de todos os lembretes pop-up para o evento.

  // Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 4th, 2023 that takes place
// between 5:05 PM and 5:35 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 04, 2023 17:05:00'), new Date('Feb 04, 2023 17:35:00'))[0];

if (event) {
 // If an event exists within the given time frame, adds two pop-up reminders to the event.
 // The first reminder pops up 5 minutes before the event starts and the second reminder
 // pops up 3 minutes before the event starts.
 event.addPopupReminder(3);
 event.addPopupReminder(5);

 // Gets the minute values for all pop-up reminders for the event and logs it.
 const popUpReminder = event.getPopupReminders();
 console.log(popUpReminder);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Retornar

Integer[]: uma matriz em que cada valor corresponde ao número de minutos antes do evento que um lembrete é acionado

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

`getSmsReminders()`

Recebe os valores dos minutos de todos os lembretes por SMS do evento.

Retornar

Integer[]: uma matriz em que cada valor corresponde ao número de minutos antes do evento que um lembrete é acionado

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

`getStartTime()`

Recupera a data e a hora de início do evento da agenda. Para eventos que não duram o dia todo, esse é o instante de tempo em que o evento foi definido para começar. Para eventos de dia inteiro, que só armazenar uma data de início (não data e hora), ou seja, meia-noite no início do dia O evento começará no fuso horário da agenda. Isso permite uma comparação significativa horários de início de todos os tipos de eventos; No entanto, isso não significa necessariamente preservar dia do ano inalterados.

Para eventos de dia inteiro, getAllDayStartDate() deve quase sempre ser chamado em preferência por esse método.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

// Gets the date and time at which this calendar event begins and logs it.
const startTime = event.getStartTime();
console.log(startTime);

Retornar

Date: o horário de início deste evento 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

`getTag(key)`

Recebe um valor da tag do evento.

Parâmetros

Nome	Tipo	Descrição
`key`	`String`	a chave

Retornar

String: o valor da tag

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

`getTitle()`

Extrai o título do evento.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for January 31st, 2023 that takes place
// between 9:05 AM and 9:15 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Jan 31, 2023 09:05:00'), new Date('Jan 31, 2023 09:15:00'))[0];

if (event) {
 // If an event exists within the given time frame, logs the title of the event.
 console.log(event.getTitle());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Retornar

String: o título

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

`getVisibility()`

Recebe a visibilidade do evento.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, gets the visibility of the event
 // and logs it.
 const eventVisibility = event.getVisibility();
 console.log(eventVisibility.toString());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Retornar

Visibility: o valor de visibilidade

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

`guestsCanInviteOthers()`

Determina se os convidados podem convidar outras pessoas.

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 9:35 AM and 9:40 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 09:35:00'), new Date('Feb 01, 2023 09:40:00'))[0];

if (event) {
 // If an event exists within the given time frame, determines whether guests can invite
 // other guests and logs it.
 console.log(event.guestsCanInviteOthers());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Retornar

Boolean: true se os convidados puderem convidar outras pessoas. 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

`guestsCanModify()`

Determina se os convidados podem modificar o evento.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 9:35 AM and 9:40 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 09:35:00'), new Date('Feb 01, 2023 09:40:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the event so that guests can't
 // modify it.
 event.setGuestsCanModify(false);

 // Determines whether guests can modify the event and logs it.
 console.log(event.guestsCanModify());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Retornar

Boolean: true se os convidados puderem modificar o evento. 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

`guestsCanSeeGuests()`

Determina se convidados podem ver outros convidados.

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 9:35 AM and 9:40 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 09:35:00'), new Date('Feb 01, 2023 09:40:00'))[0];

if (event) {
 // If an event exists within the given time frame, determines whether guests can see other
 // guests and logs it.
 console.log(event.guestsCanSeeGuests());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Retornar

Boolean: true se os convidados puderem ver outros convidados. 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

`isAllDayEvent()`

Determina se é um evento de dia inteiro.

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for January 31st, 2023 that takes place
// between 9:05 AM and 9:15 AM.
const event =
  calendar.getEvents(new Date('Jan 31, 2023 09:05:00'), new Date('Jan 31, 2023 09:15:00'))[0];

// Determines whether this event is an all-day event and logs it.
console.log(event.isAllDayEvent());

Retornar

Boolean: true se o evento durar o dia inteiro 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 você é o proprietário do evento.

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for January 31st, 2023 that takes place
// between 9:05 AM and 9:15 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Jan 31, 2023 09:05:00'), new Date('Jan 31, 2023 09:15:00'))[0];

if (event) {
 // If an event exists within the given time frame, determines whether you're the owner
 // of the event and logs it.
 console.log(event.isOwnedByMe());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Retornar

Boolean: true se o evento pertencer ao usuário efetivo. 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

`isRecurringEvent()`

Determina se o evento faz parte de uma série de eventos.

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for Januart 31st, 2023 that takes place
// between 9:00 AM and 10:00 AM.
const event =
  calendar.getEvents(new Date('Jan 31, 2023 09:00:00'), new Date('Jan 31, 2023 10:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, determines whether the event is part of an
 // event series and logs it.
 console.log(event.isRecurringEvent());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Retornar

Boolean: true se o evento fizer parte de uma série de eventos. 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

`removeAllReminders()`

Remove todos os lembretes do evento.

// Opens the calendar by its ID. You must have edit access to the calendar
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 1,2023 16:10:00'), new Date('Feb 1,2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, removes all reminders from the event.
 event.removeAllReminders();
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Retornar

CalendarEvent: este CalendarEvent 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

`removeGuest(email)`

Remove um convidado do evento.

// Example 1: Remove a guest from one event
function removeGuestFromEvent() {
  // Replace the below values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to remove
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar containing event
  let eventId = '123abc'; // ID of event instance

  let calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
    }
  let event = calendar.getEventById(eventId);
  if (event === null) {
    // Event not found
    console.log('Event not found', eventId);
    return;
    }
  event.removeGuest(attendeeEmail);
  }

// Example 2: Remove a guest from all events on a calendar within a specified timeframe
function removeGuestFromAllEvents(){
// Replace the following values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to remove
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar with the events
  let startDate = new Date("YYYY-MM-DD"); // The first date to remove the guest from the events
  let endDate = new Date("YYYY-MM-DD"); // The last date to remove the attendee from the events

  let calendar = CalendarApp.getCalendarById(calendarId);
    if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  // Get the events within the specified timeframe
  let calEvents = calendar.getEvents(startDate,endDate);
  console.log(calEvents.length); // Checks how many events are found
  // Loop through all events and remove the attendee from each of them
  for (var i = 0; i < calEvents.length; i++) {
  let event = calEvents[i];
  event.removeGuest(attendeeEmail);
  }
}

Parâmetros

Nome	Tipo	Descrição
`email`	`String`	o endereço de e-mail do convidado

Retornar

CalendarEvent: este CalendarEvent 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

`resetRemindersToDefault()`

Redefinir os lembretes usando as configurações padrão da agenda.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 1, 2023 16:10:00'), new Date('Feb 1, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, resets the reminders using the calendar's
 // default settings.
 event.resetRemindersToDefault();
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Retornar

CalendarEvent: este CalendarEvent 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

`setAllDayDate(date)`

Define a data do evento. A aplicação desse método transforma um evento regular em um evento de dia inteiro.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 17th, 2023 that takes place
// between 4:00 PM and 5:00 PM.
const event =
  calendar.getEvents(new Date('Feb 17, 2023 16:00:00'), new Date('Feb 17, 2023 17:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the date of the event and updates
 // it to an all-day event.
 event.setAllDayDate(new Date('Feb 17, 2023'));
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Parâmetros

Nome	Tipo	Descrição
`date`	`Date`	a data do evento (a hora é ignorada)

Retornar

CalendarEvent: este CalendarEvent 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

`setAllDayDates(startDate, endDate)`

Define as datas do evento. A aplicação desse método muda um evento regular para um evento de dia inteiro evento.

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

// Gets the first event from the calendar for February 18th, 2023 that takes place
// between 4:00 PM and 5:00 PM.
const event =
  calendar.getEvents(new Date('Feb 18, 2023 16:00:00'), new Date('Feb 18, 2023 17:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the event to be an all-day event from
 // Feb 18th, 2023 until Feb 25th, 2023. Applying this method changes a regular event into an
 // all-day event.
 event.setAllDayDates(new Date('Feb 18, 2023'), new Date('Feb 25, 2023'));
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Parâmetros

Nome	Tipo	Descrição
`startDate`	`Date`	a data de início do evento (o horário é ignorado)
`endDate`	`Date`	a data de término do evento (o horário é ignorado)

Retornar

CalendarEvent: este CalendarEvent 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

`setAnyoneCanAddSelf(anyoneCanAddSelf)`

Define se pessoas que não são convidados podem se adicionar ao evento.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 15th, 2023 that takes place
// between 3:30 PM and 4:30 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 15, 2023 15:30:00'), new Date('Feb 15, 2023 16:30:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the event so that non-guests
 // can't add themselves to the event.
 event.setAnyoneCanAddSelf(false);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Parâmetros

Nome	Tipo	Descrição
`anyoneCanAddSelf`	`Boolean`	se qualquer pessoa pode convidar a si mesma

Retornar

CalendarEvent: este CalendarEvent 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

`setColor(color)`

Define a cor do evento da agenda.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the color of the calendar event to
 // green.
 event.setColor(CalendarApp.EventColor.GREEN);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Parâmetros

Nome	Tipo	Descrição
`color`	`String`	Um índice de cor de números inteiros, como uma string, ou um valor de `CalendarApp.EventColor`.

Retornar

CalendarEvent: este evento da 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 do evento.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 4th, 2023 that takes place
// between 5:05 PM and 5:35 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 04, 2023 17:05:00'), new Date('Feb 04, 2023 17:35:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the description of the event to
 // 'Meeting.'
 event.setDescription('Meeting');
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Parâmetros

Nome	Tipo	Descrição
`description`	`String`	a nova descrição

Retornar

CalendarEvent: este CalendarEvent 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

`setGuestsCanInviteOthers(guestsCanInviteOthers)`

Define se os convidados podem convidar outras pessoas.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own. You must have edit access to the calendar.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 9:35 AM and 9:40 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 09:35:00'), new Date('Feb 01, 2023 09:40:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the event so that guests can invite
 // other guests.
 event.setGuestsCanInviteOthers(true);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Parâmetros

Nome	Tipo	Descrição
`guestsCanInviteOthers`	`Boolean`	se os convidados podem convidar outras pessoas

Retornar

CalendarEvent: este CalendarEvent 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

`setGuestsCanModify(guestsCanModify)`

Define se os convidados podem modificar o evento.

Parâmetros

Nome	Tipo	Descrição
`guestsCanModify`	`Boolean`	se os convidados podem modificar o evento

Retornar

CalendarEvent: este CalendarEvent 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

`setGuestsCanSeeGuests(guestsCanSeeGuests)`

Define se os convidados podem ver outros convidados.

Parâmetros

Nome	Tipo	Descrição
`guestsCanSeeGuests`	`Boolean`	se convidados podem ver outras pessoas

Retornar

CalendarEvent: este CalendarEvent 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

`setLocation(location)`

Define o local do evento.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the location of the event to Noida.
 event.setLocation('Noida');
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Parâmetros

Nome	Tipo	Descrição
`location`	`String`	o novo local

Retornar

CalendarEvent: este CalendarEvent 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

`setMyStatus(status)`

Define o status do evento (como participar ou convidado) do usuário em vigor.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the event status for the current user
 to maybe.
 event.setMyStatus(CalendarApp.GuestStatus.MAYBE);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Parâmetros

Nome	Tipo	Descrição
`status`	`GuestStatus`	o novo status

Retornar

CalendarEvent: este CalendarEvent 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.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds

`setTag(key, value)`

Define uma tag de chave-valor no evento para armazenar metadados personalizados.

Parâmetros

Nome	Tipo	Descrição
`key`	`String`	a chave de tag
`value`	`String`	O valor da tag

Retornar

CalendarEvent: este CalendarEvent 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

`setTime(startTime, endTime)`

Define as datas e os horários de início e término do evento. A aplicação desse método altera uma de dia inteiro em um evento regular.

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

// Declares a start time of 11:00 AM on February 20th, 2023 and an end time of 12:00 PM on
// February 20th, 2023.
const startTime = new Date('Feb 20,2023 11:00:00');
const endTime = new Date('Feb 20, 2023  12:00:00');

// Creates an all-day event on February 20th, 2023.
const event = calendar.createAllDayEvent('Meeting', new Date('Feb 20,2023'));

// Updates the all-day event to a regular event by setting a start and end time for the event.
event.setTime(startTime, endTime);

Parâmetros

Nome	Tipo	Descrição
`startTime`	`Date`	o novo início do evento
`endTime`	`Date`	o novo fim do evento

Retornar

CalendarEvent: este CalendarEvent 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

`setTitle(title)`

Define o título do evento.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for January 31st, 2023 that takes place
// between 9:05 AM and 9:15 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Jan 31, 2023 09:05:00'), new Date('Jan 31, 2023 09:15:00'))[0];

if (event) {
 // If an event exists within the given time frame, changes its title to Event1.
 event.setTitle('Event1');
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	o novo título

Retornar

CalendarEvent: este CalendarEvent 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

`setVisibility(visibility)`

Define a visibilidade do evento.

Parâmetros

Nome	Tipo	Descrição
`visibility`	`Visibility`

Retornar

CalendarEvent: este CalendarEvent 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