Class CalendarApp

CalendarApp

Permite que una secuencia de comandos lea y actualice el Calendario de Google del usuario. Esta clase proporciona acceso directo al calendario predeterminado del usuario, así como la capacidad de recuperar calendarios adicionales de su propiedad o a los que está suscrito.

Propiedades

PropiedadTipoDescripción
ColorColorUna enumeración que representa los colores con nombre disponibles en el servicio de Calendario.
EventColorEventColorUna enumeración que representa los colores de los eventos con nombre disponibles en el servicio de Calendario.
GuestStatusGuestStatusUna enumeración que representa los estados que puede tener un invitado para un evento
MonthMonthUna enumeración que representa los meses del año
VisibilityVisibilityUna enumeración que representa la visibilidad de un evento
WeekdayWeekdayUna enumeración que representa los días de la semana.

Métodos

MétodoTipo de datos que se muestraDescripción breve
createAllDayEvent(title, date)CalendarEventCrea un evento nuevo que dura todo el día.
createAllDayEvent(title, startDate, endDate)CalendarEventCrea un nuevo evento de todo el día que puede durar varios días.
createAllDayEvent(title, startDate, endDate, options)CalendarEventCrea un nuevo evento de todo el día que puede durar varios días.
createAllDayEvent(title, date, options)CalendarEventCrea un evento nuevo que dura todo el día.
createAllDayEventSeries(title, startDate, recurrence)CalendarEventSeriesCrea una nueva serie de eventos que dura todo el día.
createAllDayEventSeries(title, startDate, recurrence, options)CalendarEventSeriesCrea una nueva serie de eventos que dura todo el día.
createCalendar(name)CalendarCrea un calendario nuevo que es propiedad del usuario.
createCalendar(name, options)CalendarCrea un calendario nuevo que es propiedad del usuario.
createEvent(title, startTime, endTime)CalendarEventCrea un evento nuevo.
createEvent(title, startTime, endTime, options)CalendarEventCrea un evento nuevo.
createEventFromDescription(description)CalendarEventCrea un evento a partir de una descripción de formato libre.
createEventSeries(title, startTime, endTime, recurrence)CalendarEventSeriesCrea una nueva serie de eventos.
createEventSeries(title, startTime, endTime, recurrence, options)CalendarEventSeriesCrea una nueva serie de eventos.
getAllCalendars()Calendar[]Obtiene todos los calendarios que pertenecen al usuario o a los que está suscrito.
getAllOwnedCalendars()Calendar[]Obtiene todos los calendarios que pertenecen al usuario.
getCalendarById(id)CalendarObtiene el calendario con el ID determinado.
getCalendarsByName(name)Calendar[]Obtiene todos los calendarios con un nombre determinado que pertenecen al usuario o a los que se suscribió.
getColor()StringObtiene el color del calendario.
getDefaultCalendar()CalendarObtiene el calendario predeterminado del usuario.
getDescription()StringObtiene la descripción del calendario.
getEventById(iCalId)CalendarEventObtiene el evento con el ID determinado.
getEventSeriesById(iCalId)CalendarEventSeriesObtiene la serie de eventos con el ID determinado.
getEvents(startTime, endTime)CalendarEvent[]Obtiene todos los eventos que ocurren en un período determinado.
getEvents(startTime, endTime, options)CalendarEvent[]Obtiene todos los eventos que ocurren dentro de un intervalo de tiempo determinado y cumplen con los criterios especificados.
getEventsForDay(date)CalendarEvent[]Obtiene todos los eventos que ocurren en un día determinado.
getEventsForDay(date, options)CalendarEvent[]Obtiene todos los eventos que ocurren en un día determinado y cumplen con los criterios especificados.
getId()StringObtiene el ID del calendario.
getName()StringObtiene el nombre del calendario.
getOwnedCalendarById(id)CalendarObtiene el calendario con el ID especificado, si es el usuario propietario.
getOwnedCalendarsByName(name)Calendar[]Obtiene todos los calendarios con un nombre determinado que pertenecen al usuario.
getTimeZone()StringObtiene la zona horaria del calendario.
isHidden()BooleanDetermina si el calendario está oculto en la interfaz de usuario.
isMyPrimaryCalendar()BooleanDetermina si el calendario es el calendario principal para el usuario real.
isOwnedByMe()BooleanDetermina si eres el propietario del calendario.
isSelected()BooleanDetermina si los eventos del calendario se muestran en la interfaz de usuario.
newRecurrence()EventRecurrenceCrea un objeto de recurrencia nuevo, que se puede usar para crear reglas de recurrencia del evento.
setColor(color)CalendarEstablece el color del calendario.
setDescription(description)CalendarEstablece la descripción de un calendario.
setHidden(hidden)CalendarEstablece si el calendario estará visible en la interfaz de usuario.
setName(name)CalendarEstablece el nombre del calendario.
setSelected(selected)CalendarEstablece si los eventos del calendario deben mostrarse en la interfaz de usuario.
setTimeZone(timeZone)CalendarEstablece la zona horaria del calendario.
subscribeToCalendar(id)CalendarSuscribe al usuario al calendario con el ID especificado si tiene permiso para suscribirse.
subscribeToCalendar(id, options)CalendarSuscribe al usuario al calendario con el ID especificado si tiene permiso para suscribirse.

