Class CalendarApp

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.
AgendaApp

Permet à un script de lire et de mettre à jour l'agenda Google de l'utilisateur. Ce cours fournit un accès direct à l'agenda par défaut de l'utilisateur et permet de récupérer d'autres agendas appartenant à l'utilisateur ou auxquels il est abonné.

Propriétés

PropriétéTypeDescription
ColorColorÉnumération représentant les couleurs nommées disponibles dans le service Agenda.
EventColorEventColorÉnumération représentant les couleurs d'événement nommées disponibles dans le service Agenda.
GuestStatusGuestStatusÉnumération représentant les états qu'un invité peut avoir pour un événement.
MonthMonthÉnumération représentant les mois de l'année.
VisibilityVisibilityÉnumération représentant la visibilité d'un événement.
WeekdayWeekdayÉnumération représentant les jours de la semaine.

Méthodes

MéthodeType renvoyéBrève description
createAllDayEvent(title, date)CalendarEventCrée un événement d'une journée entière.
createAllDayEvent(title, startDate, endDate)CalendarEventCrée un événement d'une journée entière.
createAllDayEvent(title, startDate, endDate, options)CalendarEventCrée un événement d'une journée entière.
createAllDayEvent(title, date, options)CalendarEventCrée un événement d'une journée entière.
createAllDayEventSeries(title, startDate, recurrence)CalendarEventSeriesCrée une série d'événements qui dure toute la journée.
createAllDayEventSeries(title, startDate, recurrence, options)CalendarEventSeriesCrée une série d'événements qui dure toute la journée.
createCalendar(name)CalendarCrée un agenda, qui appartient à l'utilisateur.
createCalendar(name, options)CalendarCrée un agenda, qui appartient à l'utilisateur.
createEvent(title, startTime, endTime)CalendarEventCrée un événement.
createEvent(title, startTime, endTime, options)CalendarEventCrée un événement.
createEventFromDescription(description)CalendarEventCrée un événement à partir d'une description au format libre.
createEventSeries(title, startTime, endTime, recurrence)CalendarEventSeriesCrée une série d'événements.
createEventSeries(title, startTime, endTime, recurrence, options)CalendarEventSeriesCrée une série d'événements.
getAllCalendars()Calendar[]Récupère tous les agendas de l'utilisateur ou auxquels il est abonné.
getAllOwnedCalendars()Calendar[]Récupère tous les agendas de l'utilisateur.
getCalendarById(id)CalendarRécupère l'agenda associé à l'ID indiqué.
getCalendarsByName(name)Calendar[]Récupère tous les agendas dont l'utilisateur est propriétaire ou auquel il est abonné.
getColor()StringRécupère la couleur de l'agenda.
getDefaultCalendar()CalendarRécupère l'agenda par défaut de l'utilisateur.
getDescription()StringRécupère la description de l'agenda.
getEventById(iCalId)CalendarEventRécupère l'événement associé à l'ID indiqué.
getEventSeriesById(iCalId)CalendarEventSeriesRécupère la série d'événements avec l'ID donné.
getEvents(startTime, endTime)CalendarEvent[]Récupère tous les événements qui se produisent au cours d'une période donnée.
getEvents(startTime, endTime, options)CalendarEvent[]Récupère tous les événements qui se produisent au cours d'une période donnée et qui répondent aux critères spécifiés.
getEventsForDay(date)CalendarEvent[]Récupère tous les événements qui se produisent un jour donné.
getEventsForDay(date, options)CalendarEvent[]Récupère tous les événements qui se produisent un jour donné et qui répondent aux critères spécifiés.
getId()StringRécupère l'identifiant de l'agenda.
getName()StringRécupère le nom de l'agenda.
getOwnedCalendarById(id)CalendarRécupère l'agenda associé à l'ID indiqué, si l'utilisateur en est le propriétaire.
getOwnedCalendarsByName(name)Calendar[]Récupère tous les agendas dont le nom correspond à celui de l'utilisateur.
getTimeZone()StringRécupère le fuseau horaire de l'agenda.
isHidden()BooleanDétermine si l'agenda est masqué dans l'interface utilisateur.
isMyPrimaryCalendar()BooleanDétermine si l'agenda est l'agenda par défaut de l'utilisateur effectif.
isOwnedByMe()BooleanDétermine si l'agenda appartient à l'utilisateur effectif.
isSelected()BooleanDétermine si les événements d'agenda sont affichés dans l'interface utilisateur.
newRecurrence()EventRecurrenceCrée un objet de récurrence, qui peut être utilisé pour créer des règles de récurrence d'événement.
setColor(color)CalendarDéfinit la couleur de l'agenda.
setDescription(description)CalendarDéfinit la description de l'agenda.
setHidden(hidden)CalendarCe paramètre détermine si l'agenda est visible dans l'interface utilisateur.
setName(name)CalendarDéfinit le nom de l'agenda.
setSelected(selected)CalendarDétermine si les événements d'agenda sont affichés dans l'interface utilisateur.
setTimeZone(timeZone)CalendarDéfinit le fuseau horaire de l'agenda.
subscribeToCalendar(id)CalendarAbonne l'utilisateur à l'agenda associé à l'ID indiqué, s'il est autorisé à s'abonner.
subscribeToCalendar(id, options)CalendarAbonne l'utilisateur à l'agenda associé à l'ID indiqué, s'il est autorisé à s'abonner.

