Class Calendar

Crée un événement qui dure toute la journée.

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

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

Crée un événement d'une journée entière, qui peut s'étendre sur plusieurs jours.

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

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

Crée un événement d'une journée entière, qui peut s'étendre sur plusieurs jours.

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

Paramètres avancés

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

Crée un événement qui dure toute la journée.

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

Paramètres avancés

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

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

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

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

Paramètres avancés

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

Crée un événement.

Si aucun fuseau horaire n'est spécifié, les valeurs de temps sont interprétées dans le contexte du fuseau horaire du script, qui peut être différent de celui 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

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

Crée un événement.

Si aucun fuseau horaire n'est spécifié, les valeurs de temps sont interprétées dans le contexte du fuseau horaire du script, qui peut être différent de celui 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

Paramètres avancés

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

Crée un événement à partir d'une description de 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

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

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

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

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

Paramètres avancés

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

Supprime définitivement l'agenda. Un utilisateur ne peut supprimer que les agendas qui lui appartiennent.

Génère

Error : s'il s'agit d'un agenda importé

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

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

Aller-retour

String : chaîne de couleur hexadécimale ("#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

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

Récupère l'événement correspondant à l'ID donné. Si la série appartient à un agenda autre que l'agenda par défaut, cette méthode doit être appelée à partir de cet agenda. Appeler CalendarApp.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. Dans ce cas, cette méthode ne renvoie que le premier événement de cette série.

Paramètres

Aller-retour

CalendarEvent : événement avec l'ID donné, 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

Récupère la série d'événements correspondant à l'ID donné. Si l'ID fourni correspond à un seul élément CalendarEvent, une valeur CalendarEventSeries est renvoyée avec un seul événement de 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 Calendar. L'appel de CalendarApp.getEventSeriesById(iCalId) ne renvoie directement qu'une série d'événements qui existe dans l'agenda par défaut.

Paramètres

Aller-retour

CalendarEventSeries : 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

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

Cette méthode renvoie les événements qui commencent pendant la période donnée, se terminent pendant la période ou englobent la période. Si aucun fuseau horaire n'est spécifié, les valeurs temporelles 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

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

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 les événements qui commencent pendant la période donnée, se terminent pendant la période ou englobent la période. Si aucun fuseau horaire n'est spécifié, les valeurs temporelles 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 a lieu 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

Paramètres avancés

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

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

Cette méthode renvoie des événements s'ils commencent dans la journée donnée, se terminent dans la journée ou comprennent 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 dans le fuseau horaire de l'agenda.

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

Aller-retour

CalendarEvent[] : événements qui ont lieu à 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

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 des événements s'ils commencent dans la journée donnée, se terminent dans la journée ou comprennent 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 dans le fuseau horaire de l'agenda.

Sachez que le filtrage sur author, search ou statusFilters a lieu 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

Paramètres avancés

Aller-retour

CalendarEvent[] : événements qui se produisent à la date donnée 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

Récupère l'identifiant de l'agenda. L'ID 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

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

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

Aller-retour

String : fuseau horaire spécifié au format "long" (par exemple, "America/New_York", selon le site 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

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

Détermine si l'agenda est l'agenda par défaut pour 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

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

Détermine si les événements de l'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

Définit la couleur de l'agenda.

Paramètres

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

Définit la description de l'agenda.

Paramètres

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

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

Paramètres

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

Définit le nom de l'agenda.

Paramètres

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

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

Paramètres

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

Définit le fuseau horaire de l'agenda.

Paramètres

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

Désabonne l'utilisateur de l'agenda. Un utilisateur ne peut pas se désabonner d'un agenda dont il est propriétaire.

Génère

Error, s'il s'agit d'un agenda dont vous êtes 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.google.com/calendar/feeds