Calendar Service

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.
Agenda

Esse serviço permite que um script acesse e modifique o Google Agenda do usuário, incluindo agendas adicionais em que o usuário está inscrito.

Classes

NomeBreve descrição
CalendarRepresenta uma agenda que pertence ao usuário ou que está inscrita.
CalendarAppPermite que um script leia e atualize o Google Agenda do usuário.
CalendarEventRepresenta um único evento da agenda.
CalendarEventSeriesRepresenta uma série de eventos (um evento recorrente).
ColorUma enumeração que representa as cores nomeadas disponíveis no serviço do Agenda.
EventColorUma enumeração que representa as cores de eventos nomeadas disponíveis no serviço do Agenda.
EventGuestRepresenta um convidado de um evento.
EventRecurrenceRepresenta as configurações de recorrência de uma série de eventos.
GuestStatusUma enumeração que representa os status que um convidado pode ter em um evento.
RecurrenceRuleRepresenta uma regra de recorrência de uma série de eventos.
VisibilityUma enumeração que representa a visibilidade de um evento.

Calendar

Métodos

MétodoTipo de retornoBreve descrição
createAllDayEvent(title, date)CalendarEventCria um novo evento de dia inteiro.
createAllDayEvent(title, startDate, endDate)CalendarEventCria um novo evento de dia inteiro.
createAllDayEvent(title, startDate, endDate, options)CalendarEventCria um novo evento de dia inteiro.
createAllDayEvent(title, date, options)CalendarEventCria um novo evento de dia inteiro.
createAllDayEventSeries(title, startDate, recurrence)CalendarEventSeriesCria uma nova série de eventos de dia inteiro.
createAllDayEventSeries(title, startDate, recurrence, options)CalendarEventSeriesCria uma nova série de eventos de dia inteiro.
createEvent(title, startTime, endTime)CalendarEventCria um evento.
createEvent(title, startTime, endTime, options)CalendarEventCria um evento.
createEventFromDescription(description)CalendarEventCria um evento de uma descrição em formato livre.
createEventSeries(title, startTime, endTime, recurrence)CalendarEventSeriesCria uma nova série de eventos.
createEventSeries(title, startTime, endTime, recurrence, options)CalendarEventSeriesCria uma nova série de eventos.
deleteCalendar()voidExclui a agenda permanentemente.
getColor()StringRecebe a cor da agenda.
getDescription()StringRecebe a descrição da agenda.
getEventById(iCalId)CalendarEventRecebe o evento com o ID informado.
getEventSeriesById(iCalId)CalendarEventSeriesRecebe 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()StringRecebe o ID da agenda.
getName()StringRecebe o nome da agenda.
getTimeZone()StringRecebe o fuso horário da agenda.
isHidden()BooleanDetermina se a agenda está oculta na interface do usuário.
isMyPrimaryCalendar()BooleanDetermina se a agenda é o padrão para o usuário efetivo.
isOwnedByMe()BooleanDetermina se o calendário pertence ao usuário efetivo.
isSelected()BooleanDetermina se os eventos da agenda são exibidos na interface do usuário.
setColor(color)CalendarDefine a cor da agenda.
setDescription(description)CalendarDefine a descrição da agenda.
setHidden(hidden)CalendarDefine se a agenda é visível na interface do usuário.
setName(name)CalendarDefine o nome da agenda.
setSelected(selected)CalendarDefine se os eventos da agenda serão exibidos na interface do usuário.
setTimeZone(timeZone)CalendarDefine o fuso horário da agenda.
unsubscribeFromCalendar()voidCancela a inscrição do usuário na agenda.

CalendarApp

Propriedades

PropriedadeTipoDescrição
ColorColorUma enumeração que representa as cores nomeadas disponíveis no serviço do Agenda.
EventColorEventColorUma enumeração que representa as cores de eventos nomeadas disponíveis no serviço do Agenda.
GuestStatusGuestStatusUma enumeração que representa os status que um convidado pode ter em um evento.
MonthMonthUma enumeração que representa os meses do ano.
VisibilityVisibilityUma enumeração que representa a visibilidade de um evento.
WeekdayWeekdayUma enumeração que representa os dias da semana.

Métodos

MétodoTipo de retornoBreve descrição
createAllDayEvent(title, date)CalendarEventCria um novo evento de dia inteiro.
createAllDayEvent(title, startDate, endDate)CalendarEventCria um novo evento de dia inteiro.
createAllDayEvent(title, startDate, endDate, options)CalendarEventCria um novo evento de dia inteiro.
createAllDayEvent(title, date, options)CalendarEventCria um novo evento de dia inteiro.
createAllDayEventSeries(title, startDate, recurrence)CalendarEventSeriesCria uma nova série de eventos de dia inteiro.
createAllDayEventSeries(title, startDate, recurrence, options)CalendarEventSeriesCria uma nova série de eventos de dia inteiro.
createCalendar(name)CalendarCria uma nova agenda que pertence ao usuário.
createCalendar(name, options)CalendarCria uma nova agenda que pertence ao usuário.
createEvent(title, startTime, endTime)CalendarEventCria um evento.
createEvent(title, startTime, endTime, options)CalendarEventCria um evento.
createEventFromDescription(description)CalendarEventCria um evento de uma descrição em formato livre.
createEventSeries(title, startTime, endTime, recurrence)CalendarEventSeriesCria uma nova série de eventos.
createEventSeries(title, startTime, endTime, recurrence, options)CalendarEventSeriesCria uma nova série de eventos.
getAllCalendars()Calendar[]Recebe todas as agendas do usuário ou em que o usuário está inscrito.
getAllOwnedCalendars()Calendar[]Recebe todas as agendas do usuário.
getCalendarById(id)CalendarRecebe a agenda com o ID fornecido.
getCalendarsByName(name)Calendar[]Recebe todas as agendas com um nome específico que o usuário possui ou está inscrito.
getColor()StringRecebe a cor da agenda.
getDefaultCalendar()CalendarRecebe a agenda padrão do usuário.
getDescription()StringRecebe a descrição da agenda.
getEventById(iCalId)CalendarEventRecebe o evento com o ID informado.
getEventSeriesById(iCalId)CalendarEventSeriesRecebe 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()StringRecebe o ID da agenda.
getName()StringRecebe o nome da agenda.
getOwnedCalendarById(id)CalendarRecebe a agenda com o ID fornecido, se o usuário for o proprietário dela.
getOwnedCalendarsByName(name)Calendar[]Recebe todas as agendas com um nome específico que pertence ao usuário.
getTimeZone()StringRecebe o fuso horário da agenda.
isHidden()BooleanDetermina se a agenda está oculta na interface do usuário.
isMyPrimaryCalendar()BooleanDetermina se a agenda é o padrão para o usuário efetivo.
isOwnedByMe()BooleanDetermina se o calendário pertence ao usuário efetivo.
isSelected()BooleanDetermina se os eventos da agenda são exibidos na interface do usuário.
newRecurrence()EventRecurrenceCria um novo objeto de recorrência, que pode ser usado para criar regras de recorrência de eventos.
setColor(color)CalendarDefine a cor da agenda.
setDescription(description)CalendarDefine a descrição da agenda.
setHidden(hidden)CalendarDefine se a agenda é visível na interface do usuário.
setName(name)CalendarDefine o nome da agenda.
setSelected(selected)CalendarDefine se os eventos da agenda serão exibidos na interface do usuário.
setTimeZone(timeZone)CalendarDefine o fuso horário da agenda.
subscribeToCalendar(id)CalendarInscreve o usuário na agenda com o ID fornecido, se o usuário tiver permissão para se inscrever.
subscribeToCalendar(id, options)CalendarInscreve o usuário na agenda com o ID fornecido, se o usuário tiver permissão para se inscrever.

CalendarEvent

Métodos

