Représente un agenda appartenant à l'utilisateur ou auquel il est abonné.
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
create | Calendar | Crée un événement d'une journée entière. |
create | Calendar | Crée un événement d'une journée entière pouvant s'étendre sur plusieurs jours. |
create | Calendar | Crée un événement d'une journée entière pouvant s'étendre sur plusieurs jours. |
create | Calendar | Crée un événement d'une journée entière. |
create | Calendar | Crée une série d'événements d'une journée entière. |
create | Calendar | Crée une série d'événements d'une journée entière. |
create | Calendar | Crée un événement. |
create | Calendar | Crée un événement. |
create | Calendar | Crée un événement à partir d'une description de format libre. |
create | Calendar | Crée une série d'événements. |
create | Calendar | Crée une série d'événements. |
delete | void | Supprime définitivement l'agenda. |
get | String | Récupère la couleur de l'agenda. |
get | String | Récupère la description de l'agenda. |
get | Calendar | Récupère l'événement associé à l'ID donné. |
get | Calendar | Récupère la série d'événements associée à l'ID donné. |
get | Calendar | Récupère tous les événements qui se produisent au cours d'une période donnée. |
get | Calendar | 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. |
get | Calendar | Récupère tous les événements qui se produisent un jour donné. |
get | Calendar | Récupère tous les événements qui se produisent un jour donné et répondent aux critères spécifiés. |
get | String | Récupère l'ID de l'agenda. |
get | String | Récupère le nom de l'agenda. |
get | String | Récupère le fuseau horaire de l'agenda. |
is | Boolean | Indique si l'agenda est masqué dans l'interface utilisateur. |
is | Boolean | Indique si l'agenda est l'agenda principal de l'utilisateur effectif. |
is | Boolean | Indique si l'agenda vous appartient. |
is | Boolean | Détermine si les événements de l'agenda s'affichent dans l'interface utilisateur. |
set | Calendar | Définit la couleur de l'agenda. |
set | Calendar | Définit la description d'un agenda. |
set | Calendar | Indique si l'agenda est visible dans l'interface utilisateur. |
set | Calendar | Définit le nom de l'agenda. |
set | Calendar | Indique si les événements de l'agenda s'affichent dans l'interface utilisateur. |
set | Calendar | Définit le fuseau horaire de l'agenda. |
unsubscribe | void | Désinscrit l'utilisateur d'un agenda. |
Documentation détaillée
create All Day Event(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. const 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
Calendar
: événement créé.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
create All Day Event(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. const 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. |
start | Date | Date de début de l'événement (seule la date est utilisée, l'heure est ignorée). |
end | Date | Date de fin de l'événement (seule la date est utilisée, l'heure est ignorée). La date de fin est exclusive. |
Renvois
Calendar
: événement créé.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
create All Day Event(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. const 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. |
start | Date | Date de début de l'événement (seule la date est utilisée, l'heure est ignorée). |
end | Date | Date de fin de l'événement (seule la date 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 à ajouter en tant qu'invités, séparées par une virgule. |
send | Boolean | Indique si des e-mails d'invitation doivent être envoyés (valeur par défaut: false ). |
Renvois
Calendar
: événement créé.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
create All Day Event(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. const 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 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 à ajouter en tant qu'invités, séparées par une virgule. |
send | Boolean | Indique si des e-mails d'invitation doivent être envoyés (valeur par défaut: false ). |
Renvois
Calendar
: événement créé.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
create All Day Event Series(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. const 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 | le titre des événements de la série ; |
start | Date | la date du premier événement de la série (seul le jour est utilisé, l'heure est ignorée) |
recurrence | Event | les paramètres de récurrence de la série d'événements ; |
Renvois
Calendar
: série d'événements créée
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
create All Day Event Series(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. const 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 | le titre des événements de la série ; |
start | Date | la date du premier événement de la série (seul le jour est utilisé, l'heure est ignorée) |
recurrence | Event | 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 | l'emplacement 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 |
send | Boolean | si vous souhaitez envoyer des e-mails d'invitation (par défaut: false ) |
Renvois
Calendar
: série d'événements créée
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
create Event(title, startTime, endTime)
Crée un événement.
Si aucun fuseau horaire n'est spécifié, les valeurs temporelles sont interprétées dans le contexte du fuseau horaire du script, qui peut être différent du fuseau horaire du calendrier.
// Creates an event for the moon landing and logs the ID. const 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 ; |
start | Date | la date et l'heure de début de l'événement ; |
end | Date | la date et l'heure de fin de l'événement ; |
Renvois
Calendar
: événement créé
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
create Event(title, startTime, endTime, options)
Crée un événement.
Si aucun fuseau horaire n'est spécifié, les valeurs temporelles sont interprétées dans le contexte du fuseau horaire du script, qui peut être différent du fuseau horaire du calendrier.
// Creates an event for the moon landing and logs the ID. const 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 ; |
start | Date | la date et l'heure de début de l'événement ; |
end | 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 | la description de l'événement ; |
location | String | le lieu de l'événement ; |
guests | String | une liste d'adresses e-mail à ajouter en tant qu'invités, séparées par une virgule |
send | Boolean | si vous souhaitez envoyer des e-mails d'invitation (par défaut: false ) |
Renvois
Calendar
: événement créé
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
create Event From Description(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'UI.
// Creates a new event and logs its ID. const 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
Calendar
: événement créé
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
create Event Series(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. const 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 | le titre des événements de la série ; |
start | Date | la date et l'heure de début du premier événement de la série ; |
end | Date | Date et heure de fin du premier événement de la série |
recurrence | Event | les paramètres de récurrence de la série d'événements ; |
Renvois
Calendar
: série d'événements créée
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
create Event Series(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. const 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 | le titre des événements de la série ; |
start | Date | la date et l'heure de début du premier événement de la série ; |
end | Date | Date et heure de fin du premier événement de la série |
recurrence | Event | 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 | l'emplacement 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 |
send | Boolean | si vous souhaitez envoyer des e-mails d'invitation (par défaut: false ) |
Renvois
Calendar
: série d'événements créée
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
delete Calendar()
Supprime définitivement l'agenda. Un utilisateur ne peut supprimer qu'un agenda qui lui appartient.
// 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 avec l'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
get Color()
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 l'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
get Description()
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 ce calendrier.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
get Event By Id(iCalId)
Récupère l'événement associé à l'ID donné. Si la série appartient à un autre agenda que l'agenda par défaut, cette méthode doit être appelée à partir de cet agenda. L'appel de Calendar
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
Calendar
: événement associé à 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 l'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
get Event Series By Id(iCalId)
Récupère la série d'événements associée à l'ID donné. Si l'ID indiqué correspond à un seul Calendar
, un Calendar
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ée à partir de cet Calendar
. Appeler Calendar
directement ne renvoie 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
Calendar
: 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 l'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
get Events(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, se terminent ou englobent la période donnée. Si aucun fuseau horaire n'est spécifié, les valeurs temporelles sont interprétées dans le contexte du fuseau horaire du script, qui peut être différent du fuseau horaire du calendrier.
// Determines how many events are happening in the next two hours. const now = new Date(); const twoHoursFromNow = new Date(now.getTime() + 2 * 60 * 60 * 1000); const events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow); Logger.log(`Number of events: ${events.length}`);
Paramètres
Nom | Type | Description |
---|---|---|
start | Date | le début de la période ; |
end | Date | la fin de la période (non incluse) ; |
Renvois
Calendar
: événements qui se produisent pendant la période
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
get Events(startTime, endTime, options)
Récupère tous les événements qui se produisent au cours d'une période donnée et qui répondent aux critères spécifiés.
Cette méthode renvoie les événements qui commencent, se terminent ou couvrent la période donnée. Si aucun fuseau horaire n'est spécifié, les valeurs temporelles sont interprétées dans le contexte du fuseau horaire du script, qui peut être différent du fuseau horaire du calendrier.
Notez que le filtrage sur author
, search
ou status
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". const now = new Date(); const twoHoursFromNow = new Date(now.getTime() + 2 * 60 * 60 * 1000); const events = CalendarApp.getDefaultCalendar().getEvents( now, twoHoursFromNow, {search: 'meeting'}, ); Logger.log(`Number of events: ${events.length}`);
Paramètres
Nom | Type | Description |
---|---|---|
start | Date | le début de la période ; |
end | Date | la fin de la période (non incluse) ; |
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 à renvoyer |
author | String | une adresse e-mail utilisée pour filtrer les résultats par créateur de l'événement ; |
search | String | une requête de recherche en texte intégral utilisée pour filtrer les résultats |
status | Guest | Tableau d'états utilisés pour filtrer les résultats |
Renvois
Calendar
: é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 l'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
get Events For Day(date)
Récupère tous les événements qui se produisent un jour donné.
Cette méthode renvoie les événements s'ils commencent, se terminent ou couvrent le jour donné.
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 à minuit le jour suivant dans le fuseau horaire du calendrier.
// Determines how many events are happening today. const today = new Date(); const events = CalendarApp.getDefaultCalendar().getEventsForDay(today); Logger.log(`Number of events: ${events.length}`);
Paramètres
Nom | Type | Description |
---|---|---|
date | Date | la date pour laquelle vous souhaitez récupérer les événements (seul le jour est utilisé, l'heure est ignorée) |
Renvois
Calendar
: événements qui se produisent à la date donnée
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
get Events For Day(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 les événements s'ils commencent, se terminent ou couvrent le jour donné.
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 à minuit le jour suivant dans le fuseau horaire du calendrier.
Notez que le filtrage sur author
, search
ou status
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". const today = new Date(); const 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 vous souhaitez récupérer les événements (seule la date 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 à renvoyer |
author | String | une adresse e-mail utilisée pour filtrer les résultats par créateur de l'événement ; |
search | String | une requête de recherche en texte intégral utilisée pour filtrer les résultats |
status | Guest | Tableau d'états utilisés pour filtrer les résultats |
Renvois
Calendar
: é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 l'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
get Id()
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 avec l'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
get Name()
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 l'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
get Time Zone()
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, "Amérique/New_York", comme indiqué sur Joda.org).
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
is Hidden()
Indique 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
si ce n'est pas le cas.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
is My Primary Calendar()
Indique 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 l'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
is Owned By Me()
Indique 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 vous êtes le propriétaire de l'agenda, false
sinon.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
is Selected()
Détermine si les événements de l'agenda s'affichent 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 s'affichent dans l'interface utilisateur, false
sinon
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
set Color(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 | Calendar ou une chaîne de couleur hexadécimale ("#rrggbb"). |
Renvois
Calendar
: cet agenda pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
set Description(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 avec l'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
set Hidden(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 |
Renvois
Calendar
: cet agenda pour le chaînage
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
set Name(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 avec l'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
set Selected(selected)
Indique si les événements de l'agenda s'affichent 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 avec l'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
set Time Zone(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 |
---|---|---|
time | String | Fuseau horaire, spécifié au format "long" (par exemple, "America/New_York", comme indiqué sur Joda.org). |
Renvois
Calendar
: cet agenda pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
unsubscribe From Calendar()
Désinscrit l'utilisateur d'un agenda. Un utilisateur ne peut pas se désabonner des agendas listés dans la section Mes agendas. Ils peuvent se désabonner des agendas listé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 avec l'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