Permite que um script leia e atualize o Google Agenda do usuário. Essa classe fornece acesso direto à agenda padrão do usuário, além de poder recuperar outras agendas de que o usuário é proprietário ou que são assinantes.
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
Color | Color | Uma enumeração que representa as cores nomeadas disponíveis no serviço do Agenda. |
EventColor | EventColor | Uma enumeração que representa as cores do evento nomeadas disponíveis no serviço do Agenda. |
GuestStatus | GuestStatus | Uma enumeração que representa os status de um convidado em um evento. |
Month | Month | Uma enumeração que representa os meses do ano. |
Visibility | Visibility | Uma enumeração que representa a visibilidade de um evento. |
Weekday | Weekday | Um enum que representa os dias da semana. |
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
createAllDayEvent(title, date) | CalendarEvent | Cria um novo evento de dia inteiro. |
createAllDayEvent(title, startDate, endDate) | CalendarEvent | Cria um novo evento de dia inteiro com duração de vários dias. |
createAllDayEvent(title, startDate, endDate, options) | CalendarEvent | Cria um novo evento de dia inteiro com duração de vários dias. |
createAllDayEvent(title, date, options) | CalendarEvent | Cria um novo evento de dia inteiro. |
createAllDayEventSeries(title, startDate, recurrence) | CalendarEventSeries | Cria uma nova série de eventos de dia inteiro. |
createAllDayEventSeries(title, startDate, recurrence, options) | CalendarEventSeries | Cria uma nova série de eventos de dia inteiro. |
createCalendar(name) | Calendar | Cria uma nova agenda que pertence ao usuário. |
createCalendar(name, options) | Calendar | Cria uma nova agenda que pertence ao usuário. |
createEvent(title, startTime, endTime) | CalendarEvent | Cria um evento. |
createEvent(title, startTime, endTime, options) | CalendarEvent | Cria um evento. |
createEventFromDescription(description) | CalendarEvent | Cria um evento com base em uma descrição em formato livre. |
createEventSeries(title, startTime, endTime, recurrence) | CalendarEventSeries | Cria uma nova série de eventos. |
createEventSeries(title, startTime, endTime, recurrence, options) | CalendarEventSeries | Cria uma nova série de eventos. |
getAllCalendars() | Calendar[] | Recebe todas as agendas das quais o usuário é proprietário ou está inscrito. |
getAllOwnedCalendars() | Calendar[] | Recebe todas as agendas do usuário. |
getCalendarById(id) | Calendar | Recebe a agenda com o ID fornecido. |
getCalendarsByName(name) | Calendar[] | Recebe todas as agendas com um determinado nome do usuário ou em que ele está inscrito. |
getColor() | String | Recebe a cor da agenda. |
getDefaultCalendar() | Calendar | Recebe a agenda padrão do usuário. |
getDescription() | String | Recebe a descrição da agenda. |
getEventById(iCalId) | CalendarEvent | Recebe o evento com o ID fornecido. |
getEventSeriesById(iCalId) | CalendarEventSeries | Recebe a série de eventos com o ID fornecido. |
getEvents(startTime, endTime) | CalendarEvent[] | Recebe todos os eventos que ocorrem em um determinado período. |
getEvents(startTime, endTime, options) | CalendarEvent[] | Recebe todos os eventos que ocorrem em um determinado período e atendem aos critérios especificados. |
getEventsForDay(date) | CalendarEvent[] | Recebe todos os eventos que ocorrem em um determinado dia. |
getEventsForDay(date, options) | CalendarEvent[] | Recebe todos os eventos que ocorrem em um determinado dia e atendem aos critérios especificados. |
getId() | String | Recebe o ID da agenda. |
getName() | String | Recebe o nome da agenda. |
getOwnedCalendarById(id) | Calendar | Recebe a agenda com o ID fornecido, se o usuário for o proprietário. |
getOwnedCalendarsByName(name) | Calendar[] | Recebe todas as agendas com um determinado nome de usuário. |
getTimeZone() | String | Acessa o fuso horário da agenda. |
isHidden() | Boolean | Determina se a agenda está oculta na interface do usuário. |
isMyPrimaryCalendar() | Boolean | Determina se o calendário é o padrão para o usuário efetivo. |
isOwnedByMe() | Boolean | Determina se o usuário é o proprietário da agenda. |
isSelected() | Boolean | Determina se os eventos da agenda são exibidos na interface do usuário. |
newRecurrence() | EventRecurrence | Cria um novo objeto de recorrência, que pode ser usado para criar regras de recorrência de evento. |
setColor(color) | Calendar | Define a cor da agenda. |
setDescription(description) | Calendar | Define a descrição da agenda. |
setHidden(hidden) | Calendar | Define se a agenda é visível na interface do usuário. |
setName(name) | Calendar | Define o nome da agenda. |
setSelected(selected) | Calendar | Define se os eventos da agenda são exibidos na interface do usuário. |
setTimeZone(timeZone) | Calendar | Define o fuso horário da agenda. |
subscribeToCalendar(id) | Calendar | Inscreve o usuário no calendário com o ID fornecido, se o usuário tiver permissão para se inscrever. |
subscribeToCalendar(id, options) | Calendar | Inscreve o usuário no calendário com o ID fornecido, se o usuário tiver permissão para se inscrever. |
Documentação detalhada
createAllDayEvent(title, date)
Cria um novo evento de dia inteiro.
// Creates an all-day event for the moon landing and logs the ID. var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Apollo 11 Landing', new Date('July 20, 1969')); Logger.log('Event ID: ' + event.getId());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
title | String | É o título do evento. |
date | Date | A data do evento (somente o dia é usado, o horário é ignorado). |
Retornar
CalendarEvent
: o evento criado.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, startDate, endDate)
Cria um novo evento de dia inteiro com duração de vários dias.
// Creates an all-day event for the Woodstock festival (August 15th to 17th) and logs the ID. var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Woodstock Festival', new Date('August 15, 1969'), new Date('August 18, 1969')); Logger.log('Event ID: ' + event.getId());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
title | String | É o título do evento. |
startDate | Date | A data de início do evento (somente o dia é usado, o horário é ignorado). |
endDate | Date | A data de término do evento (somente o dia, o horário ignorado). A data de término é exclusiva. |
Retornar
CalendarEvent
: o evento criado.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, startDate, endDate, options)
Cria um novo evento de dia inteiro com duração de vários dias.
// Creates an all-day event for the Woodstock festival (August 15th to 17th) and logs the ID. var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Woodstock Festival', new Date('August 15, 1969'), new Date('August 18, 1969'), {location: 'Bethel, White Lake, New York, U.S.', sendInvites: true}); Logger.log('Event ID: ' + event.getId());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
title | String | É o título do evento. |
startDate | Date | A data de início do evento (somente o dia é usado, o horário é ignorado). |
endDate | Date | A data de término do evento (somente o dia, o horário ignorado). A data de término é exclusiva. |
options | Object | Um objeto JavaScript que especifica os parâmetros avançados, como listado abaixo. |
Parâmetros avançados
Nome | Tipo | Descrição |
---|---|---|
description | String | É a descrição do evento. |
location | String | É o local do evento. |
guests | String | Uma lista separada por vírgulas de endereços de e-mail que precisam ser adicionados como convidados. |
sendInvites | Boolean | Se os e-mails de convite serão enviados (padrão: false ). |
Retornar
CalendarEvent
: o evento criado.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, date, options)
Cria um novo evento de dia inteiro.
// Creates an all-day event for the moon landing and logs the ID. var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Apollo 11 Landing', new Date('July 20, 1969'), {location: 'The Moon'}); Logger.log('Event ID: ' + event.getId());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
title | String | É o título do evento. |
date | Date | A data do evento (somente o dia é usado, o horário é ignorado). |
options | Object | Um objeto JavaScript que especifica os parâmetros avançados, como listado abaixo. |
Parâmetros avançados
Nome | Tipo | Descrição |
---|---|---|
description | String | É a descrição do evento. |
location | String | É o local do evento. |
guests | String | Uma lista separada por vírgulas de endereços de e-mail que precisam ser adicionados como convidados. |
sendInvites | Boolean | Se os e-mails de convite serão enviados (padrão: false ). |
Retornar
CalendarEvent
: o evento criado.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEventSeries(title, startDate, recurrence)
Cria uma nova série de eventos de dia inteiro.
// Creates an event series for a no-meetings day, taking place every Wednesday in 2013. var eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries('No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014'))); Logger.log('Event Series ID: ' + eventSeries.getId());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
title | String | o título dos eventos da série |
startDate | Date | a data do primeiro evento da série (somente o dia é usado, o horário é ignorado); |
recurrence | EventRecurrence | as configurações de recorrência da série de eventos |
Retornar
CalendarEventSeries
: a série de eventos criada.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEventSeries(title, startDate, recurrence, options)
Cria uma nova série de eventos de dia inteiro.
// Creates an event series for a no-meetings day, taking place every Wednesday in 2013. var eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries('No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014')), {guests: 'everyone@example.com'}); Logger.log('Event Series ID: ' + eventSeries.getId());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
title | String | o título dos eventos da série |
startDate | Date | a data do primeiro evento da série (somente o dia é usado, o horário é ignorado); |
recurrence | EventRecurrence | as configurações de recorrência da série de eventos |
options | Object | um objeto JavaScript que especifica os parâmetros avançados, como listado abaixo |
Parâmetros avançados
Nome | Tipo | Descrição |
---|---|---|
description | String | a descrição dos eventos da série |
location | String | o local dos eventos na série |
guests | String | Uma lista separada por vírgulas de endereços de e-mail que precisam ser adicionados como convidados aos eventos na série |
sendInvites | Boolean | se os e-mails de convite serão enviados (padrão: false ) |
Retornar
CalendarEventSeries
: a série de eventos criada.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createCalendar(name)
Cria uma nova agenda que pertence ao usuário.
// Creates a new calendar named "Travel Plans". var calendar = CalendarApp.createCalendar('Travel Plans'); Logger.log('Created the calendar "%s", with the ID "%s".', calendar.getName(), calendar.getId());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
name | String | o nome da nova agenda |
Retornar
Calendar
: a agenda recém-criada.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createCalendar(name, options)
Cria uma nova agenda que pertence ao usuário.
// Creates a new calendar named "Travel Plans" with a summary and color. var calendar = CalendarApp.createCalendar('Travel Plans', { summary: 'A calendar to plan my travel schedule.', color: CalendarApp.Color.BLUE }); Logger.log('Created the calendar "%s", with the ID "%s".', calendar.getName(), calendar.getId());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
name | String | o nome da nova agenda |
options | Object | um objeto JavaScript que especifica os parâmetros avançados, como listado abaixo |
Parâmetros avançados
Nome | Tipo | Descrição |
---|---|---|
location | String | o local da agenda |
summary | String | a descrição da agenda |
timeZone | String | o fuso horário para o qual a agenda será configurada, especificada no formato "longo" (por exemplo, "EUA/Nova_York", conforme listado por Joda.org) |
color | String | uma string de cor hexadecimal ("#rrggbb") ou um valor de CalendarApp.Colors . |
hidden | Boolean | se a agenda está oculta na interface do usuário (padrão:
false ) |
selected | Boolean | se os eventos da agenda são exibidos na interface do
usuário (padrão: true ) |
Retornar
Calendar
: a agenda recém-criada.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEvent(title, startTime, endTime)
Cria um evento.
Se nenhum fuso horário for especificado, os valores serão interpretados no contexto do fuso horário do script, que pode ser diferente do fuso horário da agenda.
// Creates an event for the moon landing and logs the ID. var event = CalendarApp.getDefaultCalendar().createEvent('Apollo 11 Landing', new Date('July 20, 1969 20:00:00 UTC'), new Date('July 21, 1969 21:00:00 UTC')); Logger.log('Event ID: ' + event.getId());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
title | String | o título do evento |
startTime | Date | a data e a hora em que o evento começa; |
endTime | Date | a data e a hora em que o evento termina |
Retornar
CalendarEvent
: o evento criado.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEvent(title, startTime, endTime, options)
Cria um evento.
Se nenhum fuso horário for especificado, os valores serão interpretados no contexto do fuso horário do script, que pode ser diferente do fuso horário da agenda.
// Creates an event for the moon landing and logs the ID. var event = CalendarApp.getDefaultCalendar().createEvent('Apollo 11 Landing', new Date('July 20, 1969 20:00:00 UTC'), new Date('July 20, 1969 21:00:00 UTC'), {location: 'The Moon'}); Logger.log('Event ID: ' + event.getId());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
title | String | o título do evento |
startTime | Date | a data e a hora em que o evento começa; |
endTime | Date | a data e a hora em que o evento termina |
options | Object | um objeto JavaScript que especifica os parâmetros avançados, como listado abaixo |
Parâmetros avançados
Nome | Tipo | Descrição |
---|---|---|
description | String | a descrição do evento |
location | String | o local do evento |
guests | String | uma lista separada por vírgulas de endereços de e-mail que precisam ser adicionados como convidados |
sendInvites | Boolean | se os e-mails de convite serão enviados (padrão: false ) |
Retornar
CalendarEvent
: o evento criado.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventFromDescription(description)
Cria um evento com base em uma descrição em formato livre.
A descrição precisa usar o mesmo formato do recurso "Adição rápida" da IU.
// Creates a new event and logs its ID. var event = CalendarApp.getDefaultCalendar() .createEventFromDescription('Lunch with Mary, Friday at 1PM'); Logger.log('Event ID: ' + event.getId());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
description | String | uma descrição livre do evento |
Retornar
CalendarEvent
: o evento criado.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventSeries(title, startTime, endTime, recurrence)
Cria uma nova série de eventos.
// Creates an event series for a team meeting, taking place every Tuesday and Thursday in 2013. var eventSeries = CalendarApp.getDefaultCalendar().createEventSeries('Team Meeting', new Date('January 1, 2013 03:00:00 PM EST'), new Date('January 1, 2013 04:00:00 PM EST'), CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekdays([CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY]) .until(new Date('January 1, 2014'))); Logger.log('Event Series ID: ' + eventSeries.getId());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
title | String | o título dos eventos da série |
startTime | Date | a data e o horário em que o primeiro evento da série começa |
endTime | Date | a data e a hora em que o primeiro evento da série termina |
recurrence | EventRecurrence | as configurações de recorrência da série de eventos |
Retornar
CalendarEventSeries
: a série de eventos criada.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventSeries(title, startTime, endTime, recurrence, options)
Cria uma nova série de eventos.
// Creates an event series for a team meeting, taking place every Tuesday and Thursday in 2013. var eventSeries = CalendarApp.getDefaultCalendar().createEventSeries('Team Meeting', new Date('January 1, 2013 03:00:00 PM EST'), new Date('January 1, 2013 04:00:00 PM EST'), CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekdays([CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY]) .until(new Date('January 1, 2014')), {location: 'Conference Room'}); Logger.log('Event Series ID: ' + eventSeries.getId());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
title | String | o título dos eventos da série |
startTime | Date | a data e o horário em que o primeiro evento da série começa |
endTime | Date | a data e a hora em que o primeiro evento da série termina |
recurrence | EventRecurrence | as configurações de recorrência da série de eventos |
options | Object | um objeto JavaScript que especifica os parâmetros avançados, como listado abaixo |
Parâmetros avançados
Nome | Tipo | Descrição |
---|---|---|
description | String | a descrição dos eventos da série |
location | String | o local dos eventos na série |
guests | String | Uma lista separada por vírgulas de endereços de e-mail que precisam ser adicionados como convidados aos eventos na série |
sendInvites | Boolean | se os e-mails de convite serão enviados (padrão: false ) |
Retornar
CalendarEventSeries
: a série de eventos criada.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
getAllCalendars()
Recebe todas as agendas das quais o usuário é proprietário ou está inscrito.
// Determines how many calendars the user can access. var calendars = CalendarApp.getAllCalendars(); Logger.log('This user owns or is subscribed to %s calendars.', calendars.length);
Retornar
Calendar[]
: todas as agendas que o usuário pode acessar.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos 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
getAllOwnedCalendars()
Recebe todas as agendas do usuário.
// Determines how many calendars the user owns. var calendars = CalendarApp.getAllOwnedCalendars(); Logger.log('This user owns %s calendars.', calendars.length);
Retornar
Calendar[]
: todas as agendas do usuário
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getCalendarById(id)
Recebe a agenda com o ID fornecido.
// Gets the public calendar "US Holidays" by ID. var calendar = CalendarApp.getCalendarById( 'en.usa#holiday@group.v.calendar.google.com'); Logger.log('The calendar is named "%s".', calendar.getName());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
id | String | o ID da agenda |
Retornar
Calendar
: a agenda com o ID fornecido, ou null
se a agenda não existir, se o usuário não puder acessá-la ou se o usuário não estiver inscrito na agenda.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getCalendarsByName(name)
Recebe todas as agendas com um determinado nome do usuário ou em que ele está inscrito. Os nomes não diferenciam maiúsculas de minúsculas.
// Gets the public calendar named "US Holidays". var calendars = CalendarApp.getCalendarsByName('US Holidays'); Logger.log('Found %s matching calendars.', calendars.length);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
name | String | o nome da agenda |
Retornar
Calendar[]
: todas as agendas com esse nome que o usuário pode acessar.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos 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()
Recebe a cor da agenda.
Retornar
String
: uma string de cor hexadecimal ("#rrggbb")
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getDefaultCalendar()
Recebe a agenda padrão do usuário.
// Determines the time zone of the user's default calendar. var calendar = CalendarApp.getDefaultCalendar(); Logger.log('My default calendar is set to the time zone "%s".', calendar.getTimeZone());
Retornar
Calendar
: a agenda padrão do usuário
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getDescription()
Recebe a descrição da agenda.
Retornar
String
: a descrição desta agenda
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventById(iCalId)
Recebe o evento com o ID fornecido. Se a série pertencer a uma agenda diferente da agenda
padrão, esse método precisará ser chamado nessa agenda. Chamar getEventById(iCalId)
só retorna um evento na agenda padrão.
Vários eventos podem ter o mesmo ID se fizerem parte de uma série de eventos. Nesse caso, esse método retorna apenas o primeiro evento da série.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
iCalId | String | ID do evento |
Retornar
CalendarEvent
: o evento com o código fornecido ou null
se o evento não existir ou se o usuário não puder acessá-lo.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventSeriesById(iCalId)
Recebe a série de eventos com o ID fornecido. Se o ID fornecido for para uma única CalendarEvent
,
uma CalendarEventSeries
será retornada com um único evento na série. Se
a série de eventos pertencer a uma agenda diferente da agenda padrão, esse método precisará ser
chamado a partir dessa CalendarApp
. Chamar getEventSeriesById(iCalId)
retorna diretamente apenas uma série de eventos que existe na agenda padrão.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
iCalId | String | ID da série de eventos |
Retornar
CalendarEventSeries
: a série com o ID fornecido, ou null
se a série não existir ou se o usuário não conseguir acessá-la
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEvents(startTime, endTime)
Recebe todos os eventos que ocorrem em um determinado período.
Esse método retorna eventos que começam durante o período especificado, terminam durante o período ou abrangem o intervalo de tempo. Se nenhum fuso horário for especificado, os valores serão interpretados no contexto do fuso horário do script, que pode ser diferente do fuso horário da agenda.
// Determines how many events are happening in the next two hours. var now = new Date(); var twoHoursFromNow = new Date(now.getTime() + (2 * 60 * 60 * 1000)); var events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow); Logger.log('Number of events: ' + events.length);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startTime | Date | o início do período |
endTime | Date | o fim do período, não inclusivo |
Retornar
CalendarEvent[]
: os eventos que ocorrem no período.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEvents(startTime, endTime, options)
Recebe todos os eventos que ocorrem em um determinado período e atendem aos critérios especificados.
Esse método retorna eventos que começam durante o período especificado, terminam durante o período ou abrangem o intervalo de tempo. Se nenhum fuso horário for especificado, os valores serão interpretados no contexto do fuso horário do script, que pode ser diferente do fuso horário da agenda.
A filtragem em author
, search
ou statusFilters
ocorre
após aplicar start
e max
. Isso significa que o número de eventos retornados pode ser menor que max
, mesmo que outros eventos atendam aos critérios.
// Determines how many events are happening in the next two hours that contain the term // "meeting". var now = new Date(); var twoHoursFromNow = new Date(now.getTime() + (2 * 60 * 60 * 1000)); var events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow, {search: 'meeting'}); Logger.log('Number of events: ' + events.length);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startTime | Date | o início do período |
endTime | Date | o fim do período, não inclusivo |
options | Object | um objeto JavaScript que especifica os parâmetros avançados, como listado abaixo |
Parâmetros avançados
Nome | Tipo | Descrição |
---|---|---|
start | Integer | o índice do primeiro evento a ser retornado |
max | Integer | o número máximo de eventos a serem retornados. |
author | String | um endereço de e-mail usado para filtrar os resultados pelo criador do evento; |
search | String | uma consulta de pesquisa de texto completo usada para filtrar resultados |
statusFilters[] | GuestStatus | uma matriz de status usada para filtrar resultados |
Retornar
CalendarEvent[]
: os eventos que ocorrem no período e correspondem aos critérios.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventsForDay(date)
Recebe todos os eventos que ocorrem em um determinado dia.
Esse método retorna eventos que começam durante o dia especificado, terminam durante o dia ou abrangem o dia.
Somente a parte da data do objeto de data é usada e a parte da hora é ignorada. A data é interpretada como meia-noite do dia seguinte à meia-noite do dia seguinte no fuso horário da agenda.
// Determines how many events are happening today. var today = new Date(); var events = CalendarApp.getDefaultCalendar().getEventsForDay(today); Logger.log('Number of events: ' + events.length);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
date | Date | a data para a qual os eventos serão recuperados (somente o dia é usado, o horário é ignorado). |
Retornar
CalendarEvent[]
: os eventos que ocorrem na data especificada.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventsForDay(date, options)
Recebe todos os eventos que ocorrem em um determinado dia e atendem aos critérios especificados.
Esse método retorna eventos que começam durante o dia especificado, terminam durante o dia ou abrangem o dia.
Somente a parte da data do objeto de data é usada e a parte da hora é ignorada. A data é interpretada como meia-noite do dia seguinte à meia-noite do dia seguinte no fuso horário da agenda.
A filtragem em author
, search
ou statusFilters
ocorre
após aplicar start
e max
. Isso significa que o número de eventos retornados pode ser menor que max
, mesmo que outros eventos atendam aos critérios.
// Determines how many events are happening today and contain the term "meeting". var today = new Date(); var events = CalendarApp.getDefaultCalendar().getEventsForDay(today, {search: 'meeting'}); Logger.log('Number of events: ' + events.length);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
date | Date | a data para a qual os eventos serão recuperados (somente o dia é usado, o horário é ignorado). |
options | Object | opções de filtragem avançada |
Parâmetros avançados
Nome | Tipo | Descrição |
---|---|---|
start | Integer | o índice do primeiro evento a ser retornado |
max | Integer | o número máximo de eventos a serem retornados. |
author | String | um endereço de e-mail usado para filtrar os resultados pelo criador do evento; |
search | String | uma consulta de pesquisa de texto completo usada para filtrar resultados |
statusFilters[] | GuestStatus | uma matriz de status usada para filtrar resultados |
Retornar
CalendarEvent[]
: os eventos que ocorrem na data especificada e correspondem aos critérios.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getId()
Recebe o ID da agenda. O ID da agenda padrão de um usuário é o endereço de e-mail dele.
Retornar
String
: o ID da agenda
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getName()
Recebe o nome da agenda.
Retornar
String
: nome desta agenda
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getOwnedCalendarById(id)
Recebe a agenda com o ID fornecido, se o usuário for o proprietário.
Para encontrar um ID de agenda, clique na seta ao lado do nome da agenda no Google Agenda e selecione Configurações da agenda. O ID é mostrado na parte inferior da página de configurações.
// Gets a (non-existent) private calendar by ID. var calendar = CalendarApp.getOwnedCalendarById( '123456789@group.calendar.google.com'); Logger.log('The calendar is named "%s".', calendar.getName());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
id | String | o ID da agenda |
Retornar
Calendar
: a agenda com o ID fornecido ou null
se a agenda não existir ou se o usuário não for o proprietário dela
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getOwnedCalendarsByName(name)
Recebe todas as agendas com um determinado nome de usuário. Os nomes não diferenciam maiúsculas de minúsculas.
// Gets a private calendar named "Travel Plans". var calendars = CalendarApp.getOwnedCalendarsByName('Travel Plans'); Logger.log('Found %s matching calendars.', calendars.length);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
name | String | o nome da agenda |
Retornar
Calendar[]
: todas as agendas com esse nome que pertencem ao usuário
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getTimeZone()
Acessa o fuso horário da agenda.
Retornar
String
: o fuso horário, especificado no formato "longo" (por exemplo, "EUA/Nova_York", conforme listado por Joda.org)
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isHidden()
Determina se a agenda está oculta na interface do usuário.
Retornar
Boolean
: true
se a agenda estiver oculta na interface do usuário; false
se não estiver
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isMyPrimaryCalendar()
Determina se o calendário é o padrão para o usuário efetivo.
Retornar
Boolean
: true
se a agenda for a agenda padrão do usuário efetivo. Caso contrário, será false
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isOwnedByMe()
Determina se o usuário é o proprietário da agenda.
Retornar
Boolean
— true
se a agenda pertencer ao usuário efetivo. false
se não for
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isSelected()
Determina se os eventos da agenda são exibidos na interface do usuário.
Retornar
Boolean
: true
se os eventos da agenda forem exibidos na interface do usuário; false
se não forem
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
newRecurrence()
Cria um novo objeto de recorrência, que pode ser usado para criar regras de recorrência de evento.
// Creates an event series for a no-meetings day, taking place every Wednesday in 2013. var recurrence = CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014')); var eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries('No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), recurrence); Logger.log('Event Series ID: ' + eventSeries.getId());
Retornar
EventRecurrence
: um novo objeto de recorrência sem regras definidas (se comporta como uma recorrência semanal)
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
setColor(color)
Define a cor da agenda.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
color | String | Uma CalendarApp.Color ou uma string de cor hexadecimal
("#rrggbb"). |
Retornar
Calendar
: esta agenda para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setDescription(description)
Define a descrição da agenda.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
description | String | a descrição desta agenda |
Retornar
Calendar
: esta agenda para encadeamentos
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setHidden(hidden)
Define se a agenda é visível na interface do usuário.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
hidden | Boolean | true para ocultar a agenda na interface do usuário e false para a mostrar |
Retornar
Calendar
: esta agenda para encadeamentos
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setName(name)
Define o nome da agenda.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
name | String | o novo nome |
Retornar
Calendar
: esta agenda para encadeamentos
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setSelected(selected)
Define se os eventos da agenda são exibidos na interface do usuário.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
selected | Boolean | true para mostrar os eventos da agenda na interface do usuário e false
para ocultá-los |
Retornar
Calendar
: esta agenda para encadeamentos
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setTimeZone(timeZone)
Define o fuso horário da agenda.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
timeZone | String | o fuso horário, especificado no formato "longo" (por exemplo, "EUA/Nova_York", conforme listado por Joda.org) |
Retornar
Calendar
: esta agenda para encadeamentos
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
subscribeToCalendar(id)
Inscreve o usuário no calendário com o ID fornecido, se o usuário tiver permissão para se inscrever.
// Subscribe to the calendar "US Holidays". var calendar = CalendarApp.subscribeToCalendar( 'en.usa#holiday@group.v.calendar.google.com'); Logger.log('Subscribed to the calendar "%s".', calendar.getName());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
id | String | o ID da agenda para se inscrever |
Retornar
Calendar
: a agenda recém-assinada
Gera
Error
: caso não exista uma agenda com esse ID.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
subscribeToCalendar(id, options)
Inscreve o usuário no calendário com o ID fornecido, se o usuário tiver permissão para se inscrever.
// Subscribe to the calendar "US Holidays", and set it to the color blue. var calendar = CalendarApp.subscribeToCalendar( 'en.usa#holiday@group.v.calendar.google.com', { color: CalendarApp.Color.BLUE }); Logger.log('Subscribed to the calendar "%s".', calendar.getName());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
id | String | o ID da agenda para se inscrever |
options | Object | um objeto JavaScript que especifica os parâmetros avançados, como listado abaixo |
Parâmetros avançados
Nome | Tipo | Descrição |
---|---|---|
color | String | uma string de cor hexadecimal ("#rrggbb") ou um valor de CalendarApp.Colors . |
hidden | Boolean | se a agenda está oculta na interface do usuário (padrão:
false ) |
selected | Boolean | se os eventos da agenda são exibidos na interface do
usuário (padrão: true ) |
Retornar
Calendar
: a agenda recém-assinada
Gera
Error
: caso não exista uma agenda com esse ID.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds