Calendar Service

Agenda

Esse serviço permite que um script acesse e modifique a agenda do usuário, incluindo outras agendas em que o usuário está inscrito.

Classes

NomeBreve descrição
CalendarRepresenta uma agenda da qual o usuário é proprietário ou está inscrito.
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).
ColorUm enum que representa as cores nomeadas disponíveis no serviço de agenda.
EventColorUm enum que representa as cores de evento nomeadas disponíveis no serviço de agenda.
EventGuestRepresenta um convidado de um evento.
EventRecurrenceRepresenta as configurações de recorrência de uma série de eventos.
GuestStatusUm enum que representa os status que um convidado pode ter para um evento.
RecurrenceRuleRepresenta uma regra de recorrência para uma série de eventos.
VisibilityUm enum 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 com duração de vários dias.
createAllDayEvent(title, startDate, endDate, options)CalendarEventCria um novo evento de dia inteiro com duração de vários dias.
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 novo evento.
createEvent(title, startTime, endTime, options)CalendarEventCria um novo 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()StringObtém a cor da agenda.
getDescription()StringObtém a descrição da agenda.
getEventById(iCalId)CalendarEventObtém o evento com o ID fornecido.
getEventSeriesById(iCalId)CalendarEventSeriesObtém a série de eventos com o ID fornecido.
getEvents(startTime, endTime)CalendarEvent[]Obtém todos os eventos que ocorrem em um determinado período.
getEvents(startTime, endTime, options)CalendarEvent[]Obtém todos os eventos que ocorrem em um determinado intervalo de tempo e atendem aos critérios especificados.
getEventsForDay(date)CalendarEvent[]Obtém todos os eventos que ocorrem em um determinado dia.
getEventsForDay(date, options)CalendarEvent[]Obtém todos os eventos que ocorrem em um determinado dia e atendem aos critérios especificados.
getId()StringObtém o ID da agenda.
getName()StringObtém o nome da agenda.
getTimeZone()StringObtém o fuso horário da agenda.
isHidden()BooleanDetermina se a agenda está oculta na interface do usuário.
isMyPrimaryCalendar()BooleanDetermina se a agenda é a principal para o usuário efetivo.
isOwnedByMe()BooleanDetermina se a agenda pertence a você.
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 de uma agenda.
setHidden(hidden)CalendarDefine se a agenda ficará 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 em uma agenda.

CalendarApp

Propriedades

PropriedadeTipoDescrição
ColorColorUm enum que representa as cores nomeadas disponíveis no serviço de agenda.
EventColorEventColorUm enum que representa as cores de evento nomeadas disponíveis no serviço de agenda.
GuestStatusGuestStatusUm enum que representa os status que um convidado pode ter para um evento.
MonthMonthUm enum que representa os meses do ano.
VisibilityVisibilityUm enum que representa a visibilidade de um evento.
WeekdayWeekdayUm enum 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 com duração de vários dias.
createAllDayEvent(title, startDate, endDate, options)CalendarEventCria um novo evento de dia inteiro com duração de vários dias.
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 novo evento.
createEvent(title, startTime, endTime, options)CalendarEventCria um novo 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 das quais o usuário é proprietário ou está inscrito.
getAllOwnedCalendars()Calendar[]Obtém todas as agendas que pertencem ao usuário.
getCalendarById(id)CalendarObtém a agenda com o ID fornecido.
getCalendarsByName(name)Calendar[]Recebe todas as agendas com um determinado nome que pertence ao usuário ou está inscrito.
getColor()StringObtém a cor da agenda.
getDefaultCalendar()CalendarObtém a agenda padrão do usuário.
getDescription()StringObtém a descrição da agenda.
getEventById(iCalId)CalendarEventObtém o evento com o ID fornecido.
getEventSeriesById(iCalId)CalendarEventSeriesObtém a série de eventos com o ID fornecido.
getEvents(startTime, endTime)CalendarEvent[]Obtém todos os eventos que ocorrem em um determinado período.
getEvents(startTime, endTime, options)CalendarEvent[]Obtém todos os eventos que ocorrem em um determinado intervalo de tempo e atendem aos critérios especificados.
getEventsForDay(date)CalendarEvent[]Obtém todos os eventos que ocorrem em um determinado dia.
getEventsForDay(date, options)CalendarEvent[]Obtém todos os eventos que ocorrem em um determinado dia e atendem aos critérios especificados.
getId()StringObtém o ID da agenda.
getName()StringObtém o nome da agenda.
getOwnedCalendarById(id)CalendarObtém a agenda com o ID fornecido, se o usuário for o proprietário.
getOwnedCalendarsByName(name)Calendar[]Obtém todas as agendas com um determinado nome que pertence ao usuário.
getTimeZone()StringObtém o fuso horário da agenda.
isHidden()BooleanDetermina se a agenda está oculta na interface do usuário.
isMyPrimaryCalendar()BooleanDetermina se a agenda é a principal para o usuário efetivo.
isOwnedByMe()BooleanDetermina se a agenda pertence a você.
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 de uma agenda.
setHidden(hidden)CalendarDefine se a agenda ficará 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 código fornecido, se o usuário tiver permissão para se inscrever.
subscribeToCalendar(id, options)CalendarInscreve o usuário na agenda com o código 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 uma nova notificação pop-up ao evento.
addSmsReminder(minutesBefore)CalendarEventAdiciona um novo lembrete por SMS ao evento.
anyoneCanAddSelf()BooleanDetermina se as pessoas podem se adicionar como convidados a um evento do Google Agenda.
deleteEvent()voidExclui um evento do Google Agenda.
deleteTag(key)CalendarEventExclui uma tag de chave-valor do evento.
getAllDayEndDate()DateObtém a data de término deste evento de agenda de dia inteiro.
getAllDayStartDate()DateObtém a data de início deste evento de agenda de dia inteiro.
getAllTagKeys()String[]Obtém todas as chaves para tags que foram definidas no evento.
getColor()StringRetorna a cor do evento da agenda.
getCreators()String[]Obtém os criadores de um evento.
getDateCreated()DateObtém a data de criação do evento.
getDescription()StringObtém a descrição do evento.
getEmailReminders()Integer[]Recebe os valores dos minutos de todos os lembretes de e-mail para o evento.
getEndTime()DateObtém a data e a hora em que o evento da agenda termina.
getEventSeries()CalendarEventSeriesObtém 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 do evento.
getGuestList(includeOwner)EventGuest[]Obtém os convidados para o evento, possivelmente incluindo os proprietários do evento.
getId()StringObtém o iCalUID exclusivo do evento.
getLastUpdated()DateObtém a data da última atualização do evento.
getLocation()StringObtém o local do evento.
getMyStatus()GuestStatusObtém o status de evento (como o usuário convidado ou convidado) do usuário efetivo.
getOriginalCalendarId()StringObtém o ID da agenda onde o evento foi criado originalmente.
getPopupReminders()Integer[]Obtém os valores de minutos de todos os lembretes pop-up para o evento.
getSmsReminders()Integer[]Recebe os valores dos minutos de todos os lembretes por SMS do evento.
getStartTime()DateObtém a data e a hora em que o evento da agenda começa.
getTag(key)StringObtém um valor de tag para o evento.
getTitle()StringObtém o título do evento.
getVisibility()VisibilityObtém 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 é um evento de dia inteiro.
isOwnedByMe()BooleanDetermina se você é o proprietário do evento.
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 não convidados 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 convidados podem convidar outras pessoas.
setGuestsCanModify(guestsCanModify)CalendarEventDefine se os convidados podem modificar o evento.
setGuestsCanSeeGuests(guestsCanSeeGuests)CalendarEventDefine se os convidados podem ver outros convidados.
setLocation(location)CalendarEventDefine o local do evento.
setMyStatus(status)CalendarEventDefine o status do evento (como um convidado ou convidado) 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 para o início e o fim 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 uma nova notificação pop-up ao evento.
addSmsReminder(minutesBefore)CalendarEventSeriesAdiciona um novo lembrete por SMS ao evento.
anyoneCanAddSelf()BooleanDetermina se as pessoas podem se adicionar como convidados a um evento do Google Agenda.
deleteEventSeries()voidExclui a série de eventos.
deleteTag(key)CalendarEventSeriesExclui uma tag de chave-valor do evento.
getAllTagKeys()String[]Obtém todas as chaves para tags que foram definidas no evento.
getColor()StringRetorna a cor do evento da agenda.
getCreators()String[]Obtém os criadores de um evento.
getDateCreated()DateObtém a data de criação do evento.
getDescription()StringObtém a descrição do evento.
getEmailReminders()Integer[]Recebe os valores dos minutos de todos os lembretes de e-mail para o evento.
getGuestByEmail(email)EventGuestRecebe um convidado por endereço de e-mail.
getGuestList()EventGuest[]Recebe os convidados do evento, sem incluir o proprietário do evento.
getGuestList(includeOwner)EventGuest[]Obtém os convidados para o evento, possivelmente incluindo os proprietários do evento.
getId()StringObtém o iCalUID exclusivo do evento.
getLastUpdated()DateObtém a data da última atualização do evento.
getLocation()StringObtém o local do evento.
getMyStatus()GuestStatusObtém o status de evento (como o usuário convidado ou convidado) do usuário efetivo.
getOriginalCalendarId()StringObtém o ID da agenda onde o evento foi criado originalmente.
getPopupReminders()Integer[]Obtém os valores de minutos de todos os lembretes pop-up para o evento.
getSmsReminders()Integer[]Recebe os valores dos minutos de todos os lembretes por SMS do evento.
getTag(key)StringObtém um valor de tag para o evento.
getTitle()StringObtém o título do evento.
getVisibility()VisibilityObtém 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 você é o proprietário do evento.
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 não convidados 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 convidados podem convidar outras pessoas.
setGuestsCanModify(guestsCanModify)CalendarEventSeriesDefine se os convidados podem modificar o evento.
setGuestsCanSeeGuests(guestsCanSeeGuests)CalendarEventSeriesDefine se os convidados podem ver outros convidados.
setLocation(location)CalendarEventSeriesDefine o local do evento.
setMyStatus(status)CalendarEventSeriesDefine o status do evento (como um convidado ou convidado) 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
Índigo (#5229A3).
LIMEEnum
Lima (#528800).
MUSTARDEnum
Mostarda (#88880E).
OLIVEEnum
Verde-oliva (#6E6E41).
ORANGEEnum
Laranja (#BE6D00).
PINKEnum
Rosa (#B1365F).
PLUMEnum
Ameixa (#705770).
PURPLEEnum
Roxo (#7A367A).
REDEnum
Vermelho (#A32929).
RED_ORANGEEnum
Laranja-vermelho (#B1440E).
SEA_BLUEEnum
Azul-marinho (#29527A).
SLATEEnum
Barreira (#4A716C).
TEALEnum
Azul-petróleo (#28754E).
TURQOISEEnum
Turquesa (#1B887A).
YELLOWEnum
Amarelo (#AB8B00).

EventColor

Propriedades

PropriedadeTipoDescrição
PALE_BLUEEnum
Azul-claro ("1").
PALE_GREENEnum
Verde-pálido ("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()IntegerObtém o número de pessoas adicionais que este convidado disse que vão participar.
getEmail()StringObtém o endereço de e-mail do convidado.
getGuestStatus()GuestStatusObtém o status do convidado do evento.
getName()StringObtém 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 para 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 da recorrência.

GuestStatus

Propriedades

PropriedadeTipoDescrição
INVITEDEnumO convidado foi convidado, mas não indicou se vai participar.
MAYBEEnumO convidado indicou que talvez compareça.
NOEnumO convidado indicou que não comparecerá.
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 para 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 nesse intervalo de tempo.
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 da 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 em que a semana começa, com a finalidade de aplicar a regra.

Visibility

Propriedades

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