Documentation détaillée

createAllDayEvent(title, date)

Crée un événement d'une journée entière.

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

Paramètres

NomTypeDescription
titleStringle titre de l'événement ;
dateDatela date de l'événement (seule la journée est utilisée ; l'heure est ignorée) ;

Aller-retour

CalendarEvent : événement créé

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

createAllDayEvent(title, startDate, endDate)

Crée un événement d'une journée entière.

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

Paramètres

NomTypeDescription
titleStringle titre de l'événement ;
startDateDateDate de début de l'événement (seul le jour est utilisé ; l'heure est ignorée).
endDateDatedate de fin de l'événement (seule la journée est utilisée ; l'heure est ignorée).

Aller-retour

CalendarEvent : événement créé

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

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

createAllDayEvent(title, startDate, endDate, options)

Crée un événement d'une journée entière.

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

Paramètres

NomTypeDescription
titleStringle titre de l'événement ;
startDateDateDate de début de l'événement (seul le jour est utilisé ; l'heure est ignorée).
endDateDatedate de fin de l'événement (seule la journée est utilisée ; l'heure est ignorée).
optionsObjectUn objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous

Paramètres avancés

NomTypeDescription
descriptionStringDescription de l'événement
locationStringle lieu de l'événement ;
guestsStringListe des adresses e-mail devant être ajoutées en tant qu'invités, séparées par une virgule
sendInvitesBooleanenvoi des e-mails d'invitation (par défaut: false)

Aller-retour

CalendarEvent : événement créé

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

createAllDayEvent(title, date, options)

Crée un événement d'une journée entière.

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

Paramètres

NomTypeDescription
titleStringle titre de l'événement ;
dateDatela date de l'événement (seule la journée est utilisée ; l'heure est ignorée) ;
optionsObjectUn objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous

Paramètres avancés

NomTypeDescription
descriptionStringDescription de l'événement
locationStringle lieu de l'événement ;
guestsStringListe des adresses e-mail devant être ajoutées en tant qu'invités, séparées par une virgule
sendInvitesBooleanenvoi des e-mails d'invitation (par défaut: false)

Aller-retour

CalendarEvent : événement créé

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

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

createAllDayEventSeries(title, startDate, recurrence)

Crée une série d'événements qui dure toute la journée.

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

Paramètres