MétodoTipo de retornoBreve descrição
addEmailReminder(minutesBefore)CalendarEventAdiciona um novo lembrete por e-mail ao evento.
addGuest(email)CalendarEventAdiciona um convidado ao evento.
addPopupReminder(minutesBefore)CalendarEventAdiciona um novo lembrete pop-up ao evento.
addSmsReminder(minutesBefore)CalendarEventAdiciona um novo lembrete por SMS ao evento.
anyoneCanAddSelf()BooleanDefine se alguém pode convidar a si mesmo.
deleteEvent()voidExclui o evento.
deleteTag(key)CalendarEventExclui uma tag de chave-valor do evento.
getAllDayEndDate()DateRecebe a data de término do evento da agenda durante todo o dia.
getAllDayStartDate()DateRecebe a data de início deste evento na agenda de um dia inteiro.
getAllTagKeys()String[]Acessa todas as chaves de tags que foram definidas no evento.
getColor()StringRetorna a cor do evento da agenda.
getCreators()String[]Recebe os criadores do evento.
getDateCreated()DateAcessa a data de criação do evento.
getDescription()StringRecebe a descrição do evento.
getEmailReminders()Integer[]Recebe os valores de minutos de todos os lembretes por e-mail do evento.
getEndTime()DateRecebe a data e a hora em que o evento da agenda termina.
getEventSeries()CalendarEventSeriesRecebe a série de eventos recorrentes aos quais este evento pertence.
getGuestByEmail(email)EventGuestRecebe um convidado por endereço de e-mail.
getGuestList()EventGuest[]Recebe os convidados do evento, sem incluir o proprietário.
getGuestList(includeOwner)EventGuest[]Recebe os convidados do evento, possivelmente incluindo os proprietários.
getId()StringRecebe o iCalUID exclusivo do evento.
getLastUpdated()DateRecebe a data da última atualização do evento.
getLocation()StringAcessa o local do evento.
getMyStatus()GuestStatusRecebe o status de evento (participante etc.) do usuário efetivo.
getOriginalCalendarId()StringObter o ID da agenda em que o evento foi criado originalmente.
getPopupReminders()Integer[]Recebe os valores de minutos de todos os lembretes pop-up do evento.
getSmsReminders()Integer[]Recebe os valores de minutos de todos os lembretes por SMS do evento.
getStartTime()DateRecebe a data e a hora em que o evento da agenda começa.
getTag(key)StringAcessa um valor de tag do evento.
getTitle()StringRecebe o título do evento.
getVisibility()VisibilityRecebe a visibilidade do evento.
guestsCanInviteOthers()BooleanDetermina se é possível convidar outras pessoas.
guestsCanModify()BooleanDetermina se os convidados podem modificar o evento.
guestsCanSeeGuests()BooleanDetermina se os convidados podem ver outras pessoas.
isAllDayEvent()BooleanDetermina se esse é um evento de dia inteiro.
isOwnedByMe()BooleanDetermina se o evento pertence ao usuário efetivo.
isRecurringEvent()BooleanDetermina se o evento faz parte de uma série de eventos.
removeAllReminders()CalendarEventRemove todos os lembretes do evento.
removeGuest(email)CalendarEventRemove um convidado do evento.
resetRemindersToDefault()CalendarEventRedefine os lembretes usando as configurações padrão da agenda.
setAllDayDate(date)CalendarEventDefine a data do evento.
setAllDayDates(startDate, endDate)CalendarEventDefine as datas do evento.
setAnyoneCanAddSelf(anyoneCanAddSelf)CalendarEventDefine se pessoas que não foram convidadas podem se adicionar ao evento.
setColor(color)CalendarEventDefine a cor do evento da agenda.
setDescription(description)CalendarEventDefine a descrição do evento.
setGuestsCanInviteOthers(guestsCanInviteOthers)CalendarEventDefine se os convidados podem convidar outras pessoas.
setGuestsCanModify(guestsCanModify)CalendarEventDefine se os convidados podem modificar o evento.
setGuestsCanSeeGuests(guestsCanSeeGuests)CalendarEventDefine se os convidados podem ver outras pessoas.
setLocation(location)CalendarEventDefine o local do evento.
setMyStatus(status)CalendarEventDefine o status do evento (participação etc.) do usuário efetivo.
setTag(key, value)CalendarEventDefine uma tag de chave-valor no evento para armazenar metadados personalizados.
setTime(startTime, endTime)CalendarEventDefine as datas e os horários de início e término do evento.
setTitle(title)CalendarEventDefine o título do evento.
setVisibility(visibility)CalendarEventDefine a visibilidade do evento.