Documentación detallada

createAllDayEvent(title, date)

Crea un evento nuevo que dura todo el día.

// 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

NombreTipoDescripción
titleStringTítulo del evento.
dateDateLa fecha del evento (solo se usa el día; se ignora la hora).

Devolvedor

CalendarEvent: Es el evento creado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createAllDayEvent(title, startDate, endDate)

Crea un nuevo evento de todo el día que puede durar varios días.

// 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

NombreTipoDescripción
titleStringTítulo del evento.
startDateDateLa fecha en la que comienza el evento (solo se usa el día; se ignora la hora).
endDateDateLa fecha en la que finaliza el evento (solo se usa el día; se ignora la hora). La fecha de finalización es exclusiva.

Devolvedor

CalendarEvent: Es el evento creado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createAllDayEvent(title, startDate, endDate, options)

Crea un nuevo evento de todo el día que puede durar varios días.

// 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

NombreTipoDescripción
titleStringTítulo del evento.
startDateDateLa fecha en la que comienza el evento (solo se usa el día; se ignora la hora).
endDateDateLa fecha en la que finaliza el evento (solo se usa el día; se ignora la hora). La fecha de finalización es exclusiva.
optionsObjectUn objeto de JavaScript que especifica parámetros avanzados, como se indica a continuación.

Parámetros avanzados

NombreTipoDescripción
descriptionStringLa descripción del evento.
locationStringCorresponde a la ubicación del evento.
guestsStringUna lista separada por comas de direcciones de correo electrónico que se deben agregar como invitados.
sendInvitesBooleanIndica si se deben enviar correos electrónicos de invitación (valor predeterminado: false).

Devolvedor

CalendarEvent: Es el evento creado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createAllDayEvent(title, date, options)

Crea un evento nuevo que dura todo el día.

// 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

NombreTipoDescripción
titleStringTítulo del evento.
dateDateLa fecha del evento (solo se usa el día; se ignora la hora).
optionsObjectUn objeto de JavaScript que especifica parámetros avanzados, como se indica a continuación.

Parámetros avanzados

NombreTipoDescripción
descriptionStringLa descripción del evento.
locationStringCorresponde a la ubicación del evento.
guestsStringUna lista separada por comas de direcciones de correo electrónico que se deben agregar como invitados.
sendInvitesBooleanIndica si se deben enviar correos electrónicos de invitación (valor predeterminado: false).

Devolvedor

CalendarEvent: Es el evento creado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createAllDayEventSeries(title, startDate, recurrence)

Crea una nueva serie de eventos que dura todo el día.

// 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

NombreTipoDescripción
titleStringel título de los eventos en la serie
startDateDatela fecha del primer evento de la serie (solo se usa el día; se ignora la hora)
recurrenceEventRecurrencela configuración de recurrencia de la serie de eventos

Devolvedor

CalendarEventSeries: Es la serie de eventos creada.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createAllDayEventSeries(title, startDate, recurrence, options)

