Representa uma série de eventos (um evento recorrente).
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
add | Calendar | Adiciona um novo lembrete por e-mail ao evento. |
add | Calendar | Adiciona um convidado ao evento. |
add | Calendar | Adiciona uma nova notificação pop-up ao evento. |
add | Calendar | Adiciona um novo lembrete por SMS ao evento. |
anyone | Boolean | Determina se as pessoas podem se adicionar como convidados a um evento do Agenda. |
delete | void | Exclui a série de eventos. |
delete | Calendar | Exclui uma tag de chave-valor do evento. |
get | String[] | Recebe todas as chaves das tags que foram definidas no evento. |
get | String | Retorna a cor do evento da agenda. |
get | String[] | Recebe os criadores de um evento. |
get | Date | Recebe a data em que o evento foi criado. |
get | String | Recebe a descrição do evento. |
get | Integer[] | Recebe os valores de minuto de todos os lembretes por e-mail do evento. |
get | Event | Recebe o Event deste evento. |
get | Event | Consegue um convidado pelo endereço de e-mail. |
get | Event | Consegue os convidados do evento, sem incluir o proprietário. |
get | Event | Recebe os convidados do evento, incluindo os proprietários. |
get | String | Recebe o iCalUID exclusivo do evento. |
get | Date | Recebe a data da última atualização do evento. |
get | String | Recebe a localização do evento. |
get | Guest | Consegue o status do evento (como "participante" ou "convidado") do usuário efetivo. |
get | String | Conseguir o ID da agenda em que o evento foi criado originalmente. |
get | Integer[] | Recebe os valores de minutos de todos os lembretes pop-up do evento. |
get | Integer[] | Recebe os valores de minuto de todos os lembretes por SMS do evento. |
get | String | Recebe um valor de tag do evento. |
get | String | Recebe o título do evento. |
get | Event | Recebe a transparência do evento. |
get | Visibility | Consegue a visibilidade do evento. |
guests | Boolean | Determina se os convidados podem convidar outras pessoas. |
guests | Boolean | Determina se os convidados podem modificar o evento. |
guests | Boolean | Determina se os convidados podem ver outros convidados. |
is | Boolean | Determina se você é o proprietário do evento. |
remove | Calendar | Remove todos os lembretes do evento. |
remove | Calendar | Remove um convidado do evento. |
reset | Calendar | Redefinir os lembretes usando as configurações padrão do Google Agenda. |
set | Calendar | Define se pessoas que não são convidados podem se adicionar ao evento. |
set | Calendar | Define a cor do evento da agenda. |
set | Calendar | Define a descrição do evento. |
set | Calendar | Define se os convidados podem convidar outras pessoas. |
set | Calendar | Define se os convidados podem modificar o evento. |
set | Calendar | Define se os convidados podem ver outros convidados. |
set | Calendar | Define o local do evento. |
set | Calendar | Define o status do evento (por exemplo, participante ou convidado) do usuário efetivo. |
set | Calendar | Define as regras de recorrência para uma série de eventos de dia inteiro. |
set | Calendar | Define as regras de recorrência para esta série de eventos. |
set | Calendar | Define uma tag de chave-valor no evento para armazenar metadados personalizados. |
set | Calendar | Define o título do evento. |
set | Calendar | Define a transparência do evento. |
set | Calendar | Define a visibilidade do evento. |
Documentação detalhada
add Email Reminder(minutesBefore)
Adiciona um novo lembrete por e-mail ao evento. O lembrete precisa ser acionado pelo menos 5 minutos e no máximo 4 semanas (40320 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 |
---|---|---|
minutes | Integer | o número de minutos antes do evento |
Retornar
Calendar
: Calendar
para encadeamento
Gera
Error
: se houver mais de cinco lembretes no evento ou se o horário não estiver dentro do intervalo legal.
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
add Guest(email)
Adiciona um convidado ao evento.
// Example 1: Add a guest to one event function addAttendeeToEvent() { // Replace the below values with your own const attendeeEmail = 'user@example.com'; // Email address of the person you need to add const calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar containing // event const eventId = '123abc'; // ID of event instance const calendar = CalendarApp.getCalendarById(calendarId); if (calendar === null) { // Calendar not found console.log('Calendar not found', calendarId); return; } const 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 const attendeeEmail = 'user@example.com'; // Email address of the person you need to add const calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar with the // events const startDate = new Date('YYYY-MM-DD'); // The first date to add the guest to the events const endDate = new Date('YYYY-MM-DD'); // The last date to add the guest to the events const calendar = CalendarApp.getCalendarById(calendarId); if (calendar === null) { // Calendar not found console.log('Calendar not found', calendarId); return; } // Get the events within the specified timeframe const 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 (let i = 0; i < calEvents.length; i++) { const event = calEvents[i]; event.addGuest(attendeeEmail); } }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
email | String | O endereço de e-mail do convidado. |
Retornar
Calendar
: Calendar
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
add Popup Reminder(minutesBefore)
Adiciona uma nova notificação pop-up ao evento. A notificação precisa ser enviada pelo menos 5 minutos e no máximo 4 semanas (40320 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 |
---|---|---|
minutes | Integer | o número de minutos antes do evento |
Retornar
Calendar
: Calendar
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
add Sms Reminder(minutesBefore)
Adiciona um novo lembrete por SMS ao evento. O lembrete precisa ser acionado pelo menos 5 minutos e no máximo 4 semanas (40320 minutos) antes do evento.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
minutes | Integer | o número de minutos antes do evento |
Retornar
Calendar
: Calendar
para encadeamento
Gera
Error
: se houver mais de cinco lembretes no evento ou se o horário não estiver dentro do intervalo legal.
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
anyone Can Add Self()
Determina se as pessoas podem se adicionar como convidados a um evento do 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 podem se adicionar ao evento; false
, se não.
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
delete Event Series()
Exclui a série de eventos.
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
delete Tag(key)
Exclui uma tag de chave-valor do evento.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
key | String | a chave da tag |
Retornar
Calendar
: Calendar
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
get All Tag Keys()
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 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
get Color()
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 Calendar
.
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
get Creators()
Recebe 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 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
get Date Created()
Recebe a data em que o evento foi criado. 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 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
get Description()
Recebe 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 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
get Email Reminders()
Recebe os valores de minutos de todos os lembretes por e-mail do evento. Você precisa ter acesso de edição ao calendário.
// 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 aciona um lembrete.
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
get Event Type()
Recebe o Event
deste evento.
// Opens the default calendar and logs all out-of-office events for the current day. const calendar = CalendarApp.getDefaultCalendar(); const events = calendar.getEventsForDay(new Date()); console.log(events.filter(e => e.getEventType() === CalendarApp.EventType.OUT_OF_OFFICE));
Retornar
Event
: o tipo de evento.
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
get Guest By Email(email)
Consegue um convidado pelo 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 hóspede |
Retornar
Event
: 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 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
get Guest List()
Consegue os convidados do evento, sem incluir o proprietário.
// 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
Event
: uma matriz de convidados
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
get Guest List(includeOwner)
Recebe os convidados do evento, incluindo os proprietários.
// 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 |
---|---|---|
include | Boolean | se os proprietários vão ser incluídos como convidados |
Retornar
Event
: uma matriz de convidados
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
get Id()
Recebe o iCalUID exclusivo do evento. O iCalUID e o evento id
usados pela
API Agenda v3 e pelo serviço avançado da Agenda não são idênticos e
não podem ser usados de forma intercambiável. Uma diferença na semântica é que, em eventos recorrentes,
todas as ocorrências de um evento têm ids
diferentes, mas todas compartilham os mesmos iCalUIDs.
// 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 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
get Last Updated()
Recebe a data da última atualização 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 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 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
get Location()
Recebe a localizaçã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 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 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
get My Status()
Consegue o status do evento (como "participante" ou "convidado") do usuário efetivo. Sempre retorna
Guest
se o usuário efetivo 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
Guest
: o status
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
get Original Calendar Id()
Conseguir o ID da agenda em que o 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 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
get Popup Reminders()
Recebe os valores de minutos de todos os lembretes pop-up 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, 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 aciona um lembrete.
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
get Sms Reminders()
Recebe os valores de minuto 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 aciona um lembrete.
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
get Tag(key)
Recebe um valor de 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 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
get Title()
Recebe 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 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
get Transparency()
Recebe a transparência do evento. Use esse método para determinar se um evento é
TRANSPARENT
, o que significa que a agenda aparece como "Disponível" durante esse período, ou OPAQUE
,
o que significa que a agenda aparece como "Ocupado" durante esse período.
// Gets the first event from the default calendar for today. const today = new Date(); const event = CalendarApp.getDefaultCalendar().getEventsForDay(today)[0]; // Gets the event's transparency and logs it. const transparency = event.getTransparency(); Logger.log(transparency);
Retornar
Event
: o valor de transparência.
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
get Visibility()
Consegue 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 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
guests Can Invite Others()
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 podem convidar outras pessoas; 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
guests Can Modify()
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 podem modificar o evento; false
, se não.
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
guests Can See Guests()
Determina se os 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 podem ver outros convidados; 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
is Owned By Me()
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
, 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
remove All Reminders()
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
Calendar
: Calendar
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
remove Guest(email)
Remove um convidado do evento.
// Example 1: Remove a guest from one event function removeGuestFromEvent() { // Replace the below values with your own const attendeeEmail = 'user@example.com'; // Email address of the person you need to remove const calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar containing // event const eventId = '123abc'; // ID of event instance const calendar = CalendarApp.getCalendarById(calendarId); if (calendar === null) { // Calendar not found console.log('Calendar not found', calendarId); return; } const 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 const attendeeEmail = 'user@example.com'; // Email address of the person you need to remove const calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar with the // events const startDate = new Date( 'YYYY-MM-DD'); // The first date to remove the guest from the events const endDate = new Date( 'YYYY-MM-DD'); // The last date to remove the attendee from the events const calendar = CalendarApp.getCalendarById(calendarId); if (calendar === null) { // Calendar not found console.log('Calendar not found', calendarId); return; } // Get the events within the specified timeframe const 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 (let i = 0; i < calEvents.length; i++) { const event = calEvents[i]; event.removeGuest(attendeeEmail); } }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
email | String | o endereço de e-mail do convidado |
Retornar
Calendar
: Calendar
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
reset Reminders To Default()
Redefinir os lembretes usando as configurações padrão do Google 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
Calendar
: Calendar
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
set Anyone Can Add Self(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 |
---|---|---|
anyone | Boolean | se qualquer pessoa pode se convidar |
Retornar
Calendar
: Calendar
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
set Color(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 inteiro como uma string ou um valor de Calendar . |
Retornar
Calendar
: este evento da 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
set Description(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
Calendar
: Calendar
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
set Guests Can Invite Others(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 |
---|---|---|
guests | Boolean | se os convidados podem convidar outras pessoas |
Retornar
Calendar
: Calendar
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
set Guests Can Modify(guestsCanModify)
Define se os convidados podem modificar o evento.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
guests | Boolean | se os convidados podem modificar o evento |
Retornar
Calendar
: Calendar
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
set Guests Can See Guests(guestsCanSeeGuests)
Define se os convidados podem ver outros convidados.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
guests | Boolean | se os convidados podem ver outros convidados |
Retornar
Calendar
: Calendar
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
set Location(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
Calendar
: Calendar
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
set My Status(status)
Define o status do evento (por exemplo, participante ou convidado) do usuário efetivo.
// 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 | Guest | o novo status |
Retornar
Calendar
: Calendar
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.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
set Recurrence(recurrence, startDate)
Define as regras de recorrência para uma série de eventos de dia inteiro. A aplicação desse método transforma uma série de eventos regular em uma série de eventos de dia inteiro.
// Sets the events in a series to take place every Wednesday in 2013. const eventSeries = CalendarApp.getDefaultCalendar().getEventSeriesById( '123456789@google.com', ); const startDate = new Date('January 2, 2013 03:00:00 PM EST'); const recurrence = CalendarApp.newRecurrence() .addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014')); eventSeries.setRecurrence(recurrence, startDate);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
recurrence | Event | as regras de recorrência a serem usadas |
start | Date | a data do primeiro evento da série (somente o dia é usado, a hora é ignorada) |
Retornar
Calendar
: esta CalendarEventSeries 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
set Recurrence(recurrence, startTime, endTime)
Define as regras de recorrência para esta série de eventos. A aplicação desse método transforma uma série de eventos de dia inteiro em uma série de eventos regular.
// Sets the events in a series to take place from 3pm to 4pm every Tuesday and // Thursday in 2013. const eventSeries = CalendarApp.getDefaultCalendar().getEventSeriesById( '123456789@google.com', ); const startTime = new Date('January 1, 2013 03:00:00 PM EST'); const endTime = new Date('January 1, 2013 04:00:00 PM EST'); const recurrence = CalendarApp.newRecurrence() .addWeeklyRule() .onlyOnWeekdays( [CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY]) .until(new Date('January 1, 2014')); eventSeries.setRecurrence(recurrence, startTime, endTime);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
recurrence | Event | as regras de recorrência a serem usadas |
start | Date | a data e a hora em que o primeiro evento da série começa |
end | Date | a data e a hora em que o primeiro evento da série termina |
Retornar
Calendar
: esta CalendarEventSeries 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
set Tag(key, value)
Define uma tag de chave-valor no evento para armazenar metadados personalizados.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
key | String | a chave da tag |
value | String | o valor da tag |
Retornar
Calendar
: Calendar
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
set Title(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
Calendar
: Calendar
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
set Transparency(transparency)
Define a transparência do evento. Use esse método para definir se um evento é
TRANSPARENT
, o que significa que a agenda aparece como "Disponível" durante esse período, ou OPAQUE
,
o que significa que a agenda aparece como "Ocupado" durante esse período.
// 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'); // Sets the event's transparency to TRANSPARENT. event.setTransparency(CalendarApp.EventTransparency.TRANSPARENT);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
transparency | Event | O valor de transparência. |
Retornar
Calendar
: Calendar
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
set Visibility(visibility)
Define a visibilidade do evento.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
visibility | Visibility |
Retornar
Calendar
: Calendar
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