NomTypeDescription
titleStringTitre des événements de la série
startDateDateDate du premier événement de la série (seule la journée est utilisée ; l'heure est ignorée)
recurrenceEventRecurrenceles paramètres de récurrence de la série d'événements.

Aller-retour

CalendarEventSeries : série d'événements créée

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

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

createAllDayEventSeries(title, startDate, recurrence, options)

Crée une série d'événements qui dure toute la journée.

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

Paramètres

NomTypeDescription
titleStringTitre des événements de la série
startDateDateDate du premier événement de la série (seule la journée est utilisée ; l'heure est ignorée)
recurrenceEventRecurrenceles paramètres de récurrence de la série d'événements.
optionsObjectUn objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous

Paramètres avancés

NomTypeDescription
descriptionStringDescription des événements de la série
locationStringle lieu des événements de la série
guestsStringListe des adresses e-mail devant être ajoutées aux événements de la série, séparées par une virgule
sendInvitesBooleanenvoi des e-mails d'invitation (par défaut: false)

Aller-retour

CalendarEventSeries : série d'événements créée

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

createCalendar(name)

Crée un agenda, qui appartient à l'utilisateur.

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

Paramètres

NomTypeDescription
nameStringle nom du nouvel agenda.

Aller-retour

Calendar : l'agenda que vous venez de créer

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

createCalendar(name, options)

Crée un agenda, qui appartient à l'utilisateur.

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

Paramètres

NomTypeDescription
nameStringle nom du nouvel agenda.
optionsObjectUn objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous

Paramètres avancés

NomTypeDescription
locationStringla position de l'agenda
summaryStringla description de l'agenda
timeZoneStringFuseau horaire vers lequel définir l'agenda, spécifié au format "long" (par exemple, "America/New_York", tel que répertorié par Joda.org)
colorStringune chaîne de couleur hexadécimale (&rrtbb") ou une valeur de CalendarApp.Colors ;
hiddenBooleansi l'agenda est masqué dans l'interface utilisateur (par défaut : false)
selectedBooleansi les événements d'agenda sont affichés dans l'interface utilisateur (par défaut: true)

Aller-retour

Calendar : l'agenda que vous venez de créer

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

createEvent(title, startTime, endTime)

Crée un événement.

Si aucun fuseau horaire n'est spécifié, les valeurs de fuseau horaire sont interprétées dans le contexte du script du script, qui peut être différent du fuseau horaire de l'agenda.

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

Paramètres

NomTypeDescription
titleStringle titre de l'événement ;
startTimeDateLa date et l'heure de début de l'événement
endTimeDateLa date et l'heure de fin de l'événement

Aller-retour

CalendarEvent : événement créé

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

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

createEvent(title, startTime, endTime, options)

Crée un événement.

Si aucun fuseau horaire n'est spécifié, les valeurs de fuseau horaire sont interprétées dans le contexte du script du script, qui peut être différent du fuseau horaire de l'agenda.

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

Paramètres

NomTypeDescription
titleStringle titre de l'événement ;
startTimeDateLa date et l'heure de début de l'événement
endTimeDateLa date et l'heure de fin de l'événement
optionsObjectUn objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous

Paramètres avancés

NomTypeDescription
descriptionStringDescription de l'événement
locationStringle lieu de l'événement ;
guestsStringListe des adresses e-mail devant être ajoutées en tant qu'invités, séparées par une virgule
sendInvitesBooleanenvoi des e-mails d'invitation (par défaut: false)

Aller-retour

CalendarEvent : événement créé

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

createEventFromDescription(description)

Crée un événement à partir d'une description au format libre.

La description doit utiliser le même format que la fonctionnalité Ajout rapide de l'interface utilisateur.

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

Paramètres

NomTypeDescription
descriptionStringDescription libre de l'événement

Aller-retour

CalendarEvent : événement créé

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

createEventSeries(title, startTime, endTime, recurrence)

Crée une série d'événements.

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

Paramètres

NomTypeDescription
titleStringTitre des événements de la série
startTimeDateLa date et l'heure de début du premier événement de la série
endTimeDateDate et heure de fin du premier événement de la série
recurrenceEventRecurrenceles paramètres de récurrence de la série d'événements.

Aller-retour

CalendarEventSeries : série d'événements créée

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

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

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

Crée une série d'événements.

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

Paramètres

NomTypeDescription
titleStringTitre des événements de la série
startTimeDateLa date et l'heure de début du premier événement de la série
endTimeDateDate et heure de fin du premier événement de la série
recurrenceEventRecurrenceles paramètres de récurrence de la série d'événements.
optionsObjectUn objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous

Paramètres avancés

NomTypeDescription
descriptionStringDescription des événements de la série
locationStringle lieu des événements de la série
guestsStringListe des adresses e-mail devant être ajoutées aux événements de la série, séparées par une virgule
sendInvitesBooleanenvoi des e-mails d'invitation (par défaut : false)

Aller-retour

CalendarEventSeries : série d'événements créée

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

getAllCalendars()

Récupère tous les agendas de l'utilisateur ou auxquels il est abonné.

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

Aller-retour

Calendar[] : tous les agendas auxquels l'utilisateur peut accéder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

getAllOwnedCalendars()

Récupère tous les agendas de l'utilisateur.

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

Aller-retour

Calendar[] : tous les agendas de l'utilisateur

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

getCalendarById(id)

Récupère l'agenda associé à l'ID indiqué.

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

Paramètres

NomTypeDescription
idStringl'ID de l'agenda

Aller-retour

Calendar : agenda avec l'ID donné, ou null si l'agenda n'existe pas, si l'utilisateur ne peut pas y accéder ou s'il n'est pas abonné à l'agenda

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

getCalendarsByName(name)

Récupère tous les agendas dont l'utilisateur est propriétaire ou auquel il est abonné. Les noms ne sont pas sensibles à la casse.

// Gets the public calendar named "US Holidays".
var calendars = CalendarApp.getCalendarsByName('US Holidays');
Logger.log('Found %s matching calendars.', calendars.length);

Paramètres

NomTypeDescription
nameStringle nom de l'agenda

Aller-retour

Calendar[] : tous les agendas portant ce nom et auxquels l'utilisateur peut accéder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

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

getColor()

Récupère la couleur de l'agenda.

Aller-retour

String : chaîne de couleur hexadécimale (&rrtbb#rrggbb")

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

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

getDefaultCalendar()

Récupère l'agenda par défaut de l'utilisateur.

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

Aller-retour

Calendar : agenda par défaut de l'utilisateur

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

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

getDescription()

Récupère la description de l'agenda.

Aller-retour

String : description de cet agenda

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

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

getEventById(iCalId)

Récupère l'événement associé à l'ID indiqué. Si la série appartient à un agenda autre que l'agenda par défaut, cette méthode doit être appelée à partir de cet CalendarApp. L'appel de getEventById(iCalId) ne renvoie qu'un événement dans l'agenda par défaut.

Plusieurs événements peuvent avoir le même ID s'ils font partie d'une série d'événements. Dans ce cas, cette méthode ne renvoie que le premier événement de cette série.

Paramètres

NomTypeDescription
iCalIdStringID de l'événement

Aller-retour

CalendarEvent : événement associé à l'ID indiqué, ou null si l'événement n'existe pas ou que l'utilisateur ne peut pas y accéder.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

getEventSeriesById(iCalId)

Récupère la série d'événements avec l'ID donné. Si l'ID fourni correspond à un seul élément CalendarEvent, un objet CalendarEventSeries est renvoyé avec un seul événement dans la série. Notez que si la série d'événements appartient à un agenda autre que l'agenda par défaut, cette méthode doit être appelée à partir de cet CalendarApp. L'appel de getEventSeriesById(iCalId) ne renvoie directement qu'une série d'événements qui existe dans l'agenda par défaut.

Paramètres

NomTypeDescription
iCalIdStringID de la série d'événements

Aller-retour

CalendarEventSeries : la série avec l'ID donné, ou null si la série n'existe pas ou que l'utilisateur ne peut pas y accéder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

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

getEvents(startTime, endTime)

Récupère tous les événements qui se produisent au cours d'une période donnée.

Cette méthode renvoie des événements qui commencent pendant la période donnée, se terminent pendant cette période ou englobent la période. Si aucun fuseau horaire n'est spécifié, les valeurs sont interprétées dans le contexte du fuseau horaire du script, qui peut être différent du fuseau horaire de l'agenda.

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

Paramètres

NomTypeDescription
startTimeDatele début de la période
endTimeDatefin de la période, non inclusif

Aller-retour

CalendarEvent[] : événements qui se produisent au cours de la période

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

getEvents(startTime, endTime, options)

Récupère tous les événements qui se produisent au cours d'une période donnée et qui répondent aux critères spécifiés.

Cette méthode renvoie des événements qui commencent pendant la période donnée, se terminent pendant cette période ou englobent cette période. Si aucun fuseau horaire n'est spécifié, les valeurs sont interprétées dans le contexte du fuseau horaire du script, qui peut être différent du fuseau horaire de l'agenda.

Sachez que le filtrage sur author, search ou statusFilters est appliqué après l'application de start et de max. Cela signifie que le nombre d'événements renvoyés peut être inférieur à max, même si d'autres événements répondent aux critères.

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

Paramètres

NomTypeDescription
startTimeDatele début de la période
endTimeDatefin de la période, non inclusif
optionsObjectUn objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous

Paramètres avancés

NomTypeDescription
startIntegerl'index du premier événement à afficher
maxIntegerNombre maximal d'événements à renvoyer
authorStringAdresse e-mail utilisée pour filtrer les résultats par le créateur de l'événement
searchStringRequête de recherche en texte intégral permettant de filtrer les résultats
statusFilters[]GuestStatusTableau des états utilisés pour filtrer les résultats

Aller-retour

CalendarEvent[] : événements qui ont lieu dans la période et qui correspondent aux critères

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

getEventsForDay(date)

Récupère tous les événements qui se produisent un jour donné.

Cette méthode renvoie les événements qui débutent pendant la journée, se terminent pendant la journée ou englobent la journée.

Notez que seule la partie date de l'objet "Date" est utilisée et que la partie "heure" est ignorée. La date est interprétée comme allant de minuit ce jour-là à minuit le lendemain du fuseau horaire du calendrier.

// Determines how many events are happening today.
var today = new Date();
var events = CalendarApp.getDefaultCalendar().getEventsForDay(today);
Logger.log('Number of events: ' + events.length);

Paramètres

NomTypeDescription
dateDatedate de récupération des événements (seule la journée est utilisée ; l'heure est ignorée)

Aller-retour

CalendarEvent[] : événements qui se produisent à la date donnée

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

getEventsForDay(date, options)

Récupère tous les événements qui se produisent un jour donné et qui répondent aux critères spécifiés.

Cette méthode renvoie les événements qui débutent pendant la journée, se terminent pendant la journée ou englobent la journée.

Notez que seule la partie date de l'objet "Date" est utilisée et que la partie "heure" est ignorée. La date est interprétée comme allant de minuit ce jour-là à minuit le lendemain du fuseau horaire du calendrier.

Sachez que le filtrage sur author, search ou statusFilters est appliqué après l'application de start et de max. Cela signifie que le nombre d'événements renvoyés peut être inférieur à max, même si d'autres événements répondent aux critères.

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

Paramètres

NomTypeDescription
dateDatedate de récupération des événements (seule la journée est utilisée ; l'heure est ignorée)
optionsObjectoptions de filtrage avancées

Paramètres avancés

NomTypeDescription
startIntegerl'index du premier événement à afficher
maxIntegerNombre maximal d'événements à renvoyer
authorStringAdresse e-mail utilisée pour filtrer les résultats par le créateur de l'événement
searchStringRequête de recherche en texte intégral permettant de filtrer les résultats
statusFilters[]GuestStatusTableau des états utilisés pour filtrer les résultats

Aller-retour

CalendarEvent[] : événements qui se produisent à la date indiquée et correspondent aux critères

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

getId()

Récupère l'identifiant de l'agenda. L'identifiant de l'agenda par défaut d'un utilisateur correspond à son adresse e-mail.

Aller-retour

String : ID de l'agenda

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

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

getName()

Récupère le nom de l'agenda.

Aller-retour

String : nom de cet agenda

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

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

getOwnedCalendarById(id)

Récupère l'agenda associé à l'ID indiqué, si l'utilisateur en est le propriétaire.

Pour trouver un ID d'agenda, cliquez sur la flèche à côté du nom de l'agenda dans Google Agenda, puis sélectionnez Paramètres de l'agenda. L'ID s'affiche au bas de la page des paramètres.

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

Paramètres

NomTypeDescription
idStringl'ID de l'agenda

Aller-retour

Calendar : agenda avec l'ID donné ou null si l'agenda n'existe pas ou que l'utilisateur n'en est pas le propriétaire

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

getOwnedCalendarsByName(name)

Récupère tous les agendas dont le nom correspond à celui de l'utilisateur. Les noms ne sont pas sensibles à la casse.

// Gets a private calendar named "Travel Plans".
var calendars = CalendarApp.getOwnedCalendarsByName('Travel Plans');
Logger.log('Found %s matching calendars.', calendars.length);

Paramètres

NomTypeDescription
nameStringle nom de l'agenda

Aller-retour

Calendar[] : tous les agendas portant ce nom appartenant à l'utilisateur

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

getTimeZone()

Récupère le fuseau horaire de l'agenda.

Aller-retour

String : fuseau horaire, indiqué au format"long" (par exemple, "America/New_York", tel que répertorié par Joda.org)

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

isHidden()

Détermine si l'agenda est masqué dans l'interface utilisateur.

Aller-retour

Boolean : true si l'agenda est masqué dans l'interface utilisateur ; false dans le cas contraire

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

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

isMyPrimaryCalendar()

Détermine si l'agenda est l'agenda par défaut de l'utilisateur effectif.

Aller-retour

Boolean : true si l'agenda est l'agenda par défaut de l'utilisateur effectif ; false dans le cas contraire

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

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

isOwnedByMe()

Détermine si l'agenda appartient à l'utilisateur effectif.

Aller-retour

Boolean : true si l'agenda appartient à l'utilisateur effectif ; false dans le cas contraire

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

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

isSelected()

Détermine si les événements d'agenda sont affichés dans l'interface utilisateur.

Aller-retour

Boolean : true si les événements de l'agenda sont affichés dans l'interface utilisateur ; false dans le cas contraire

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

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

newRecurrence()

Crée un objet de récurrence, qui peut être utilisé pour créer des règles de récurrence d'événement.

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

Aller-retour

EventRecurrence : nouvel objet de récurrence sans règle définie (comporte comme une récurrence hebdomadaire)

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

setColor(color)

Définit la couleur de l'agenda.

Paramètres

NomTypeDescription
colorStringChaîne de couleur hexadécimale (&rrtbb#&;gggg") ou valeur de CalendarApp.Color.

Aller-retour

Calendar : cet agenda pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

setDescription(description)

Définit la description de l'agenda.

Paramètres

NomTypeDescription
descriptionStringla description de cet agenda

Aller-retour

Calendar : cet agenda pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

setHidden(hidden)

Ce paramètre détermine si l'agenda est visible dans l'interface utilisateur.

Paramètres

NomTypeDescription
hiddenBooleantrue pour masquer l'agenda dans l'interface utilisateur ; false pour l'afficher

Aller-retour

Calendar : cet agenda pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

setName(name)

Définit le nom de l'agenda.

Paramètres

NomTypeDescription
nameStringle nouveau nom

Aller-retour

Calendar : cet agenda pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

setSelected(selected)

Détermine si les événements d'agenda sont affichés dans l'interface utilisateur.

Paramètres

NomTypeDescription
selectedBooleantrue pour afficher les événements de l'agenda dans l'interface utilisateur ; false pour les masquer

Aller-retour

Calendar : cet agenda pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

setTimeZone(timeZone)

Définit le fuseau horaire de l'agenda.

Paramètres

NomTypeDescription
timeZoneStringFuseau horaire, au format "long" (par exemple, "America/New_York", comme répertorié par Joda.org)

Aller-retour

Calendar : cet agenda pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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

subscribeToCalendar(id)

Abonne l'utilisateur à l'agenda associé à l'ID indiqué, s'il est autorisé à s'abonner.

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

Paramètres

NomTypeDescription
idStringID de l'agenda auquel s'abonner

Aller-retour

Calendar : nouvel abonnement à l'agenda

Génère

Error : si aucun agenda n'est associé à cet ID

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

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

subscribeToCalendar(id, options)

Abonne l'utilisateur à l'agenda associé à l'ID indiqué, s'il est autorisé à s'abonner.

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

Paramètres

NomTypeDescription
idStringID de l'agenda auquel s'abonner
optionsObjectUn objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous

Paramètres avancés

NomTypeDescription
colorStringune chaîne de couleur hexadécimale (&rrtbb") ou une valeur de CalendarApp.Colors ;
hiddenBooleansi l'agenda est masqué dans l'interface utilisateur (par défaut : false)
selectedBooleansi les événements d'agenda sont affichés dans l'interface utilisateur (par défaut : true)

Aller-retour

Calendar : nouvel agenda auquel vous êtes abonné

Génère

Error : si aucun agenda n'est associé à cet ID

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

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