Crea una nueva serie de eventos que dura todo el día.

// 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

NombreTipoDescripción
titleStringel título de los eventos en la serie
startDateDatela fecha del primer evento de la serie (solo se usa el día; se ignora la hora)
recurrenceEventRecurrencela configuración de recurrencia de la serie de eventos
optionsObjectun objeto de JavaScript que especifica parámetros avanzados, como se indica a continuación

Parámetros avanzados

NombreTipoDescripción
descriptionStringla descripción de los eventos de la serie
locationStringla ubicación de los eventos en la serie
guestsStringuna lista separada por comas de direcciones de correo electrónico que se deben agregar como invitados a los eventos de la serie
sendInvitesBooleansi se deben enviar correos electrónicos de invitación (valor predeterminado: false)

Devolvedor

CalendarEventSeries: Es la serie de eventos creada.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createCalendar(name)

Crea un calendario nuevo que es propiedad del usuario.

// 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

NombreTipoDescripción
nameStringel nombre del calendario nuevo

Devolvedor

Calendar: Es el calendario recién creado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createCalendar(name, options)

Crea un calendario nuevo que es propiedad del usuario.

// 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

NombreTipoDescripción
nameStringel nombre del calendario nuevo
optionsObjectun objeto de JavaScript que especifica parámetros avanzados, como se indica a continuación

Parámetros avanzados

NombreTipoDescripción
locationStringla ubicación del calendario
summaryStringla descripción del calendario
timeZoneStringLa zona horaria en la que se configurará el calendario, especificada en formato "largo" (p.ej., "America/New_York", en la lista de Joda.org)
colorStringuna string de color hexadecimal ("#rrggbb") o un valor de CalendarApp.Colors
hiddenBooleanSi el calendario está oculto en la interfaz de usuario (configuración predeterminada: false)
selectedBooleanSi los eventos del calendario se muestran en la interfaz de usuario (configuración predeterminada: true)

Devolvedor

Calendar: Es el calendario recién creado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createEvent(title, startTime, endTime)

Crea un evento nuevo.

Si no se especifica una zona horaria, los valores de hora se interpretan en el contexto de la zona horaria de la secuencia de comandos, que puede ser diferente de la zona horaria del calendario.

// 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

NombreTipoDescripción
titleStringel título del evento
startTimeDatela fecha y la hora de inicio del evento
endTimeDatela fecha y la hora en que finaliza el evento

Devolvedor

CalendarEvent: Es el evento creado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createEvent(title, startTime, endTime, options)

Crea un evento nuevo.

Si no se especifica una zona horaria, los valores de hora se interpretan en el contexto de la zona horaria de la secuencia de comandos, que puede ser diferente de la zona horaria del calendario.

// 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

NombreTipoDescripción
titleStringel título del evento
startTimeDatela fecha y la hora de inicio del evento
endTimeDatela fecha y la hora en que finaliza el evento
optionsObjectun objeto de JavaScript que especifica parámetros avanzados, como se indica a continuación

Parámetros avanzados

NombreTipoDescripción
descriptionStringla descripción del evento
locationStringla ubicación del evento
guestsStringuna lista separada por comas de direcciones de correo electrónico que se deben agregar como invitados
sendInvitesBooleansi se deben enviar correos electrónicos de invitación (valor predeterminado: false)

Devolvedor

CalendarEvent: Es el evento creado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createEventFromDescription(description)

Crea un evento a partir de una descripción de formato libre.

La descripción debe tener el mismo formato que la función "Creación rápida" de la 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

NombreTipoDescripción
descriptionStringuna descripción de formato libre del evento

Devolvedor

CalendarEvent: Es el evento creado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createEventSeries(title, startTime, endTime, recurrence)

Crea una nueva serie 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

NombreTipoDescripción
titleStringel título de los eventos en la serie
startTimeDatela fecha y hora en que comienza el primer evento de la serie
endTimeDateLa fecha y hora en que finaliza el primer evento de la serie
recurrenceEventRecurrencela configuración de recurrencia de la serie de eventos

Devolvedor

CalendarEventSeries: Es la serie de eventos creada.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createEventSeries(title, startTime, endTime, recurrence, options)

