Class CalendarApp

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

Renvois

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

Renvois

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

Renvois

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 des 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.

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

Renvois

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 des 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 d'une journée entière.

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

Renvois

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 des 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 d'une journée entière.

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

Renvois

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 des 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 agenda appartenant à 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

Renvois

Calendar : agenda nouvellement créé

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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 agenda appartenant à 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

Paramètres avancés

Renvois

Calendar : agenda nouvellement créé

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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, 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

Renvois

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 des 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, 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

Renvois

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

Renvois

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

Renvois

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

Renvois

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 des champs d'application appropriés de l'API REST associée:

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

Permet d'obtenir tous les agendas appartenant à 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);

Renvois

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

Permet d'obtenir tous les agendas appartenant à l'utilisateur.

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

Renvois

Calendar[] : tous les agendas 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 des 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'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

Renvois

Calendar : l'agenda avec l'ID donné, ou null si l'agenda n'existe pas, si le 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 des 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 agendas portant le nom que l'utilisateur possède ou auquel il est abonné. Les noms ne sont pas sensible à 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

Renvois

Calendar[] : tous les agendas portant ce nom 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 des 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 couleur de l'agenda.

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

Renvois

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 des 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'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());

Renvois

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 des 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.

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

Renvois

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 des 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 associé à l'identifiant indiqué. Si la série appartient à un autre agenda que celui par défaut d'agenda, cette méthode doit être appelée à partir de ce calendrier. Appel au getEventById(iCalId) uniquement renvoie 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, ne renvoie que le premier événement de cette série.

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

Paramètres

Renvois

CalendarEvent : événement avec l'ID donné ou null si l'événement n'existe pas ou si 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 des 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 associée à l'ID donné. Si l'ID fourni correspond à un seul élément CalendarEvent, alors un CalendarEventSeries est renvoyé avec un seul événement de la série. Notez que si la série d'événements appartient à un autre agenda que l'agenda par défaut, cette méthode doit être appelé à partir de ce CalendarApp ; appel du getEventSeriesById(iCalId)... renvoie directement uniquement une série d'événements qui existe dans l'agenda par défaut.

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

Paramètres

Renvois

CalendarEventSeries : série avec l'ID donné, ou null si la série n'existe pas ou si 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 des 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 et se terminent dans l'intervalle de temps période, ou qui englobent la période. Si aucun fuseau horaire n'est spécifié, les valeurs de temps sont interprété dans le contexte du fuseau horaire du script, qui peut être différent le fuseau horaire de votre 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

Renvois

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 des 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 des événements qui commencent pendant la période donnée et se terminent pendant la période période, ou qui englobe la période. Si aucun fuseau horaire n'est spécifié, les valeurs de temps sont interprété dans le contexte du fuseau horaire du script, qui peut être différent le fuseau horaire de votre agenda.

Sachez que le filtrage sur author, search ou statusFilters prend après avoir appliqué les valeurs start et max. Cela signifie que le nombre d'événements 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

Renvois

CalendarEvent[] : événements qui se déroulent au cours de 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 des 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 pendant un jour donné, se terminent dans la journée ou qui couvrent 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 de minuit ce jour-là à minuit le jour suivant dans l'heure du calendrier. dans la zone.

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

Renvois

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 des 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 répondent aux critères spécifiés.

Cette méthode renvoie des événements s'ils commencent pendant un jour donné, se terminent dans la journée ou qui couvrent 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 de minuit ce jour-là à minuit le jour suivant dans l'heure du calendrier. dans la zone.

Sachez que le filtrage sur author, search ou statusFilters prend après avoir appliqué les valeurs start et max. Cela signifie que le nombre d'événements 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

Renvois

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 des 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.

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

Renvois

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 des 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.

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

Renvois

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 des 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'agenda associé à l'ID indiqué, si l'utilisateur en est le propriétaire.

Pour trouver l'ID d'un agenda, cliquez sur la flèche située à côté du nom de l'agenda dans Google Agenda, puis sur sélectionnez Paramètres de l'agenda. L'ID est indiqué en bas 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

Renvois

Calendar : l'agenda avec l'ID donné, ou null si l'agenda n'existe pas ou si le 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 des 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

Permet d'obtenir tous les agendas portant le nom donné appartenant à 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

Renvois

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 des 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.

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

Renvois

String : fuseau horaire, spécifié sous la forme "long". (par exemple, "America/New_York", comme indiqué 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 des 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.

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

Renvois

Boolean : true si l'agenda est masqué dans l'interface utilisateur false n'est pas le cas.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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 principal de l'utilisateur effectif.

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

Renvois

Boolean : true si l'agenda est l'agenda par défaut de l'utilisateur effectif false si ce n'est pas le cas.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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 vous appartient.

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

Renvois

Boolean : true si l'agenda vous appartient false si ce n'est pas le cas.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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.

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

Renvois

Boolean : true si les événements de l'agenda sont affichés dans l'interface utilisateur false si ce n'est pas le cas

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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

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

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

Renvois

EventRecurrence : nouvel objet de récurrence sans règles définies (se 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 des 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.

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

Paramètres

Renvois

Calendar : cet agenda pour l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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 d'un agenda.

// 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.')

Paramètres

Renvois

Calendar : cet agenda pour l'enchaînement

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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

Renvois

Calendar : cet agenda pour l'enchaînement

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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.

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

Paramètres

Renvois

Calendar : cet agenda pour l'enchaînement

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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 doivent être affichés dans l'interface utilisateur.

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

Paramètres

Renvois

Calendar : cet agenda pour l'enchaînement

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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.

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

Paramètres

Renvois

Calendar : cet agenda pour l'enchaînement.

Autorisation

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

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

Abonne l'utilisateur à l'agenda avec l'ID donné, 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

Renvois

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 des champs d'application appropriés de l'API REST associée:

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

Abonne l'utilisateur à l'agenda avec l'ID donné, 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

Paramètres avancés

Renvois

Calendar : 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 des champs d'application appropriés de l'API REST associée:

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