CalendarEventSeries

Métodos

MétodoTipo de retornoBreve descrição
addEmailReminder(minutesBefore)CalendarEventSeriesAdiciona um novo lembrete por e-mail ao evento.
addGuest(email)CalendarEventSeriesAdiciona um convidado ao evento.
addPopupReminder(minutesBefore)CalendarEventSeriesAdiciona um novo lembrete pop-up ao evento.
addSmsReminder(minutesBefore)CalendarEventSeriesAdiciona um novo lembrete por SMS ao evento.
anyoneCanAddSelf()BooleanDefine se alguém pode convidar a si mesmo.
deleteEventSeries()voidExclui a série de eventos.
deleteTag(key)CalendarEventSeriesExclui uma tag de chave-valor do evento.
getAllTagKeys()String[]Acessa todas as chaves de tags que foram definidas no evento.
getColor()StringRetorna a cor do evento da agenda.
getCreators()String[]Recebe os criadores do evento.
getDateCreated()DateAcessa a data de criação do evento.
getDescription()StringRecebe a descrição do evento.
getEmailReminders()Integer[]Recebe os valores de minutos de todos os lembretes por e-mail do evento.
getGuestByEmail(email)EventGuestRecebe um convidado por endereço de e-mail.
getGuestList()EventGuest[]Recebe os convidados do evento, sem incluir o proprietário.
getGuestList(includeOwner)EventGuest[]Recebe os convidados do evento, possivelmente incluindo os proprietários.
getId()StringRecebe o iCalUID exclusivo do evento.
getLastUpdated()DateRecebe a data da última atualização do evento.
getLocation()StringAcessa o local do evento.
getMyStatus()GuestStatusRecebe o status de evento (participante etc.) do usuário efetivo.
getOriginalCalendarId()StringObter o ID da agenda em que o evento foi criado originalmente.
getPopupReminders()Integer[]Recebe os valores de minutos de todos os lembretes pop-up do evento.
getSmsReminders()Integer[]Recebe os valores de minutos de todos os lembretes por SMS do evento.
getTag(key)StringAcessa um valor de tag do evento.
getTitle()StringRecebe o título do evento.
getVisibility()VisibilityRecebe a visibilidade do evento.
guestsCanInviteOthers()BooleanDetermina se é possível convidar outras pessoas.
guestsCanModify()BooleanDetermina se os convidados podem modificar o evento.
guestsCanSeeGuests()BooleanDetermina se os convidados podem ver outras pessoas.
isOwnedByMe()BooleanDetermina se o evento pertence ao usuário efetivo.
removeAllReminders()CalendarEventSeriesRemove todos os lembretes do evento.
removeGuest(email)CalendarEventSeriesRemove um convidado do evento.
resetRemindersToDefault()CalendarEventSeriesRedefine os lembretes usando as configurações padrão da agenda.
setAnyoneCanAddSelf(anyoneCanAddSelf)CalendarEventSeriesDefine se pessoas que não foram convidadas podem se adicionar ao evento.
setColor(color)CalendarEventSeriesDefine a cor do evento da agenda.
setDescription(description)CalendarEventSeriesDefine a descrição do evento.
setGuestsCanInviteOthers(guestsCanInviteOthers)CalendarEventSeriesDefine se os convidados podem convidar outras pessoas.
setGuestsCanModify(guestsCanModify)CalendarEventSeriesDefine se os convidados podem modificar o evento.
setGuestsCanSeeGuests(guestsCanSeeGuests)CalendarEventSeriesDefine se os convidados podem ver outras pessoas.
setLocation(location)CalendarEventSeriesDefine o local do evento.
setMyStatus(status)CalendarEventSeriesDefine o status do evento (participação etc.) do usuário efetivo.
setRecurrence(recurrence, startDate)CalendarEventSeriesDefine as regras de recorrência para uma série de eventos de dia inteiro.
setRecurrence(recurrence, startTime, endTime)CalendarEventSeriesDefine as regras de recorrência para esta série de eventos.
setTag(key, value)CalendarEventSeriesDefine uma tag de chave-valor no evento para armazenar metadados personalizados.
setTitle(title)CalendarEventSeriesDefine o título do evento.
setVisibility(visibility)CalendarEventSeriesDefine a visibilidade do evento.