Crea una nueva serie 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

NombreTipoDescripción
titleStringel título de los eventos en la serie
startTimeDatela fecha y hora en que comienza el primer evento de la serie
endTimeDateLa fecha y hora en que finaliza el primer evento de la serie
recurrenceEventRecurrencela configuración de recurrencia de la serie de eventos
optionsObjectun objeto de JavaScript que especifica parámetros avanzados, como se indica a continuación

Parámetros avanzados

NombreTipoDescripción
descriptionStringla descripción de los eventos de la serie
locationStringla ubicación de los eventos en la serie
guestsStringuna lista separada por comas de direcciones de correo electrónico que se deben agregar como invitados a los eventos de la serie
sendInvitesBooleansi se deben enviar correos electrónicos de invitación (valor predeterminado: false)

Devolvedor

CalendarEventSeries: Es la serie de eventos creada.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

getAllCalendars()

Obtiene todos los calendarios que pertenecen al usuario o a los que está suscrito.

// 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);

Devolvedor

Calendar[]: Todos los calendarios a los que puede acceder el usuario

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getAllOwnedCalendars()

Obtiene todos los calendarios que pertenecen al usuario.

// Determines how many calendars the user owns.
var calendars = CalendarApp.getAllOwnedCalendars();
Logger.log('This user owns %s calendars.', calendars.length);

Devolvedor

Calendar[]: Todos los calendarios que pertenecen al usuario

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getCalendarById(id)

Obtiene el calendario con el ID determinado.

// 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

NombreTipoDescripción
idStringel ID del calendario

Devolvedor

Calendar: Es el calendario con el ID determinado, o bien null si el calendario no existe, si el usuario no puede acceder a él o si no está suscrito al calendario.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getCalendarsByName(name)

Obtiene todos los calendarios con un nombre determinado que pertenecen al usuario o a los que se suscribió. Los nombres no distinguen mayú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

NombreTipoDescripción
nameStringel nombre del calendario

Devolvedor

Calendar[]: Son todos los calendarios con este nombre a los que puede acceder el usuario.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getColor()

Obtiene el color del calendario.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Gets the color of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getColor() instead.
const calendarColor = calendar.getColor();
console.log(calendarColor);

Devolvedor

String: Es una string hexadecimal de color ("#rrggbb").

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getDefaultCalendar()

Obtiene el calendario predeterminado del usuario.

// 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());

Devolvedor

Calendar: Es el calendario predeterminado del usuario.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getDescription()

Obtiene la descripción del calendario.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Sets the description of the calendar to 'Test description.'
calendar.setDescription('Test description');

// Gets the description of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getDescription() instead.
const description = calendar.getDescription();
console.log(description);

Devolvedor

String: Es la descripción de este calendario.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEventById(iCalId)

Obtiene el evento con el ID determinado. Si la serie pertenece a un calendario que no sea el predeterminado, se debe llamar a este método desde ese calendario. Si llamas a getEventById(iCalId), solo se muestra un evento en el calendario predeterminado.

Es posible que varios eventos tengan el mismo ID si forman parte de una serie de eventos. En este caso, este método muestra solo el primer evento de esa serie.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com')

// Creates an event for the moon landing.
const event = calendar.createEvent('Apollo 11 Landing',
  new Date('July 20, 1969 20:05:00 UTC'),
  new Date('July 20, 1969 20:17:00 UTC'));

// Gets the calendar event ID and logs it to the console.
const iCalId = event.getId();
console.log(iCalId);

// Gets the event by its ID and logs the title of the event to the console.
// For the default calendar, you can use CalendarApp.getEventById(iCalId) instead.
const myEvent = calendar.getEventById(iCalId);
console.log(myEvent.getTitle());

Parámetros

NombreTipoDescripción
iCalIdStringEs el ID del evento.

Devolvedor

CalendarEvent: Es el evento con el ID determinado, o bien null si el evento no existe o el usuario no puede acceder a él.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEventSeriesById(iCalId)

