Autorise un script à lire et à mettre à jour l'agenda Google de l'utilisateur. Cette classe fournit un accès direct à l'agenda par défaut de l'utilisateur, ainsi que la possibilité de récupérer des agendas supplémentaires appartenant à l'utilisateur ou auxquels il est abonné.
Propriétés
Propriété | Type | Description |
---|---|---|
Color | Color | Énumération représentant les couleurs nommées disponibles dans le service Agenda. |
EventColor | EventColor | Énumération représentant les couleurs d'événements nommés disponibles dans le service Agenda. |
GuestStatus | GuestStatus | Énumération représentant les états d'un invité pour un événement. |
Month | Month | Énumération représentant les mois de l'année. |
Visibility | Visibility | Énumération représentant la visibilité d'un événement. |
Weekday | Weekday | Énumération représentant les jours de la semaine. |
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
createAllDayEvent(title, date) | CalendarEvent | Crée un événement d'une journée entière. |
createAllDayEvent(title, startDate, endDate) | CalendarEvent | Crée un événement d'une journée entière pouvant s'étendre sur plusieurs jours. |
createAllDayEvent(title, startDate, endDate, options) | CalendarEvent | Crée un événement d'une journée entière pouvant s'étendre sur plusieurs jours. |
createAllDayEvent(title, date, options) | CalendarEvent | Crée un événement d'une journée entière. |
createAllDayEventSeries(title, startDate, recurrence) | CalendarEventSeries | Crée une série d'événements d'une journée entière. |
createAllDayEventSeries(title, startDate, recurrence, options) | CalendarEventSeries | Crée une série d'événements d'une journée entière. |
createCalendar(name) | Calendar | Crée un agenda appartenant à l'utilisateur. |
createCalendar(name, options) | Calendar | Crée un agenda appartenant à l'utilisateur. |
createEvent(title, startTime, endTime) | CalendarEvent | Crée un événement. |
createEvent(title, startTime, endTime, options) | CalendarEvent | Crée un événement. |
createEventFromDescription(description) | CalendarEvent | Crée un événement à partir d'une description de format libre. |
createEventSeries(title, startTime, endTime, recurrence) | CalendarEventSeries | Crée une série d'événements. |
createEventSeries(title, startTime, endTime, recurrence, options) | CalendarEventSeries | Cré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) | Calendar | Récupère l'agenda avec l'ID indiqué. |
getCalendarsByName(name) | Calendar[] | Récupère tous les agendas avec un nom donné appartenant à l'utilisateur ou auquel il est abonné. |
getColor() | String | Récupère la couleur de l'agenda. |
getDefaultCalendar() | Calendar | Récupère l'agenda par défaut de l'utilisateur. |
getDescription() | String | Récupère la description de l'agenda. |
getEventById(iCalId) | CalendarEvent | Récupère l'événement avec l'ID indiqué. |
getEventSeriesById(iCalId) | CalendarEventSeries | Récupère la série d'événements correspondant à l'ID indiqué. |
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épond 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() | String | Récupère l'identifiant de l'agenda. |
getName() | String | Récupère le nom de l'agenda. |
getOwnedCalendarById(id) | Calendar | Récupère l'agenda avec l'ID donné, si l'utilisateur en est le propriétaire. |
getOwnedCalendarsByName(name) | Calendar[] | Récupère tous les agendas dont l'utilisateur est propriétaire avec un nom donné. |
getTimeZone() | String | Récupère le fuseau horaire de l'agenda. |
isHidden() | Boolean | Détermine si l'agenda est masqué dans l'interface utilisateur. |
isMyPrimaryCalendar() | Boolean | Détermine si l'agenda est l'agenda par défaut pour l'utilisateur effectif. |
isOwnedByMe() | Boolean | Détermine si vous êtes le propriétaire de l'agenda. |
isSelected() | Boolean | Détermine si les événements de l'agenda sont affichés dans l'interface utilisateur. |
newRecurrence() | EventRecurrence | Crée un objet de récurrence, qui peut être utilisé pour créer des règles de récurrence d'événements. |
setColor(color) | Calendar | Définit la couleur de l'agenda. |
setDescription(description) | Calendar | Définit la description d'un agenda. |
setHidden(hidden) | Calendar | Indique si l'agenda est visible dans l'interface utilisateur. |
setName(name) | Calendar | Définit le nom de l'agenda. |
setSelected(selected) | Calendar | Détermine si les événements de l'agenda sont affichés dans l'interface utilisateur. |
setTimeZone(timeZone) | Calendar | Définit le fuseau horaire de l'agenda. |
subscribeToCalendar(id) | Calendar | Abonne l'utilisateur à l'agenda avec l'ID donné, s'il est autorisé à s'abonner. |
subscribeToCalendar(id, options) | Calendar | Abonne l'utilisateur à l'agenda avec l'ID donné, 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
Nom | Type | Description |
---|---|---|
title | String | Titre de l'événement. |
date | Date | 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 pouvant 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
Nom | Type | Description |
---|---|---|
title | String | Titre de l'événement. |
startDate | Date | Date de début de l'événement (seule la journée est utilisée, l'heure est ignorée). |
endDate | Date | Date de fin de l'événement (seule la journée est utilisée, l'heure est ignorée). La date de fin est exclusive. |
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 pouvant 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
Nom | Type | Description |
---|---|---|
title | String | Titre de l'événement. |
startDate | Date | Date de début de l'événement (seule la journée est utilisée, l'heure est ignorée). |
endDate | Date | Date de fin de l'événement (seule la journée est utilisée, l'heure est ignorée). La date de fin est exclusive. |
options | Object | Objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous. |
Paramètres avancés
Nom | Type | Description |
---|---|---|
description | String | Description de l'événement. |
location | String | Lieu de l'événement. |
guests | String | Liste d'adresses e-mail devant être ajoutées en tant qu'invités, séparées par une virgule. |
sendInvites | Boolean | Envoi ou non d'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
Nom | Type | Description |
---|---|---|
title | String | Titre de l'événement. |
date | Date | Date de l'événement (seule la journée est utilisée, l'heure est ignorée). |
options | Object | Objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous. |
Paramètres avancés
Nom | Type | Description |
---|---|---|
description | String | Description de l'événement. |
location | String | Lieu de l'événement. |
guests | String | Liste d'adresses e-mail devant être ajoutées en tant qu'invités, séparées par une virgule. |
sendInvites | Boolean | Envoi ou non d'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 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
Nom | Type | Description |
---|---|---|
title | String | Titre des événements de la série |
startDate | Date | Date du premier événement de la série (seul le jour est utilisé ; l'heure est ignorée) |
recurrence | EventRecurrence | les 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 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
Nom | Type | Description |
---|---|---|
title | String | Titre des événements de la série |
startDate | Date | Date du premier événement de la série (seul le jour est utilisé ; l'heure est ignorée) |
recurrence | EventRecurrence | les paramètres de récurrence de la série d'événements ; |
options | Object | un objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous. |
Paramètres avancés
Nom | Type | Description |
---|---|---|
description | String | La description des événements de la série |
location | String | le lieu des événements de la série. |
guests | String | Une liste d'adresses e-mail séparées par une virgule devant être ajoutées en tant qu'invités aux événements de la série |
sendInvites | Boolean | envoyer ou non 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 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
Nom | Type | Description |
---|---|---|
name | String | le nom du nouvel agenda |
Aller-retour
Calendar
: calendrier nouvellement 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
createCalendar(name, options)
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
Nom | Type | Description |
---|---|---|
name | String | le nom du nouvel agenda |
options | Object | un objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous. |
Paramètres avancés
Nom | Type | Description |
---|---|---|
location | String | emplacement de l'agenda |
summary | String | description de l'agenda |
timeZone | String | Fuseau horaire à utiliser pour l'agenda, spécifié au format "long" (par exemple, "America/New_York", tel qu'indiqué par Joda.org) |
color | String | une chaîne de couleur hexadécimale ("#rrggbb") ou une valeur de CalendarApp.Colors . |
hidden | Boolean | indique si l'agenda est masqué dans l'interface utilisateur (par défaut : false ). |
selected | Boolean | indique si les événements de l'agenda sont affichés dans l'interface utilisateur (par défaut: true ). |
Aller-retour
Calendar
: calendrier nouvellement 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)
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
Nom | Type | Description |
---|---|---|
title | String | le titre de l'événement ; |
startTime | Date | La date et l'heure de début de l'événement |
endTime | Date | La 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 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
Nom | Type | Description |
---|---|---|
title | String | le titre de l'événement ; |
startTime | Date | La date et l'heure de début de l'événement |
endTime | Date | La date et l'heure de fin de l'événement |
options | Object | un objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous. |
Paramètres avancés
Nom | Type | Description |
---|---|---|
description | String | Description de l'événement |
location | String | le lieu de l'événement ; |
guests | String | Une liste d'adresses e-mail devant être ajoutées en tant qu'invités, séparées par une virgule |
sendInvites | Boolean | envoyer ou non 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 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
Nom | Type | Description |
---|---|---|
description | String | Une description de l'événement sous forme libre |
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
Nom | Type | Description |
---|---|---|
title | String | Titre des événements de la série |
startTime | Date | Date et heure de début du premier événement de la série |
endTime | Date | Date et heure de fin du premier événement de la série |
recurrence | EventRecurrence | les 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
Nom | Type | Description |
---|---|---|
title | String | Titre des événements de la série |
startTime | Date | Date et heure de début du premier événement de la série |
endTime | Date | Date et heure de fin du premier événement de la série |
recurrence | EventRecurrence | les paramètres de récurrence de la série d'événements ; |
options | Object | un objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous. |
Paramètres avancés
Nom | Type | Description |
---|---|---|
description | String | La description des événements de la série |
location | String | le lieu des événements de la série. |
guests | String | Une liste d'adresses e-mail séparées par une virgule devant être ajoutées en tant qu'invités aux événements de la série |
sendInvites | Boolean | envoyer ou non 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 avec 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
Nom | Type | Description |
---|---|---|
id | String | l'identifiant 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 avec un nom donné appartenant à l'utilisateur 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
Nom | Type | Description |
---|---|---|
name | String | le nom de l'agenda |
Aller-retour
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 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 ("#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 avec 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 agenda. Appeler 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
Nom | Type | Description |
---|---|---|
iCalId | String | ID de l'événement |
Aller-retour
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 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 correspondant à l'ID indiqué. Si l'ID indiqué correspond à un seul CalendarEvent
, un 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 ce CalendarApp
. L'appel getEventSeriesById(iCalId)
ne renvoie directement qu'une série d'événements qui existe dans l'agenda par défaut.
Paramètres
Nom | Type | Description |
---|---|---|
iCalId | String | ID de la série d'événements |
Aller-retour
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 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 les événements qui commencent pendant la période donnée, se terminent pendant la période donnée 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 de celui 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
Nom | Type | Description |
---|---|---|
startTime | Date | le début de la période. |
endTime | Date | Fin de la période, non inclusive |
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épond 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 donnée 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 de celui 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
Nom | Type | Description |
---|---|---|
startTime | Date | le début de la période. |
endTime | Date | Fin de la période, non inclusive |
options | Object | un objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous. |
Paramètres avancés
Nom | Type | Description |
---|---|---|
start | Integer | l'index du premier événement à renvoyer. |
max | Integer | Nombre maximal d'événements à afficher |
author | String | Une adresse e-mail utilisée pour filtrer les résultats par le créateur de l'événement. |
search | String | Une requête de recherche en texte intégral permettant de filtrer les résultats |
statusFilters[] | GuestStatus | Tableau des états utilisés pour filtrer les résultats |
Aller-retour
CalendarEvent[]
: événements qui se produisent 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 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 en question.
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 à minuit le lendemain selon le 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
Nom | Type | Description |
---|---|---|
date | Date | date 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 en question.
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 à minuit le lendemain selon le fuseau horaire du calendrier.
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
Nom | Type | Description |
---|---|---|
date | Date | date de récupération des événements (seule la journée est utilisée, l'heure est ignorée) |
options | Object | options de filtrage avancées |
Paramètres avancés
Nom | Type | Description |
---|---|---|
start | Integer | l'index du premier événement à renvoyer. |
max | Integer | Nombre maximal d'événements à afficher |
author | String | Une adresse e-mail utilisée pour filtrer les résultats par le créateur de l'événement. |
search | String | Une requête de recherche en texte intégral permettant de filtrer les résultats |
statusFilters[] | GuestStatus | Tableau des états utilisés pour filtrer les résultats |
Aller-retour
CalendarEvent[]
: événements qui se produisent à la date donné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'ID de l'agenda par défaut d'un utilisateur est 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 avec l'ID donné, si l'utilisateur en est le propriétaire.
Pour rechercher 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 en 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
Nom | Type | Description |
---|---|---|
id | String | l'identifiant de l'agenda |
Aller-retour
Calendar
: agenda avec l'ID donné, ou null
si l'agenda n'existe pas ou si 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 l'utilisateur est propriétaire avec un nom donné. 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
Nom | Type | Description |
---|---|---|
name | String | le nom de l'agenda |
Aller-retour
Calendar[]
: tous les agendas de 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 spécifié au format "long" (par exemple, "America/New_York", tel que défini 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 pour l'utilisateur effectif.
Aller-retour
Boolean
: true
si l'agenda est l'agenda par défaut pour 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 vous êtes le propriétaire de l'agenda.
// 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());
Aller-retour
Boolean
: true
si l'agenda vous appartient, et 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 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());
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é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());
Aller-retour
EventRecurrence
: nouvel objet de récurrence sans règle définie (comportement identique à la 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.
// Gets the user's default calendar. To get a different calendar, use getCalendarById() // instead. const calendar = CalendarApp.getDefaultCalendar(); // Sets the color of the calendar to pink. calendar.setColor(CalendarApp.Color.PINK);
Paramètres
Nom | Type | Description |
---|---|---|
color | String | CalendarApp.Color ou chaîne de couleur hexadécimale ("#rrggbb"). |
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 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
Nom | Type | Description |
---|---|---|
description | String | la description de cet agenda |
Aller-retour
Calendar
: cet agenda pour les chaînages
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)
Indique si l'agenda est visible dans l'interface utilisateur.
Paramètres
Nom | Type | Description |
---|---|---|
hidden | Boolean | true pour masquer l'agenda dans l'interface utilisateur ; false pour l'afficher. |
Aller-retour
Calendar
: cet agenda pour les chaînages
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.
// 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
Nom | Type | Description |
---|---|---|
name | String | le nouveau nom |
Aller-retour
Calendar
: cet agenda pour les chaînages
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 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(); // 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
Nom | Type | Description |
---|---|---|
selected | Boolean | true pour afficher les événements de l'agenda dans l'interface utilisateur ; false
pour les masquer |
Aller-retour
Calendar
: cet agenda pour les chaînages
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.
// 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
Nom | Type | Description |
---|---|---|
timeZone | String | Fuseau horaire spécifié au format "long" (par exemple, "America/New_York", tel que 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 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
Nom | Type | Description |
---|---|---|
id | String | l'ID de l'agenda auquel s'abonner |
Aller-retour
Calendar
: nouvel abonné de 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 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
Nom | Type | Description |
---|---|---|
id | String | l'ID de l'agenda auquel s'abonner |
options | Object | un objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous. |
Paramètres avancés
Nom | Type | Description |
---|---|---|
color | String | une chaîne de couleur hexadécimale ("#rrggbb") ou une valeur de CalendarApp.Colors . |
hidden | Boolean | indique si l'agenda est masqué dans l'interface utilisateur (par défaut : false ). |
selected | Boolean | indique si les événements de l'agenda sont affichés dans l'interface utilisateur (par défaut: true ). |
Aller-retour
Calendar
: agenda que vous venez de souscrire
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