Class Calendar

Calendario

Representa un calendario que le pertenece al usuario o al que se suscribió.

Métodos

MétodoTipo de datos que se muestraDescripción breve
createAllDayEvent(title, date)CalendarEventCrea un evento de todo el día nuevo.
createAllDayEvent(title, startDate, endDate)CalendarEventCrea un nuevo evento de todo el día que puede abarcar varios días.
createAllDayEvent(title, startDate, endDate, options)CalendarEventCrea un nuevo evento de todo el día que puede abarcar varios días.
createAllDayEvent(title, date, options)CalendarEventCrea un evento de todo el día nuevo.
createAllDayEventSeries(title, startDate, recurrence)CalendarEventSeriesCrea una nueva serie de eventos de todo el día.
createAllDayEventSeries(title, startDate, recurrence, options)CalendarEventSeriesCrea una nueva serie de eventos de todo el día.
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.
deleteCalendar()voidBorra el calendario definitivamente.
getColor()StringObtiene el color del calendario.
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 dentro de un período determinado.
getEvents(startTime, endTime, options)CalendarEvent[]Obtiene todos los eventos que ocurren dentro de un período determinado y que 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 que cumplen con los criterios especificados.
getId()StringObtiene el ID del calendario.
getName()StringObtiene el nombre del calendario.
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 principal para el usuario efectivo.
isOwnedByMe()BooleanDetermina si el calendario te pertenece.
isSelected()BooleanDetermina si los eventos del calendario se muestran en la interfaz de usuario.
setColor(color)CalendarEstablece el color del calendario.
setDescription(description)CalendarEstablece la descripción de un calendario.
setHidden(hidden)CalendarEstablece si el calendario es visible en la interfaz de usuario.
setName(name)CalendarEstablece el nombre del calendario.
setSelected(selected)CalendarEstablece si los eventos del calendario se muestran en la interfaz de usuario.
setTimeZone(timeZone)CalendarEstablece la zona horaria del calendario.
unsubscribeFromCalendar()voidAnula la suscripción del usuario a un calendario.

Documentación detallada

createAllDayEvent(title, date)

Crea un evento de todo el día nuevo.

// Creates an all-day event for the moon landing and logs the ID.
const event = CalendarApp.getDefaultCalendar().createAllDayEvent(
    'Apollo 11 Landing',
    new Date('July 20, 1969'),
);
Logger.log(`Event ID: ${event.getId()}`);

Parámetros

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

Volver

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 ámbitos o los ámbitos 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 abarcar varios días.

// Creates an all-day event for the Woodstock festival (August 15th to 17th) and
// logs the ID.
const 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
titleStringEs el título del evento.
startDateDateEs la fecha en la que comienza el evento (solo se usa el día, se ignora la hora).
endDateDateEs la fecha en que finaliza el evento (solo se usa el día, se ignora la hora). La fecha de finalización es exclusiva.

Volver

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 ámbitos o los ámbitos 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 abarcar varios días.

// Creates an all-day event for the Woodstock festival (August 15th to 17th) and
// logs the ID.
const 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
titleStringEs el título del evento.
startDateDateEs la fecha en la que comienza el evento (solo se usa el día, se ignora la hora).
endDateDateEs la fecha en que finaliza el evento (solo se usa el día, se ignora la hora). La fecha de finalización es exclusiva.
optionsObjectUn objeto 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.
guestsStringEs una 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).

Volver

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 ámbitos o los ámbitos 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 de todo el día nuevo.

// Creates an all-day event for the moon landing and logs the ID.
const 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
titleStringEs el título del evento.
dateDateEs la fecha del evento (solo se usa el día; se ignora la hora).
optionsObjectUn objeto 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.
guestsStringEs una 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).

Volver

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 ámbitos o los ámbitos 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 de todo el día.

// Creates an event series for a no-meetings day, taking place every Wednesday
// in 2013.
const 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 de 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

Volver

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 ámbitos o los ámbitos 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 de todo el día.

// Creates an event series for a no-meetings day, taking place every Wednesday
// in 2013.
const 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 de 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 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 de 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 (predeterminado: false)

Volver

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 ámbitos o los ámbitos 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.
const 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 hora de inicio del evento
endTimeDatela fecha y hora en que finaliza el evento

Volver

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 ámbitos o los ámbitos 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.
const 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 hora de inicio del evento
endTimeDatela fecha y hora en que finaliza el evento
optionsObjectUn objeto 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 de direcciones de correo electrónico separadas por comas que se deben agregar como invitados
sendInvitesBooleansi se deben enviar correos electrónicos de invitación (predeterminado: false)

Volver

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 ámbitos o los ámbitos 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 usar el mismo formato que la función "Agregar rápidamente" de la IU.

// Creates a new event and logs its ID.
const 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

Volver

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 ámbitos o los ámbitos 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.
const 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 de la serie
startTimeDatela fecha y la 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

Volver

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 ámbitos o los ámbitos 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.
const 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 de la serie
startTimeDatela fecha y la 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 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 de 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 (predeterminado: false)

Volver

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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

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

deleteCalendar()