Obtiene la serie de eventos con el ID determinado. Si el ID proporcionado es para una sola CalendarEvent, se muestra un CalendarEventSeries con un solo evento de la serie. Ten en cuenta que, si la serie de eventos pertenece a un calendario que no sea el predeterminado, se debe llamar a este método desde ese CalendarApp. Llamar directamente a getEventSeriesById(iCalId) solo muestra una serie de eventos que existe en el calendario predeterminado.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Creates an event series for a daily team meeting from 1 PM to 2 PM.
// The series adds the daily event from January 1, 2023 through December 31, 2023.
const eventSeries = calendar.createEventSeries('Team meeting',
  new Date('Jan 1, 2023 13:00:00'),
  new Date('Jan 1, 2023 14:00:00'),
  CalendarApp.newRecurrence().addDailyRule().until(new Date('Jan 1, 2024')));

// Gets the ID of the event series.
const iCalId = eventSeries.getId();

// Gets the event series by its ID and logs the series title to the console.
// For the default calendar, you can use CalendarApp.getEventSeriesById(iCalId) instead.
console.log(calendar.getEventSeriesById(iCalId).getTitle());

Parámetros

NombreTipoDescripción
iCalIdStringEs el ID de la serie de eventos.

Devolvedor

CalendarEventSeries: Es la serie con el ID determinado, o bien null si la serie no existe o el usuario no puede acceder a ella.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEvents(startTime, endTime)

Obtiene todos los eventos que ocurren en un período determinado.

Este método muestra eventos que comienzan durante el intervalo de tiempo determinado, finalizan durante el intervalo de tiempo o abarcan el intervalo de tiempo. Si no se especifica una zona horaria, los valores horarias se interpretan en el contexto de la zona horaria de la secuencia de comandos, que puede ser diferente de la zona horaria del calendario.

// 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

NombreTipoDescripción
startTimeDateel inicio del intervalo de tiempo
endTimeDateal final del intervalo de tiempo, no inclusivos

Devolvedor

CalendarEvent[]: Son los eventos que ocurren dentro del intervalo de tiempo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de 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)

Obtiene todos los eventos que ocurren dentro de un intervalo de tiempo determinado y cumplen con los criterios especificados.

Este método muestra eventos que comienzan durante el intervalo de tiempo determinado, finalizan durante el intervalo de tiempo o abarcan el intervalo de tiempo. Si no se especifica una zona horaria, los valores horarias se interpretan en el contexto de la zona horaria de la secuencia de comandos, que puede ser diferente de la zona horaria del calendario.

Ten en cuenta que el filtrado en author, search o statusFilters se realiza después de aplicar start y max. Esto significa que la cantidad de eventos que se muestran puede ser menor que max, a pesar de que los eventos adicionales cumplan con los criterios.

// 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

NombreTipoDescripción
startTimeDateel inicio del intervalo de tiempo
endTimeDateal final del intervalo de tiempo, no inclusivos
optionsObjectun objeto de JavaScript que especifica parámetros avanzados, como se indica a continuación

Parámetros avanzados

NombreTipoDescripción
startIntegerel índice del primer evento que se mostrará
maxIntegerla cantidad máxima de eventos que se mostrarán
authorStringuna dirección de correo electrónico que se utiliza para filtrar los resultados según el creador del evento
searchStringuna búsqueda de texto completo que se usa para filtrar resultados
statusFilters[]GuestStatusun array de estados que se usan para filtrar los resultados

Devolvedor

CalendarEvent[]: Son los eventos que ocurren dentro del intervalo de tiempo y coinciden con los criterios.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEventsForDay(date)

Obtiene todos los eventos que ocurren en un día determinado.

Este método muestra eventos si comienzan durante el día específico, finalizan durante el día o abarcan el día.

Ten en cuenta que solo se usa la parte de la fecha del objeto Date y que se ignora la parte de la hora. La fecha se interpreta como la medianoche de ese día hasta la medianoche del día siguiente en la zona horaria del calendario.

// 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

NombreTipoDescripción
dateDatela fecha para la que se recuperarán los eventos (solo se usa el día; se ignora la hora)

Devolvedor

CalendarEvent[]: Son los eventos que tienen lugar en la fecha especificada.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEventsForDay(date, options)

Obtiene todos los eventos que ocurren en un día determinado y cumplen con los criterios especificados.