Color

Propriedades

PropriedadeTipoDescrição
BLUEEnum
Azul (#2952A3).
BROWNEnum
Marrom (#8D6F47).
CHARCOALEnum
Carvão (#4E5D6C).
CHESTNUTEnum
Castanha (#865A5A).
GRAYEnum
Cinza (#5A6986).
GREENEnum
Verde (#0D7813).
INDIGOEnum
Anil (#5229A3).
LIMEEnum
Lima (#528800).
MUSTARDEnum
Mostarda (#88880E).
OLIVEEnum
Azeitonas (#6E6E41).
ORANGEEnum
Laranja (#BE6D00).
PINKEnum
Rosa (#B1365F).
PLUMEnum
Ameixa (#705770).
PURPLEEnum
Roxo (#7A367A).
REDEnum
Vermelho (#A32929).
RED_ORANGEEnum
Laranja-vermelha (#B1440E).
SEA_BLUEEnum
Azul-marinho (#29527A).
SLATEEnum
barreira (#4A716C).
TEALEnum
Verde-azulado (#28754E).
TURQOISEEnum
Turquesa (#1B887A).
YELLOWEnum
Amarelo (#AB8B00).

EventColor

Propriedades

PropriedadeTipoDescrição
PALE_BLUEEnum
Azul-claro ("1").
PALE_GREENEnum
Verde-claro ("2").
MAUVEEnum
Mauve ("3").
PALE_REDEnum
Vermelho-pálido ("4").
YELLOWEnum
Amarelo ("5").
ORANGEEnum
Laranja ("6").
CYANEnum
Ciano ("7").
GRAYEnum
Cinza ("8").
BLUEEnum
Azul ("9").
GREENEnum
Verde ("10").
REDEnum
Vermelho ("11").

EventGuest

Métodos

MétodoTipo de retornoBreve descrição
getAdditionalGuests()IntegerRecebe o número de pessoas adicionais que este convidado afirma que estará participando.
getEmail()StringRecebe o endereço de e-mail do convidado.
getGuestStatus()GuestStatusRecebe o status do convidado do evento.
getName()StringRecebe o nome do convidado.

EventRecurrence

Métodos

MétodoTipo de retornoBreve descrição
addDailyExclusion()RecurrenceRuleAdiciona uma regra que exclui ocorrências diariamente.
addDailyRule()RecurrenceRuleAdiciona uma regra que faz com que o evento se repita diariamente.
addDate(date)EventRecurrenceAdiciona uma regra que faz com que o evento se repita em uma data específica.
addDateExclusion(date)EventRecurrenceAdiciona uma regra que exclui uma ocorrência em uma data específica.
addMonthlyExclusion()RecurrenceRuleAdiciona uma regra que exclui ocorrências mensalmente.
addMonthlyRule()RecurrenceRuleAdiciona uma regra que faz com que o evento se repita mensalmente.
addWeeklyExclusion()RecurrenceRuleAdiciona uma regra que exclui ocorrências semanalmente.
addWeeklyRule()RecurrenceRuleAdiciona uma regra que faz com que o evento se repita semanalmente.
addYearlyExclusion()RecurrenceRuleAdiciona uma regra que exclui ocorrências anualmente.
addYearlyRule()RecurrenceRuleAdiciona uma regra que faz com que o evento se repita anualmente.
setTimeZone(timeZone)EventRecurrenceDefine o fuso horário para essa recorrência.

GuestStatus

Propriedades

PropriedadeTipoDescrição
INVITEDEnumA pessoa foi convidada, mas não indicou se vai participar.
MAYBEEnumO convidado indicou que talvez possa participar.
NOEnumO convidado indicou que não vai participar.
OWNEREnumO convidado é o proprietário do evento.
YESEnumO convidado indicou que vai participar.

RecurrenceRule

Métodos

MétodoTipo de retornoBreve descrição
addDailyExclusion()RecurrenceRuleAdiciona uma regra que exclui ocorrências diariamente.
addDailyRule()RecurrenceRuleAdiciona uma regra que faz com que o evento se repita diariamente.
addDate(date)EventRecurrenceAdiciona uma regra que faz com que o evento se repita em uma data específica.
addDateExclusion(date)EventRecurrenceAdiciona uma regra que exclui uma ocorrência em uma data específica.
addMonthlyExclusion()RecurrenceRuleAdiciona uma regra que exclui ocorrências mensalmente.
addMonthlyRule()RecurrenceRuleAdiciona uma regra que faz com que o evento se repita mensalmente.
addWeeklyExclusion()RecurrenceRuleAdiciona uma regra que exclui ocorrências semanalmente.
addWeeklyRule()RecurrenceRuleAdiciona uma regra que faz com que o evento se repita semanalmente.
addYearlyExclusion()RecurrenceRuleAdiciona uma regra que exclui ocorrências anualmente.
addYearlyRule()RecurrenceRuleAdiciona uma regra que faz com que o evento se repita anualmente.
interval(interval)RecurrenceRuleConfigura a regra para ser aplicada somente neste intervalo da unidade de tempo da regra.
onlyInMonth(month)RecurrenceRuleConfigura a regra para ser aplicada somente a um mês específico.
onlyInMonths(months)RecurrenceRuleConfigura a regra para ser aplicada somente a meses específicos.
onlyOnMonthDay(day)RecurrenceRuleConfigura a regra para ser aplicada somente a um dia específico do mês.
onlyOnMonthDays(days)RecurrenceRuleConfigura a regra para ser aplicada somente a dias específicos do mês.
onlyOnWeek(week)RecurrenceRuleConfigura a regra para ser aplicada somente a uma semana específica do ano.
onlyOnWeekday(day)RecurrenceRuleConfigura a regra para ser aplicada somente a um dia específico da semana.
onlyOnWeekdays(days)RecurrenceRuleConfigura a regra para ser aplicada somente a dias específicos da semana.
onlyOnWeeks(weeks)RecurrenceRuleConfigura a regra para ser aplicada somente a semanas específicas do ano.
onlyOnYearDay(day)RecurrenceRuleConfigura a regra para ser aplicada somente a um dia específico do ano.
onlyOnYearDays(days)RecurrenceRuleConfigura a regra para ser aplicada somente a dias específicos do ano.
setTimeZone(timeZone)EventRecurrenceDefine o fuso horário para essa recorrência.
times(times)RecurrenceRuleConfigura a regra para terminar após um determinado número de ocorrências.
until(endDate)RecurrenceRuleConfigura a regra para terminar em uma determinada data (inclusive).
weekStartsOn(day)RecurrenceRuleConfigura o dia da semana em que começa a aplicar a regra.

Visibility

Propriedades

PropriedadeTipoDescrição
CONFIDENTIALEnumO evento é privado.
DEFAULTEnumUsa a visibilidade padrão para eventos na agenda.
PRIVATEEnumO evento é privado, e apenas os participantes dele poderão ver os detalhes.
PUBLICEnumO evento é público, e os detalhes dele ficam visíveis para todos os leitores da agenda.