Représente un agenda dont l'utilisateur est propriétaire ou auquel il est abonné.
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. |
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 au 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. |
deleteCalendar() | void | Supprime l'agenda définitivement. |
getColor() | String | Récupère la couleur de l'agenda. |
getDescription() | String | Récupère la description de l'agenda. |
getEventById(iCalId) | CalendarEvent | Récupère l'événement avec l'ID donné. |
getEventSeriesById(iCalId) | CalendarEventSeries | Récupère la série d'événements avec l'ID donné. |
getEvents(startTime, endTime) | CalendarEvent[] | Récupère tous les événements qui se produisent au cours d'une période donnée. |
getEvents(startTime, endTime, options) | CalendarEvent[] | Récupère tous les événements qui se produisent au cours d'une période donnée et répondent aux critères spécifiés. |
getEventsForDay(date) | CalendarEvent[] | Récupère tous les événements qui se produisent un jour donné. |
getEventsForDay(date, options) | CalendarEvent[] | Récupère tous les événements qui se produisent un jour donné et répondent aux critères spécifiés. |
getId() | String | Récupère l'ID de l'agenda. |
getName() | String | Récupère le nom de l'agenda. |
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 principal de l'utilisateur effectif. |
isOwnedByMe() | Boolean | Détermine si l'agenda vous appartient. |
isSelected() | Boolean | Détermine si les événements de l'agenda sont affichés dans l'interface utilisateur. |
setColor(color) | Calendar | Définit la couleur de l'agenda. |
setDescription(description) | Calendar | Définit la description d'un agenda. |
setHidden(hidden) | Calendar | Détermine 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. |
unsubscribeFromCalendar() | void | Désabonne l'utilisateur d'un agenda. |
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 (seul le jour est utilisé ; l'heure est ignorée). |
Renvois
CalendarEvent
: événement créé
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
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 (seul le jour est utilisé ; l'heure est ignorée). |
endDate | Date | Date de fin de l'événement (seul le jour est utilisé ; l'heure est ignorée). La date de fin est exclusive. |
Renvois
CalendarEvent
: événement créé
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
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 (seul le jour est utilisé ; l'heure est ignorée). |
endDate | Date | Date de fin de l'événement (seul le jour est utilisé ; l'heure est ignorée). La date de fin est exclusive. |
options | Object | Objet JavaScript qui spécifie les paramètres avancés répertoriés 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 séparées par une virgule à ajouter en tant qu'invités. |
sendInvites | Boolean | Permet d'envoyer ou non des e-mails d'invitation (par défaut: false ). |
Renvois
CalendarEvent
: événement créé
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
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 (seul le jour est utilisé ; l'heure est ignorée). |
options | Object | Objet JavaScript qui spécifie les paramètres avancés répertoriés 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 séparées par une virgule à ajouter en tant qu'invités. |
sendInvites | Boolean | Permet d'envoyer ou non des e-mails d'invitation (par défaut: false ). |
Renvois
CalendarEvent
: événement créé
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
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é, et l'heure est ignorée) |
recurrence | EventRecurrence | les paramètres de récurrence de la série d'événements. |
Renvois
CalendarEventSeries
: série d'événements créée
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
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é, et 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 les paramètres avancés, listés 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) à ajouter 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 ) |
Renvois
CalendarEventSeries
: série d'événements créée
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
createEvent(title, startTime, endTime)
Crée un événement.
Si aucun fuseau horaire n'est spécifié, les valeurs horaires sont interprétées dans le contexte du fuseau horaire du script, qui peut être différent de celui du calendrier.
// 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 | 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 |
Renvois
CalendarEvent
: événement créé
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
createEvent(title, startTime, endTime, options)
Crée un événement.
Si aucun fuseau horaire n'est spécifié, les valeurs horaires sont interprétées dans le contexte du fuseau horaire du script, qui peut être différent de celui du calendrier.
// 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 | 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 les paramètres avancés, listés ci-dessous ; |
Paramètres avancés
Nom | Type | Description |
---|---|---|
description | String | la description de l'événement |
location | String | le lieu de l'événement ; |
guests | String | Une liste d'adresses e-mail séparées par une virgule à ajouter en tant qu'invités |
sendInvites | Boolean | envoyer ou non des e-mails d'invitation (par défaut: false ) |
Renvois
CalendarEvent
: événement créé
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
createEventFromDescription(description)
Crée un événement à partir d'une description au format libre.
La description doit utiliser le même format que la fonctionnalité Ajout rapide de l'interface utilisateur.
// Creates a new event and logs its ID. var event = CalendarApp.getDefaultCalendar() .createEventFromDescription('Lunch with Mary, Friday at 1PM'); Logger.log('Event ID: ' + event.getId());
Paramètres
Nom | Type | Description |
---|---|---|
description | String | une description libre de l'événement |
Renvois
CalendarEvent
: événement créé
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
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 | La date et l'heure auxquelles commence le premier événement de la série |
endTime | Date | La date et l'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. |
Renvois
CalendarEventSeries
: série d'événements créée
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
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 | La date et l'heure auxquelles commence le premier événement de la série |
endTime | Date | La date et l'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 les paramètres avancés, listés 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) à ajouter 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 ) |
Renvois
CalendarEventSeries
: série d'événements créée
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
deleteCalendar()
Supprime l'agenda définitivement. Un utilisateur ne peut supprimer que l'agenda dont il est propriétaire.
// Creates a calendar to delete. const calendar = CalendarApp.createCalendar('Test'); // Deletes the 'Test' calendar permanently. calendar.deleteCalendar();
Génère
Error
: s'il s'agit d'un agenda importé.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
getColor()
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 associée à 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
getDescription()
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 associée à 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
getEventById(iCalId)
Récupère l'événement avec l'ID donné. Si la série appartient à un autre agenda que celui par défaut, cette méthode doit être appelée à partir de cet agenda. L'appel de 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 d'événements. Dans ce cas, cette méthode 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
Nom | Type | Description |
---|---|---|
iCalId | String | ID de l'événement. |
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 associée à 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
getEventSeriesById(iCalId)
Récupère la série d'événements avec l'ID donné. Si l'ID donné concerne un seul événement 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 ce 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.
// 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
Nom | Type | Description |
---|---|---|
iCalId | String | ID de la série d'événements. |
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 associée à 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
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 sélectionnée ou englobent la période. Si aucun fuseau horaire n'est spécifié, les valeurs horaires sont interprétées dans le contexte du script du script, qui peut être différent de celui du calendrier.
// 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) |
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 associée à 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
getEvents(startTime, endTime, options)
Récupère tous les événements qui se produisent au cours d'une période donnée et 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 donnée ou englobent la période. Si aucun fuseau horaire n'est spécifié, les valeurs horaires sont interprétées dans le contexte du script du script, qui peut être différent de celui du calendrier.
Sachez que le filtrage sur author
, search
ou statusFilters
a lieu après l'application de start
et 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 les paramètres avancés, listés 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 à renvoyer |
author | String | Une adresse e-mail utilisée pour filtrer les résultats en fonction du créateur de l'événement |
search | String | une requête de recherche en texte intégral utilisée pour filtrer les résultats |
statusFilters[] | GuestStatus | Tableau des états utilisés pour filtrer les résultats |
Renvois
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 associée à 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
getEventsForDay(date)
Récupère tous les événements qui se produisent un jour donné.
Cette méthode renvoie des événements s'ils commencent le jour donné, se terminent au cours de la journée ou englobent la journée.
Notez que seule la partie date de l'objet Date est utilisée et que l'heure est ignorée. La date est interprétée comme allant de minuit à minuit le lendemain dans 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 | La date pour laquelle récupérer les événements (seul le jour est utilisé ; l'heure est ignorée) |
Renvois
CalendarEvent[]
: événements qui se produisent à la date donnée
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
getEventsForDay(date, options)
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 le jour donné, se terminent au cours de la journée ou englobent la journée.
Notez que seule la partie date de l'objet Date est utilisée et que l'heure est ignorée. La date est interprétée comme allant de minuit à minuit le lendemain dans le fuseau horaire du calendrier.
Sachez que le filtrage sur author
, search
ou statusFilters
a lieu après l'application de start
et 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 | La date pour laquelle récupérer les événements (seul le jour est utilisé ; 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 à renvoyer |
author | String | Une adresse e-mail utilisée pour filtrer les résultats en fonction du créateur de l'événement |
search | String | une requête de recherche en texte intégral utilisée pour filtrer les résultats |
statusFilters[] | GuestStatus | Tableau des états utilisés pour filtrer les résultats |
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 associée à 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
getId()
Récupère l'ID de l'agenda. L'ID de l'agenda par défaut d'un utilisateur est 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 associée à 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
getName()
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 associée à 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
getTimeZone()
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é au format "long" (par exemple, "America/New_York", tel qu'il est répertorié par Joda.org).
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
isHidden()
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
dans le cas contraire.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
isMyPrimaryCalendar()
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
dans le cas contraire.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
isOwnedByMe()
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
dans le cas contraire.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
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());
Renvois
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 associée à 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
setColor(color)
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
Nom | Type | Description |
---|---|---|
color | String | Un CalendarApp.Color ou une chaîne de couleur hexadécimale ("#rrggbb"). |
Renvois
Calendar
: agenda associé au chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
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 |
Renvois
Calendar
: cet agenda pour le chaînage
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
setHidden(hidden)
Détermine 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 |
Renvois
Calendar
: cet agenda pour le chaînage
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
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 |
Renvois
Calendar
: cet agenda pour le chaînage
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
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 |
Renvois
Calendar
: cet agenda pour le chaînage
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
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). |
Renvois
Calendar
: agenda associé au chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
unsubscribeFromCalendar()
Désabonne l'utilisateur d'un agenda. Un utilisateur ne peut pas se désabonner d'un agenda figurant dans la liste Mes agendas. Ils peuvent se désabonner des agendas répertoriés sous Autres agendas.
// Gets the calendar by its ID. // TODO(developer): Replace the calendar ID with the calendar ID that you want to get. const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com'); // Unsubscribes the user from the calendar. const result = calendar.unsubscribeFromCalendar();
Génère
Error
: s'il s'agit d'un agenda dont vous êtes propriétaire
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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