Este método muestra eventos si comienzan durante el día específico, finalizan durante el día o abarcan el día.

Ten en cuenta que solo se usa la parte de la fecha del objeto Date y que se ignora la parte de la hora. La fecha se interpreta como la medianoche de ese día hasta la medianoche del día siguiente en la zona horaria del calendario.

Ten en cuenta que el filtrado en author, search o statusFilters se realiza después de aplicar start y max. Esto significa que la cantidad de eventos que se muestran puede ser menor que max, a pesar de que los eventos adicionales cumplan con los criterios.

// 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

NombreTipoDescripción
dateDatela fecha para la que se recuperarán los eventos (solo se usa el día; se ignora la hora)
optionsObjectopciones avanzadas de filtrado

Parámetros avanzados

NombreTipoDescripción
startIntegerel índice del primer evento que se mostrará
maxIntegerla cantidad máxima de eventos que se mostrarán
authorStringuna dirección de correo electrónico que se utiliza para filtrar los resultados según el creador del evento
searchStringuna búsqueda de texto completo que se usa para filtrar resultados
statusFilters[]GuestStatusun array de estados que se usan para filtrar los resultados

Devolvedor

CalendarEvent[]: Son los eventos que ocurren en la fecha determinada y coinciden con los criterios.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getId()

Obtiene el ID del calendario. El ID del calendario predeterminado de un usuario es su dirección de correo electrónico.

// Opens the calendar by its ID.
// To get the user's default calendar, use CalendarApp.getDefaultCalendar().
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Gets the ID of the calendar and logs it to the console.
const calendarId = calendar.getId();
console.log(calendarId);

Devolvedor

String: Es el ID del calendario.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getName()

Obtiene el nombre del calendario.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Gets the name of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getName() instead.
const calendarName = calendar.getName();
console.log(calendarName);

Devolvedor

String: Es el nombre de este calendario.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getOwnedCalendarById(id)

Obtiene el calendario con el ID especificado, si es el usuario propietario.

Para buscar un ID del calendario, haz clic en la flecha junto al nombre del calendario en el Calendario de Google y selecciona Configuración del calendario. El ID se muestra cerca de la parte inferior de la página de configuración.

// 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

NombreTipoDescripción
idStringel ID del calendario

Devolvedor

Calendar: Es el calendario con el ID proporcionado, o bien null si el calendario no existe o si el usuario no es propietario.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getOwnedCalendarsByName(name)

Obtiene todos los calendarios con un nombre determinado que pertenecen al usuario. Los nombres no distinguen mayú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

NombreTipoDescripción
nameStringel nombre del calendario

Devolvedor

Calendar[]: Todos los calendarios con este nombre que pertenecen al usuario

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getTimeZone()

Obtiene la zona horaria del calendario.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Gets the time zone of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getTimeZone() instead.
const timeZone = calendar.getTimeZone();
console.log(timeZone);

Devolvedor

String: Es la zona horaria, especificada en formato "largo" (por ejemplo, "America/New_York", según la lista de Joda.org).

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

isHidden()

Determina si el calendario está oculto en la interfaz de usuario.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Determines whether the calendar is hidden in the user interface and logs it to the console.
// For the default calendar, you can use CalendarApp.isHidden() instead.
const isHidden = calendar.isHidden();
console.log(isHidden);

Devolvedor

Boolean: Es true si el calendario está oculto en la interfaz de usuario; false si no lo está.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

isMyPrimaryCalendar()

Determina si el calendario es el calendario principal para el usuario real.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Determines whether the calendar is the default calendar for
// the effective user and logs it to the console.
// For the default calendar, you can use CalendarApp.isMyPrimaryCalendar() instead.
const isMyPrimaryCalendar = calendar.isMyPrimaryCalendar();
console.log(isMyPrimaryCalendar);

Devolvedor

Boolean: Es true si el calendario es el predeterminado para el usuario; false si no lo es.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

isOwnedByMe()

Determina si eres el propietario del calendario.