Borra el calendario definitivamente. Un usuario solo puede borrar un calendario que le pertenezca.

// Creates a calendar to delete.
const calendar = CalendarApp.createCalendar('Test');

// Deletes the 'Test' calendar permanently.
calendar.deleteCalendar();

Arroja

Error: Si se trata de un calendario importado.

Autorización

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

  • https://www.googleapis.com/auth/calendar
  • 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);

Volver

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

Autorización

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

Volver

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 ámbitos o los ámbitos 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 es el predeterminado, se debe llamar a este método desde ese calendario. Llamar a CalendarApp.getEventById(iCalId) solo muestra un evento en el calendario predeterminado.

Varios eventos pueden tener el mismo ID si forman parte de una serie de eventos. En este caso, este método solo muestra 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.

Volver

CalendarEvent: Es el evento con el ID determinado o 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 ámbitos o los ámbitos 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 un solo CalendarEvent, se muestra un CalendarEventSeries con un solo evento en la serie. Ten en cuenta que, si la serie de eventos pertenece a un calendario que no es el predeterminado, se debe llamar a este método desde ese Calendar. Si llamas a CalendarApp.getEventSeriesById(iCalId) directamente, solo se 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.

Volver

CalendarEventSeries: Es la serie con el ID determinado o 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 ámbitos o los ámbitos 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 dentro de un período determinado.

Este método muestra los 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 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.

// Determines how many events are happening in the next two hours.
const now = new Date();
const twoHoursFromNow = new Date(now.getTime() + 2 * 60 * 60 * 1000);
const events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow);
Logger.log(`Number of events: ${events.length}`);

Parámetros

NombreTipoDescripción
startTimeDateel inicio del intervalo de tiempo
endTimeDateel final del período, sin incluirlo

Volver

CalendarEvent[]: 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 ámbitos o los ámbitos 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 período determinado y que cumplen con los criterios especificados.

Este método muestra los 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 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.

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 inferior a max, aunque otros eventos cumplan con los criterios.

// Determines how many events are happening in the next two hours that contain
// the term "meeting".
const now = new Date();
const twoHoursFromNow = new Date(now.getTime() + 2 * 60 * 60 * 1000);
const 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
endTimeDateel final del período, sin incluirlo
optionsObjectUn objeto 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 usa para filtrar los resultados por el creador del evento
searchStringuna búsqueda de texto completo que se usa para filtrar los resultados
statusFilters[]GuestStatusUn array de estados que se usan para filtrar los resultados

Volver

CalendarEvent[]: Son los eventos que se producen dentro del período y que 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 ámbitos o los ámbitos 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 determinado, finalizan durante el día o abarcan el día.

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

// Determines how many events are happening today.
const today = new Date();
const 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)

Volver

CalendarEvent[]: Son los eventos que ocurren en la fecha determinada.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos o los ámbitos 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 que cumplen con los criterios especificados.

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

Ten en cuenta que solo se usa la parte de fecha del objeto Date y se ignora la parte de hora. La fecha se interpreta como la medianoche de ese día a 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 inferior a max, aunque otros eventos cumplan con los criterios.

// Determines how many events are happening today and contain the term
// "meeting".
const today = new Date();
const 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 de filtrado avanzadas

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 usa para filtrar los resultados por el creador del evento
searchStringuna búsqueda de texto completo que se usa para filtrar los resultados
statusFilters[]GuestStatusUn array de estados que se usan para filtrar los resultados

Volver

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 ámbitos o los ámbitos 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);

Volver

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 ámbitos o los ámbitos 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);

Volver

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 ámbitos o los ámbitos 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);

Volver

String: Es la zona horaria, especificada en formato "long" (por ejemplo, "America/New_York", como se indica en Joda.org).

Autorización

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

Volver

Boolean: 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 ámbitos o los ámbitos 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 principal para el usuario efectivo.

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

Volver

Boolean: Es true si el calendario es el predeterminado del usuario efectivo; 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 ámbitos o los ámbitos 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 el calendario te pertenece.

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

Volver

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 ámbitos o los ámbitos 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());

Volver

Boolean: true si los eventos del calendario se muestran en la interfaz de usuario; false si no es así

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos o los ámbitos 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
colorStringUn CalendarApp.Color o una cadena de color hexadecimal ("#rrggbb").

Volver

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 ámbitos o los ámbitos 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

Volver

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 ámbitos o los ámbitos 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 es visible en la interfaz de usuario.

Parámetros

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

Volver

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 ámbitos o los ámbitos 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

Volver

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 ámbitos o los ámbitos 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 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();

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

Volver

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 ámbitos o los ámbitos 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 "long" (como "America/New_York", como se indica en Joda.org)

Volver

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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

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

unsubscribeFromCalendar()

Anula la suscripción del usuario a un calendario. Los usuarios no pueden anular la suscripción a los calendarios que aparecen en la lista Mis calendarios. Pueden anular la suscripción a los calendarios que aparecen en Otros calendarios.

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

// Unsubscribes the user from the calendar.
const result = calendar.unsubscribeFromCalendar();

Arroja

Error: Si es un calendario propio

Autorización

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

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