Calendar Service

Agenda

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

Aulas

NomeBreve descrição
CalendarRepresenta uma agenda que o usuário possui ou em que 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 Agenda.
EventColorUm enum que representa as cores de eventos nomeados disponíveis no serviço Agenda.
EventGuestRepresenta um convidado de um evento.
EventRecurrenceRepresenta as configurações de recorrência de uma série de eventos.
GuestStatusUm tipo enumerado que representa os status que um convidado pode ter em 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 que pode abranger vários dias.
createAllDayEvent(title, startDate, endDate, options)CalendarEventCria um novo evento de dia inteiro que pode abranger 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()StringRecebe a cor da agenda.
getDescription()StringExtrai a descrição da agenda.
getEventById(iCalId)CalendarEventRecebe o evento com o ID fornecido.
getEventSeriesById(iCalId)CalendarEventSeriesRecebe a série de eventos com o ID fornecido.
getEvents(startTime, endTime)CalendarEvent[]Extrai todos os eventos que ocorrem em um determinado período.
getEvents(startTime, endTime, options)CalendarEvent[]Mostra todos os eventos que ocorrem em um determinado período e atende aos critérios especificados.
getEventsForDay(date)CalendarEvent[]Mostra todos os eventos que ocorrem em um determinado dia.
getEventsForDay(date, options)CalendarEvent[]Extrai todos os eventos que ocorrem em um determinado dia e atende aos critérios especificados.
getId()StringExtrai o ID da agenda.
getName()StringExtrai o nome da agenda.
getTimeZone()StringMostra 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 do usuário efetivo.
isOwnedByMe()BooleanDetermina se a agenda é sua.
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 Agenda.
EventColorEventColorUm enum que representa as cores de eventos nomeados disponíveis no serviço Agenda.
GuestStatusGuestStatusUm tipo enumerado que representa os status que um convidado pode ter em 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 que pode abranger vários dias.
createAllDayEvent(title, startDate, endDate, options)CalendarEventCria um novo evento de dia inteiro que pode abranger 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, pertencente ao usuário.
createCalendar(name, options)CalendarCria uma nova agenda, pertencente 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[]Acessa todas as agendas que o usuário possui ou em que está inscrito.
getAllOwnedCalendars()Calendar[]Acessa todas as agendas do usuário.
getCalendarById(id)CalendarExtrai a agenda com o ID fornecido.
getCalendarsByName(name)Calendar[]Acessa todas as agendas com um determinado nome que o usuário possui ou em que está inscrito.
getColor()StringRecebe a cor da agenda.
getDefaultCalendar()CalendarExtrai a agenda padrão do usuário.
getDescription()StringExtrai a descrição da agenda.
getEventById(iCalId)CalendarEventRecebe o evento com o ID fornecido.
getEventSeriesById(iCalId)CalendarEventSeriesRecebe a série de eventos com o ID fornecido.
getEvents(startTime, endTime)CalendarEvent[]Extrai todos os eventos que ocorrem em um determinado período.
getEvents(startTime, endTime, options)CalendarEvent[]Mostra todos os eventos que ocorrem em um determinado período e atende aos critérios especificados.
getEventsForDay(date)CalendarEvent[]Mostra todos os eventos que ocorrem em um determinado dia.
getEventsForDay(date, options)CalendarEvent[]Extrai todos os eventos que ocorrem em um determinado dia e atende aos critérios especificados.
getId()StringExtrai o ID da agenda.
getName()StringExtrai o nome da agenda.
getOwnedCalendarById(id)CalendarExtrai a agenda com o ID fornecido, se o usuário for proprietário dela.
getOwnedCalendarsByName(name)Calendar[]Acessa todas as agendas com um determinado nome que pertence ao usuário.
getTimeZone()StringMostra 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 do usuário efetivo.
isOwnedByMe()BooleanDetermina se a agenda é sua.
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 para a recorrência do evento.
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 ID fornecido, se ele tiver permissão para se inscrever.
subscribeToCalendar(id, options)CalendarInscreve o usuário na agenda com o ID fornecido, se ele 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 Agenda.
deleteTag(key)CalendarEventExclui uma tag de chave-valor do evento.
getAllDayEndDate()DateExtrai a data em que o evento da agenda de dia inteiro termina.
getAllDayStartDate()DateExtrai a data em que este evento da agenda de dia inteiro começa.
getAllTagKeys()String[]Recebe todas as chaves das tags que foram definidas no evento.
getColor()StringRetorna a cor do evento da agenda.
getCreators()String[]Acessa os criadores de um evento.
getDateCreated()DateExtrai a data em que o evento foi criado.
getDescription()StringRecebe a descrição do evento.
getEmailReminders()Integer[]Extrai os valores de minutos de todos os lembretes por e-mail do evento.
getEndTime()DateExtrai a data e o horário de término do evento da agenda.
getEventSeries()CalendarEventSeriesExtrai a série de eventos recorrentes à qual 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()DateExtrai a data da última atualização do evento.
getLocation()StringExtrai o local do evento.
getMyStatus()GuestStatusAcessa o status do evento (como participando ou convidado) do usuário efetivo.
getOriginalCalendarId()StringEncontre o ID da agenda em que o evento foi criado originalmente.
getPopupReminders()Integer[]Recebe os valores de minuto de todos os lembretes pop-up do evento.
getSmsReminders()Integer[]Recebe os valores de minutos de todos os lembretes por SMS do evento.
getStartTime()DateDefine a data e a hora em que o evento da agenda começa.
getTag(key)StringRecebe um valor de tag do evento.
getTitle()StringRecebe o título do evento.
getVisibility()VisibilityRecebe a visibilidade do evento.
guestsCanInviteOthers()BooleanDetermina se os convidados podem convidar outras pessoas.
guestsCanModify()BooleanDetermina se os convidados podem modificar o evento.
guestsCanSeeGuests()BooleanDetermina se os convidados podem ver outros convidados.
isAllDayEvent()BooleanDetermina se esse é um evento de dia inteiro.
isOwnedByMe()BooleanDetermina se você é o proprietário do evento.
isRecurringEvent()BooleanDetermina se o evento é parte de uma série de eventos.
removeAllReminders()CalendarEventRemove todos os lembretes do evento.
removeGuest(email)CalendarEventRemove um convidado do evento.
resetRemindersToDefault()CalendarEventPara redefinir os lembretes, use 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 sã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 os 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 participante 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 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 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[]Recebe todas as chaves das tags que foram definidas no evento.
getColor()StringRetorna a cor do evento da agenda.
getCreators()String[]Acessa os criadores de um evento.
getDateCreated()DateExtrai a data em que o evento foi criado.
getDescription()StringRecebe a descrição do evento.
getEmailReminders()Integer[]Extrai 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()DateExtrai a data da última atualização do evento.
getLocation()StringExtrai o local do evento.
getMyStatus()GuestStatusAcessa o status do evento (como participando ou convidado) do usuário efetivo.
getOriginalCalendarId()StringEncontre o ID da agenda em que o evento foi criado originalmente.
getPopupReminders()Integer[]Recebe os valores de minuto 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)StringRecebe um valor de tag do evento.
getTitle()StringRecebe o título do evento.
getVisibility()VisibilityRecebe a visibilidade do evento.
guestsCanInviteOthers()BooleanDetermina se os convidados podem convidar outras pessoas.
guestsCanModify()BooleanDetermina se os convidados podem modificar o evento.
guestsCanSeeGuests()BooleanDetermina se os convidados podem ver outros convidados.
isOwnedByMe()BooleanDetermina se você é o proprietário do evento.
removeAllReminders()CalendarEventSeriesRemove todos os lembretes do evento.
removeGuest(email)CalendarEventSeriesRemove um convidado do evento.
resetRemindersToDefault()CalendarEventSeriesPara redefinir os lembretes, use as configurações padrão da agenda.
setAnyoneCanAddSelf(anyoneCanAddSelf)CalendarEventSeriesDefine se pessoas que não sã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 os 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 participante 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 desta 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
Castanhas (#865A5A).
GRAYEnum
Cinza (#5A6986).
GREENEnum
Verde (#0D7813).
INDIGOEnum
Índigo (#5229A3).
LIMEEnum
Verde-limão (#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
Vermelho e laranja (#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-claro ("2").
MAUVEEnum
Rosa ("3").
PALE_REDEnum
Vermelho-claro ("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()IntegerExtrai o número de pessoas que este convidado disse que vão participar.
getEmail()StringExtrai 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 diárias.
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 seja recorrente anualmente.
setTimeZone(timeZone)EventRecurrenceDefine o fuso horário para a recorrência.

GuestStatus

Propriedades

PropriedadeTipoDescrição
INVITEDEnumO convidado foi convidado, mas não indicou se participará.
MAYBEEnumO convidado indicou que pode 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 diárias.
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 seja recorrente anualmente.
interval(interval)RecurrenceRuleConfigura a regra para ser aplicada somente nesse intervalo da unidade de tempo da regra.
onlyInMonth(month)RecurrenceRuleConfigura a regra para ser aplicada apenas a um mês específico.
onlyInMonths(months)RecurrenceRuleConfigura a regra para ser aplicada apenas a meses específicos.
onlyOnMonthDay(day)RecurrenceRuleConfigura a regra para ser aplicada apenas a um dia específico do mês.
onlyOnMonthDays(days)RecurrenceRuleConfigura a regra para ser aplicada apenas a dias específicos do mês.
onlyOnWeek(week)RecurrenceRuleConfigura a regra para ser aplicada apenas a uma semana específica do ano.
onlyOnWeekday(day)RecurrenceRuleConfigura a regra para ser aplicada apenas a um dia específico da semana.
onlyOnWeekdays(days)RecurrenceRuleConfigura a regra para ser aplicada apenas a dias específicos da semana.
onlyOnWeeks(weeks)RecurrenceRuleConfigura a regra para ser aplicada apenas a semanas específicas do ano.
onlyOnYearDay(day)RecurrenceRuleConfigura a regra para ser aplicada apenas a um dia específico do ano.
onlyOnYearDays(days)RecurrenceRuleConfigura a regra para ser aplicada apenas a dias específicos do ano.
setTimeZone(timeZone)EventRecurrenceDefine o fuso horário para a 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 que começa para aplicar a regra.

Visibility

Propriedades

PropriedadeTipoDescrição
CONFIDENTIALEnumO evento é privado.
DEFAULTEnumUsa a visibilidade padrão para eventos da agenda.
PRIVATEEnumO evento é particular, e somente os participantes podem ter acesso aos detalhes dele.
PUBLICEnumO evento é público, e os detalhes podem ser vistos por todos os leitores da agenda.