// Gets a calendar by its ID. To get the user's default calendar, use
// CalendarApp.getDefault() instead.
// TODO(developer): Replace the ID with the calendar ID that you want to use.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Determines whether the calendar is owned by you and logs it.
console.log(calendar.isOwnedByMe());

Devolvedor

Boolean: true si el calendario es tuyo; false si no lo es.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

isSelected()

Determina si los eventos del calendario se muestran en la interfaz de usuario.

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Determines whether the calendar's events are displayed in the user interface and logs it.
console.log(calendar.isSelected());

Devolvedor

Boolean: Es true si los eventos del calendario se muestran en la interfaz de usuario; false si no lo hace.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

newRecurrence()

Crea un objeto de recurrencia nuevo, que se puede usar para crear reglas de recurrencia del 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());

Devolvedor

EventRecurrence: Es un objeto de recurrencia nuevo sin reglas establecidas (se comporta como una recurrencia semanal).

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

setColor(color)

Establece el color del calendario.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Sets the color of the calendar to pink using the Calendar Color enum.
// For the default calendar, you can use CalendarApp.setColor() instead.
calendar.setColor(CalendarApp.Color.PINK);

Parámetros

NombreTipoDescripción
colorStringEs una CalendarApp.Color o una string de color hexadecimal ("#rrggbb").

Devolvedor

Calendar: Es este calendario para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setDescription(description)

Establece la descripción de un calendario.

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Sets the description of the calendar.
// TODO(developer): Update the string with the description that you want to use.
calendar.setDescription('Updated calendar description.')

Parámetros

NombreTipoDescripción
descriptionStringla descripción de este calendario

Devolvedor

Calendar: Este calendario para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setHidden(hidden)

Establece si el calendario estará visible en la interfaz de usuario.

Parámetros

NombreTipoDescripción
hiddenBooleantrue para ocultar el calendario en la interfaz de usuario; false para mostrarlo.

Devolvedor

Calendar: Este calendario para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setName(name)

Establece el nombre del calendario.

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Sets the name of the calendar.
// TODO(developer): Update the string with the name that you want to use.
calendar.setName('Example calendar name');

Parámetros

NombreTipoDescripción
nameStringel nombre nuevo

Devolvedor

Calendar: Este calendario para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setSelected(selected)

Establece si los eventos del calendario deben mostrarse en la interfaz de usuario.

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Selects the calendar so that its events are displayed in the user interface. To
// unselect the calendar, set the parameter to false.
calendar.setSelected(true);

Parámetros

NombreTipoDescripción
selectedBooleantrue para mostrar los eventos del calendario en la interfaz de usuario; false para ocultarlos

Devolvedor

Calendar: Este calendario para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setTimeZone(timeZone)

Establece la zona horaria del calendario.

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Sets the time zone of the calendar to America/New York (US/Eastern) time.
calendar.setTimeZone('America/New_York');

Parámetros

NombreTipoDescripción
timeZoneStringLa zona horaria, especificada en formato "largo" (por ejemplo, "America/New_York", como se indica en Joda.org).

Devolvedor

Calendar: Es este calendario para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

subscribeToCalendar(id)

Suscribe al usuario al calendario con el ID especificado si tiene permiso para suscribirse.

// 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

NombreTipoDescripción
idStringel ID del calendario al cual suscribirse

Devolvedor

Calendar: Es la suscripción al calendario recientemente.

Arroja

Error: Si no existe ningún calendario con este ID.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

subscribeToCalendar(id, options)

Suscribe al usuario al calendario con el ID especificado si tiene permiso para suscribirse.

// 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

NombreTipoDescripción
idStringel ID del calendario al cual suscribirse
optionsObjectun objeto de JavaScript que especifica parámetros avanzados, como se indica a continuación

Parámetros avanzados

NombreTipoDescripción
colorStringuna string de color hexadecimal ("#rrggbb") o un valor de CalendarApp.Colors
hiddenBooleanSi el calendario está oculto en la interfaz de usuario (configuración predeterminada: false)
selectedBooleanSi los eventos del calendario se muestran en la interfaz de usuario (configuración predeterminada: true)

Devolvedor

Calendar: Es el calendario de la nueva suscripción.

Arroja

Error: Si no existe ningún calendario con este ID.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds