Représente un seul événement d'agenda.
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
add | Calendar | Ajoute un rappel par e-mail à l'événement. |
add | Calendar | Ajoute un invité à l'événement. |
add | Calendar | Ajoute une notification pop-up à l'événement. |
add | Calendar | Ajoute un rappel par SMS à l'événement. |
anyone | Boolean | Détermine si les utilisateurs peuvent s'ajouter en tant qu'invités à un événement Agenda. |
delete | void | Supprime un événement d'agenda. |
delete | Calendar | Supprime une balise clé-valeur de l'événement. |
get | Date | Récupère la date de fin de cet événement d'agenda d'une journée entière. |
get | Date | Récupère la date de début de cet événement d'agenda d'une journée. |
get | String[] | Récupère toutes les clés des balises qui ont été définies sur l'événement. |
get | String | Renvoie la couleur de l'événement d'agenda. |
get | String[] | Récupère les créateurs d'un événement. |
get | Date | Récupère la date de création de l'événement. |
get | String | Récupère la description de l'événement. |
get | Integer[] | Récupère les valeurs de minutes pour tous les rappels par e-mail de l'événement. |
get | Date | Récupère la date et l'heure de fin de cet événement d'agenda. |
get | Calendar | Récupère la série d'événements périodiques à laquelle cet événement appartient. |
get | Event | Récupère le Event de cet événement. |
get | Event | Récupère un invité par adresse e-mail. |
get | Event | Récupère les invités de l'événement, à l'exception du propriétaire de l'événement. |
get | Event | Récupère les invités de l'événement, y compris éventuellement les propriétaires de l'événement. |
get | String | Récupère l'iCalUID unique de l'événement. |
get | Date | Récupère la date de la dernière mise à jour de l'événement. |
get | String | Récupère le lieu de l'événement. |
get | Guest | Récupère l'état de l'événement (par exemple, "présent" ou "invité") de l'utilisateur effectif. |
get | String | Obtenez l'ID de l'agenda dans lequel cet événement a été créé à l'origine. |
get | Integer[] | Récupère les valeurs de minutes pour tous les rappels pop-up de l'événement. |
get | Integer[] | Récupère les valeurs de minutes pour tous les rappels par SMS de l'événement. |
get | Date | Récupère la date et l'heure de début de cet événement d'agenda. |
get | String | Récupère la valeur d'un tag de l'événement. |
get | String | Récupère le titre de l'événement. |
get | Event | Récupère la transparence de l'événement. |
get | Visibility | Récupère la visibilité de l'événement. |
guests | Boolean | Indique si les invités peuvent inviter d'autres personnes. |
guests | Boolean | Détermine si les invités peuvent modifier l'événement. |
guests | Boolean | Détermine si les invités peuvent voir les autres invités. |
is | Boolean | Indique si l'événement dure toute la journée. |
is | Boolean | Indique si vous êtes le propriétaire de l'événement. |
is | Boolean | Indique si l'événement fait partie d'une série d'événements. |
remove | Calendar | Supprime tous les rappels de l'événement. |
remove | Calendar | Supprime un invité de l'événement. |
reset | Calendar | Réinitialise les rappels en utilisant les paramètres par défaut de l'agenda. |
set | Calendar | Définit la date de l'événement. |
set | Calendar | Définit les dates de l'événement. |
set | Calendar | Indique si les personnes qui ne sont pas invitées peuvent s'ajouter à l'événement. |
set | Calendar | Définit la couleur de l'événement d'agenda. |
set | Calendar | Définit la description de l'événement. |
set | Calendar | Indique si les invités peuvent inviter d'autres personnes. |
set | Calendar | Indique si les invités peuvent modifier l'événement. |
set | Calendar | Détermine si les invités peuvent voir les autres invités. |
set | Calendar | Définit l'emplacement de l'événement. |
set | Calendar | Définit l'état de l'événement (par exemple, "Participant" ou "Invité") de l'utilisateur effectif. |
set | Calendar | Définit une balise clé/valeur sur l'événement pour stocker des métadonnées personnalisées. |
set | Calendar | Définit les dates et heures de début et de fin de l'événement. |
set | Calendar | Définit le titre de l'événement. |
set | Calendar | Définit la transparence de l'événement. |
set | Calendar | Définit la visibilité de l'événement. |
Documentation détaillée
add Email Reminder(minutesBefore)
Ajoute un rappel par e-mail à l'événement. Le rappel doit être envoyé au moins cinq minutes avant l'événement et au plus quatre semaines (40 320 minutes) avant l'événement.
// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) // instead. // TODO(developer): Replace the string with the event ID that you want to get. const event = CalendarApp.getEventById('abc123456'); // Adds an email notification for 15 minutes before the event. event.addEmailReminder(15);
Paramètres
Nom | Type | Description |
---|---|---|
minutes | Integer | le nombre de minutes avant l'événement ; |
Renvois
Calendar
: Calendar
pour le chaînage
Génère
Error
: si l'événement comporte plus de cinq rappels ou si l'heure n'est pas comprise dans la plage légale
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
add Guest(email)
Ajoute un invité à l'événement.
// Example 1: Add a guest to one event function addAttendeeToEvent() { // Replace the below values with your own const attendeeEmail = 'user@example.com'; // Email address of the person you need to add const calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar containing // event const eventId = '123abc'; // ID of event instance const calendar = CalendarApp.getCalendarById(calendarId); if (calendar === null) { // Calendar not found console.log('Calendar not found', calendarId); return; } const event = calendar.getEventById(eventId); if (event === null) { // Event not found console.log('Event not found', eventId); return; } event.addGuest(attendeeEmail); } // Example 2: Add a guest to all events on a calendar within a specified // timeframe function addAttendeeToAllEvents() { // Replace the following values with your own const attendeeEmail = 'user@example.com'; // Email address of the person you need to add const calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar with the // events const startDate = new Date('YYYY-MM-DD'); // The first date to add the guest to the events const endDate = new Date('YYYY-MM-DD'); // The last date to add the guest to the events const calendar = CalendarApp.getCalendarById(calendarId); if (calendar === null) { // Calendar not found console.log('Calendar not found', calendarId); return; } // Get the events within the specified timeframe const calEvents = calendar.getEvents(startDate, endDate); console.log(calEvents.length); // Checks how many events are found // Loop through all events and add the attendee to each of them for (let i = 0; i < calEvents.length; i++) { const event = calEvents[i]; event.addGuest(attendeeEmail); } }
Paramètres
Nom | Type | Description |
---|---|---|
email | String | Adresse e-mail de l'invité. |
Renvois
Calendar
: Calendar
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
add Popup Reminder(minutesBefore)
Ajoute une notification pop-up à l'événement. La notification doit être envoyée au moins cinq minutes avant l'événement et au plus quatre semaines (40 320 minutes) avant l'événement.
// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) // instead. // TODO(developer): Replace the string with the event ID that you want to get. const event = CalendarApp.getEventById('abc123456'); // Adds a pop-up notification for 15 minutes before the event. event.addPopupReminder(15);
Paramètres
Nom | Type | Description |
---|---|---|
minutes | Integer | le nombre de minutes avant l'événement ; |
Renvois
Calendar
: Calendar
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
add Sms Reminder(minutesBefore)
Ajoute un rappel par SMS à l'événement. Le rappel doit être envoyé au moins cinq minutes avant l'événement et au plus quatre semaines (40 320 minutes) avant l'événement.
Paramètres
Nom | Type | Description |
---|---|---|
minutes | Integer | le nombre de minutes avant l'événement ; |
Renvois
Calendar
: Calendar
pour le chaînage
Génère
Error
: si l'événement comporte plus de cinq rappels ou si l'heure n'est pas comprise dans la plage légale
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
anyone Can Add Self()
Détermine si les utilisateurs peuvent s'ajouter en tant qu'invités à un événement Agenda.
// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) // instead. // TODO(developer): Replace the string with the event ID that you want to get. const event = CalendarApp.getEventById('abc123456'); // Determines whether people can add themselves as guests to the event and logs // it. console.log(event.anyoneCanAddSelf());
Renvois
Boolean
: true
si les personnes non invitées peuvent s'ajouter à l'événement, 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
delete Event()
Supprime un événement d'agenda.
// Gets an event by its ID. // TODO(developer): Replace the string with the ID of the event that you want to // delete. const event = CalendarApp.getEventById('abc123456'); // Deletes the event. event.deleteEvent();
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 Tag(key)
Supprime une balise clé-valeur de l'événement.
Paramètres
Nom | Type | Description |
---|---|---|
key | String | la clé de tag |
Renvois
Calendar
: Calendar
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
get All Day End Date()
Récupère la date de fin de cet événement d'agenda d'une journée entière. (S'il ne s'agit pas d'un événement d'une journée complète, cette méthode génère une exception.) L'Date
renvoyé représente minuit au début du jour suivant la fin de l'événement dans le fuseau horaire du script. Pour utiliser plutôt le fuseau horaire du calendrier, appelez get
.
// Gets the user's default calendar. To get a different calendar, // use getCalendarById() instead. const calendar = CalendarApp.getDefaultCalendar(); // Creates an event named 'My all-day event' for May 16, 2023. const event = calendar.createAllDayEvent( 'My all-day event', new Date('May 16, 2023'), ); // Gets the event's end date and logs it. const endDate = event.getAllDayEndDate(); console.log(endDate);
Renvois
Date
: date de fin de cet événement d'agenda d'une journée
Génère
Error
: si cet événement ne dure pas toute la journé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 All Day Start Date()
Récupère la date de début de cet événement d'agenda d'une journée. (S'il ne s'agit pas d'un événement d'une journée complète, cette méthode génère une exception.) L'Date
renvoyé représente minuit au début du jour au cours duquel l'événement commence dans le fuseau horaire du script. Pour utiliser plutôt le fuseau horaire du calendrier, appelez get
.
// Gets the user's default calendar. To get a different calendar, // use getCalendarById() instead. const calendar = CalendarApp.getDefaultCalendar(); // Creates an event named 'My all-day event' for May 16, 2023. const event = calendar.createAllDayEvent( 'My all-day event', new Date('May 16, 2023'), ); // Gets the event's start date and logs it. const startDate = event.getAllDayStartDate(); console.log(startDate);
Renvois
Date
: date de début de cet événement d'agenda qui dure toute la journée
Génère
Error
: si cet événement ne dure pas toute la journé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 All Tag Keys()
Récupère toutes les clés des balises qui ont été définies sur l'événement.
Renvois
String[]
: tableau de clés de chaîne
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 Color()
Renvoie la couleur de l'événement d'agenda.
// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) // instead. // TODO(developer): Replace the string with the event ID that you want to get. const event = CalendarApp.getEventById('abc123456'); // Gets the color of the calendar event and logs it. const eventColor = event.getColor(); console.log(eventColor);
Renvois
String
: représentation sous forme de chaîne de la couleur de l'événement, sous la forme d'un indice (1 à 11) des valeurs de Calendar
.
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 Creators()
Récupère les créateurs d'un événement.
// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) // instead. // TODO(developer): Replace the string with the event ID that you want to get. const event = CalendarApp.getEventById('abc123456'); // Gets a list of the creators of the event and logs it. console.log(event.getCreators());
Renvois
String[]
: adresses e-mail des créateurs de l'événement
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 Date Created()
Récupère la date de création de l'événement. Vous devez avoir accès à l'agenda.
// Opens the calendar by using its ID. // To get the user's default calendar use CalendarApp.getDefault() instead. // TODO(developer): Replace the calendar ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 1st, 2023 that takes // place between 8:10 AM and 4:25 PM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 01, 2023 08:10:00'), new Date('Feb 01, 2023 16:25:00'), )[0]; if (event) { // If an event exists within the given time frame, gets the date that the // event was created and logs it. const eventCreated = event.getDateCreated(); console.log(eventCreated); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Renvois
Date
: date de création
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'événement. Vous devez être autorisé à modifier l'agenda.
// Opens the calendar by its ID. // To get the user's default calendar use CalendarApp.getDefault() instead. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 4th, 2023 that takes // place between 4:00 PM and 5:00 PM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 04, 2023 16:00:00'), new Date('Feb 04, 2023 17:00:00'), )[0]; if (event) { // If an event exists within the given time frame, sets the description of the // event. event.setDescription('Important meeting'); // Gets the description of the event and logs it. const description = event.getDescription(); console.log(description); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Renvois
String
: description
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 Email Reminders()
Récupère les valeurs de minutes pour tous les rappels par e-mail de l'événement. Vous devez disposer d'un accès en modification au calendrier.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 4th, 2023 that takes // place between 5:00 PM and 6:00 PM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 04, 2023 15:00:00'), new Date('Feb 04, 2023 18:00:00'), )[0]; if (event) { // If an event exists within the given time frame, adds email reminders for // the user to be sent at 4 and 7 minutes before the event. event.addEmailReminder(4); event.addEmailReminder(7); // Gets the minute values for all email reminders that are set up for the user // for this event and logs it. const emailReminder = event.getEmailReminders(); console.log(emailReminder); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Renvois
Integer[]
: tableau dans lequel chaque valeur correspond au nombre de minutes avant l'événement déclenchant un rappel.
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 End Time()
Récupère la date et l'heure de fin de cet événement d'agenda. Vous devez avoir accès à l'agenda. Pour les événements qui ne durent pas toute la journée, il s'agit de l'instant auquel l'événement a été défini pour se terminer. Pour les événements d'une journée entière, qui ne stockent qu'une date de fin (et non une date et une heure), il s'agit de minuit au début du jour suivant la fin de l'événement dans le fuseau horaire de l'agenda. Cela permet de comparer de manière pertinente les heures de fin de tous les types d'événements. Toutefois, cela ne préserve pas nécessairement le jour de l'année d'origine sans modification.
Pour les événements de toute la journée, get
doit presque toujours être appelé de préférence à cette méthode.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 1st, 2023 that takes // place between 4:00 PM and 5:00 PM. const event = calendar.getEvents( new Date('Feb 01, 2023 16:00:00'), new Date('Feb 01, 2023 17:00:00'), )[0]; if (event) { // If an event exists within the given time frame, gets the date and time at // which the event ends and logs it. console.log(event.getEndTime()); } else { // If no event exists within the given time frame, logs that info to the // console. console.log('No events exist for the specified range'); }
Renvois
Date
: heure de fin de cet événement d'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 Event Series()
Récupère la série d'événements périodiques à laquelle cet événement appartient. Vous devez avoir accès à l'agenda. Un objet Calendar
est renvoyé même si cet événement n'appartient pas à une série, afin que vous puissiez ajouter de nouveaux paramètres de récurrence.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 18th, 2023 that takes // place between 1:00 PM and 2:00 PM. const event = calendar.getEvents( new Date('Feb 18, 2023 13:00:00'), new Date('Feb 18, 2023 14:00:00'), )[0]; if (event) { // If an event exists within the given time frame, gets the event series for // the event and sets the color to pale green. event.getEventSeries().setColor(CalendarApp.EventColor.PALE_GREEN); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Renvois
Calendar
: série d'événements à laquelle cet événement appartient, ou nouvelle série d'événements s'il n'en fait pas encore partie
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 Type()
Récupère le Event
de cet événement.
// Opens the default calendar and logs all out-of-office events for the current day. const calendar = CalendarApp.getDefaultCalendar(); const events = calendar.getEventsForDay(new Date()); console.log(events.filter(e => e.getEventType() === CalendarApp.EventType.OUT_OF_OFFICE));
Renvois
Event
: type d'événement.
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 Guest By Email(email)
Récupère un invité par adresse e-mail.
// Opens the calendar by its ID. You must have edit access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 25th, 2023 that takes // place between 5:00 PM and 5:25 PM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 25,2023 17:00:00'), new Date('Feb 25,2023 17:25:00'), )[0]; // Gets a guest by email address. const guestEmailId = event.getGuestByEmail('alex@example.com'); // If the email address corresponds to an event guest, logs the email address. if (guestEmailId) { console.log(guestEmailId.getEmail()); }
Paramètres
Nom | Type | Description |
---|---|---|
email | String | l'adresse du client |
Renvois
Event
: l'invité ou valeur nulle si l'adresse e-mail ne correspond pas à un invité
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 Guest List()
Récupère les invités de l'événement, à l'exception du propriétaire de l'événement.
// Opens the calendar by its ID. You must have edit access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 25th, 2023 that takes // place between 5:00 PM and 5:25 PM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 25,2023 17:00:00'), new Date('Feb 25,2023 17:25:00'), )[0]; // Adds two guests to the event by using their email addresses. event.addGuest('alex@example.com'); event.addGuest('cruz@example.com'); // Gets the guests list for the event. const guestList = event.getGuestList(); // Loops through the list to get all the guests and logs their email addresses. for (const guest of guestList) { console.log(guest.getEmail()); }
Renvois
Event
: tableau des invités
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 Guest List(includeOwner)
Récupère les invités de l'événement, y compris éventuellement les propriétaires de l'événement.
// Opens the calendar by its ID. You must have edit access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 25th, 2023 that takes // place between 5:00 PM and 5:25 PM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 25,2023 17:00:00'), new Date('Feb 25,2023 17:25:00'), )[0]; // Gets the guests list for the event, including the owner of the event. const guestList = event.getGuestList(true); // Loops through the list to get all the guests and logs it. for (const guest of guestList) { console.log(guest.getEmail()); }
Paramètres
Nom | Type | Description |
---|---|---|
include | Boolean | si les propriétaires doivent être inclus en tant qu'invités |
Renvois
Event
: tableau des invités
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'iCalUID unique de l'événement. Notez que l'iCalUID et l'événement id
utilisés par l'API Agenda v3 et le service avancé Agenda ne sont pas identiques et ne peuvent pas être utilisés de manière interchangeable. Une différence dans leur sémantique est que, dans les événements récurrents, toutes les occurrences d'un événement ont des ids
différents, mais qu'elles partagent toutes les mêmes iCalUID.
// Opens the calendar by its ID. You must have edit access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for January 5th, 2023 that takes place // between 9:00 AM and 9:25 AM. // For an event series, use calendar.getEventSeriesById('abc123456@google.com'); // and replace the series ID with your own. const event = calendar.getEvents( new Date('Jan 05, 2023 09:00:00'), new Date('Jan 05, 2023 09:25:00'), )[0]; // Gets the ID of the event and logs it. console.log(event.getId());
Renvois
String
: iCalUID de l'événement
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 Last Updated()
Récupère la date de la dernière mise à jour de l'événement.
// Opens the calendar by its ID. You must have view access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 1st, 2023 that takes // place between 4:00 PM and 5:00 PM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 01, 2023 16:00:00'), new Date('Feb 01, 2023 17:00:00'), )[0]; // Gets the date the event was last updated and logs it. const eventUpdatedDate = event.getLastUpdated(); console.log(eventUpdatedDate);
Renvois
Date
: date de la dernière mise à jour
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 Location()
Récupère le lieu de l'événement.
// Opens the calendar by its ID. You must have edit access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 1st, 2023 that takes // place between 4:10 PM and 4:25 PM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'), )[0]; if (event) { // If an event exists within the given time frame, sets the location of the // event to Mumbai. event.setLocation('Mumbai'); // Gets the location of the event and logs it. const eventLocation = event.getLocation(); console.log(eventLocation); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Renvois
String
: lieu de l'événement
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 My Status()
Récupère l'état de l'événement (par exemple, "présent" ou "invité") de l'utilisateur effectif. Renvoie toujours Guest
si l'utilisateur effectif est le propriétaire de l'événement.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.', ); // Gets the first event from the calendar for February 1st, 2023 that takes // place between 4:10 PM and 4:25 PM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'), )[0]; if (event) { // If an event exists within the given time frame, gets the event status of // the effective user and logs it. const myStatus = event.getMyStatus(); console.log(myStatus.toString()); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Renvois
Guest
: état
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 Original Calendar Id()
Obtenez l'ID de l'agenda dans lequel cet événement a été créé à l'origine.
// Opens the calendar by its ID. You must have edit access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 25th, 2023 that takes // place between 4:00 PM and 4:25 PM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 25,2023 16:00:00'), new Date('Feb 25,2023 16:25:00'), )[0]; if (event) { // If an event exists within the given time frame, gets the ID of the calendar // where the event was originally created and logs it. const calendarId = event.getOriginalCalendarId(); console.log(calendarId); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Renvois
String
: ID de l'agenda d'origine
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 Popup Reminders()
Récupère les valeurs de minutes pour tous les rappels pop-up de l'événement.
// Opens the calendar by its ID. You must have edit access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 4th, 2023 that takes // place between 5:05 PM and 5:35 PM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 04, 2023 17:05:00'), new Date('Feb 04, 2023 17:35:00'), )[0]; if (event) { // If an event exists within the given time frame, adds two pop-up reminders // to the event. The first reminder pops up 5 minutes before the event starts // and the second reminder pops up 3 minutes before the event starts. event.addPopupReminder(3); event.addPopupReminder(5); // Gets the minute values for all pop-up reminders for the event and logs it. const popUpReminder = event.getPopupReminders(); console.log(popUpReminder); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Renvois
Integer[]
: tableau dans lequel chaque valeur correspond au nombre de minutes avant l'événement déclenchant un rappel.
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 Sms Reminders()
Récupère les valeurs de minutes pour tous les rappels par SMS de l'événement.
Renvois
Integer[]
: tableau dans lequel chaque valeur correspond au nombre de minutes avant l'événement déclenchant un rappel.
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 Start Time()
Récupère la date et l'heure de début de cet événement d'agenda. Pour les événements qui ne durent pas toute la journée, il s'agit de l'instant auquel l'événement a été défini pour commencer. Pour les événements d'une journée entière, qui ne stockent qu'une date de début (et non une date et une heure), il s'agit de minuit au début du jour où l'événement commence dans le fuseau horaire de l'agenda. Cela permet de comparer de manière pertinente les heures de début de tous les types d'événements. Toutefois, cela ne préserve pas nécessairement le jour de l'année d'origine sans modification.
Pour les événements de toute la journée, get
doit presque toujours être appelé de préférence à cette méthode.
// Opens the calendar by its ID. You must have edit access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 1st, 2023 that takes // place between 4:10 PM and 4:25 PM. const event = calendar.getEvents( new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'), )[0]; // Gets the date and time at which this calendar event begins and logs it. const startTime = event.getStartTime(); console.log(startTime);
Renvois
Date
: heure de début de cet événement d'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 Tag(key)
Récupère la valeur d'un tag de l'événement.
Paramètres
Nom | Type | Description |
---|---|---|
key | String | la clé |
Renvois
String
: valeur du tag
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 Title()
Récupère le titre de l'événement.
// Opens the calendar by its ID. You must have edit access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for January 31st, 2023 that takes // place between 9:05 AM and 9:15 AM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Jan 31, 2023 09:05:00'), new Date('Jan 31, 2023 09:15:00'), )[0]; if (event) { // If an event exists within the given time frame, logs the title of the // event. console.log(event.getTitle()); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Renvois
String
: titre
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 Transparency()
Récupère la transparence de l'événement. Utilisez cette méthode pour déterminer si un événement est TRANSPARENT
, ce qui signifie que l'agenda indique "Disponible" pendant cette période, ou OPAQUE
, ce qui signifie que l'agenda indique "Occupé" pendant cette période.
// Gets the first event from the default calendar for today. const today = new Date(); const event = CalendarApp.getDefaultCalendar().getEventsForDay(today)[0]; // Gets the event's transparency and logs it. const transparency = event.getTransparency(); Logger.log(transparency);
Renvois
Event
: valeur de transparence.
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 Visibility()
Récupère la visibilité de l'événement.
// Opens the calendar by its ID. You must have edit access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 1st, 2023 that takes // place between 4:10 PM and 4:25 PM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'), )[0]; if (event) { // If an event exists within the given time frame, gets the visibility of the // event and logs it. const eventVisibility = event.getVisibility(); console.log(eventVisibility.toString()); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Renvois
Visibility
: valeur de visibilité
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
guests Can Invite Others()
Indique si les invités peuvent inviter d'autres personnes.
// Opens the calendar by its ID. You must have view access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 1st, 2023 that takes // place between 9:35 AM and 9:40 AM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 01, 2023 09:35:00'), new Date('Feb 01, 2023 09:40:00'), )[0]; if (event) { // If an event exists within the given time frame, determines whether guests // can invite other guests and logs it. console.log(event.guestsCanInviteOthers()); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Renvois
Boolean
: true
si les invités peuvent inviter d'autres personnes, 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
guests Can Modify()
Détermine si les invités peuvent modifier l'événement.
// Opens the calendar by its ID. You must have edit access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 1st, 2023 that takes // place between 9:35 AM and 9:40 AM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 01, 2023 09:35:00'), new Date('Feb 01, 2023 09:40:00'), )[0]; if (event) { // If an event exists within the given time frame, sets the event so that // guests can't modify it. event.setGuestsCanModify(false); // Determines whether guests can modify the event and logs it. console.log(event.guestsCanModify()); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Renvois
Boolean
: true
si les invités peuvent modifier l'événement, 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
guests Can See Guests()
Détermine si les invités peuvent voir les autres invités.
// Opens the calendar by its ID. You must have view access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 1st, 2023 that takes // place between 9:35 AM and 9:40 AM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 01, 2023 09:35:00'), new Date('Feb 01, 2023 09:40:00'), )[0]; if (event) { // If an event exists within the given time frame, determines whether guests // can see other guests and logs it. console.log(event.guestsCanSeeGuests()); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Renvois
Boolean
: true
si les invités peuvent voir les autres invités, 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 All Day Event()
Indique si l'événement dure toute la journée.
// Opens the calendar by its ID. You must have view access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for January 31st, 2023 that takes // place between 9:05 AM and 9:15 AM. const event = calendar.getEvents( new Date('Jan 31, 2023 09:05:00'), new Date('Jan 31, 2023 09:15:00'), )[0]; // Determines whether this event is an all-day event and logs it. console.log(event.isAllDayEvent());
Renvois
Boolean
: true
si l'événement dure toute la journée, false
dans le cas contraire
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 vous êtes le propriétaire de l'événement.
// Opens the calendar by its ID. You must have view access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for January 31st, 2023 that takes // place between 9:05 AM and 9:15 AM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Jan 31, 2023 09:05:00'), new Date('Jan 31, 2023 09:15:00'), )[0]; if (event) { // If an event exists within the given time frame, determines whether you're // the owner of the event and logs it. console.log(event.isOwnedByMe()); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Renvois
Boolean
: true
si l'événement appartient à l'utilisateur effectif, 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 Recurring Event()
Indique si l'événement fait partie d'une série d'événements.
// Opens the calendar by its ID. You must have view access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for Januart 31st, 2023 that takes // place between 9:00 AM and 10:00 AM. const event = calendar.getEvents( new Date('Jan 31, 2023 09:00:00'), new Date('Jan 31, 2023 10:00:00'), )[0]; if (event) { // If an event exists within the given time frame, determines whether the // event is part of an event series and logs it. console.log(event.isRecurringEvent()); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Renvois
Boolean
: true
si l'événement fait partie d'une série d'événements, 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
remove All Reminders()
Supprime tous les rappels de l'événement.
// Opens the calendar by its ID. You must have edit access to the calendar // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 1st, 2023 that takes // place between 4:10 PM and 4:25 PM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 1,2023 16:10:00'), new Date('Feb 1,2023 16:25:00'), )[0]; if (event) { // If an event exists within the given time frame, removes all reminders from // the event. event.removeAllReminders(); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Renvois
Calendar
: Calendar
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
remove Guest(email)
Supprime un invité de l'événement.
// Example 1: Remove a guest from one event function removeGuestFromEvent() { // Replace the below values with your own const attendeeEmail = 'user@example.com'; // Email address of the person you need to remove const calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar containing // event const eventId = '123abc'; // ID of event instance const calendar = CalendarApp.getCalendarById(calendarId); if (calendar === null) { // Calendar not found console.log('Calendar not found', calendarId); return; } const event = calendar.getEventById(eventId); if (event === null) { // Event not found console.log('Event not found', eventId); return; } event.removeGuest(attendeeEmail); } // Example 2: Remove a guest from all events on a calendar within a specified // timeframe function removeGuestFromAllEvents() { // Replace the following values with your own const attendeeEmail = 'user@example.com'; // Email address of the person you need to remove const calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar with the // events const startDate = new Date( 'YYYY-MM-DD'); // The first date to remove the guest from the events const endDate = new Date( 'YYYY-MM-DD'); // The last date to remove the attendee from the events const calendar = CalendarApp.getCalendarById(calendarId); if (calendar === null) { // Calendar not found console.log('Calendar not found', calendarId); return; } // Get the events within the specified timeframe const calEvents = calendar.getEvents(startDate, endDate); console.log(calEvents.length); // Checks how many events are found // Loop through all events and remove the attendee from each of them for (let i = 0; i < calEvents.length; i++) { const event = calEvents[i]; event.removeGuest(attendeeEmail); } }
Paramètres
Nom | Type | Description |
---|---|---|
email | String | l'adresse e-mail de l'invité ; |
Renvois
Calendar
: Calendar
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
reset Reminders To Default()
Réinitialise les rappels en utilisant les paramètres par défaut de l'agenda.
// Opens the calendar by its ID. You must have edit access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 1st, 2023 that takes // place between 4:10 PM and 4:25 PM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 1, 2023 16:10:00'), new Date('Feb 1, 2023 16:25:00'), )[0]; if (event) { // If an event exists within the given time frame, resets the reminders using // the calendar's default settings. event.resetRemindersToDefault(); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Renvois
Calendar
: Calendar
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 All Day Date(date)
Définit la date de l'événement. Cette méthode transforme un événement régulier en événement d'une journée entière.
// Opens the calendar by its ID. You must have edit access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 17th, 2023 that takes // place between 4:00 PM and 5:00 PM. const event = calendar.getEvents( new Date('Feb 17, 2023 16:00:00'), new Date('Feb 17, 2023 17:00:00'), )[0]; if (event) { // If an event exists within the given time frame, sets the date of the event // and updates it to an all-day event. event.setAllDayDate(new Date('Feb 17, 2023')); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Paramètres
Nom | Type | Description |
---|---|---|
date | Date | la date de l'événement (l'heure est ignorée) ; |
Renvois
Calendar
: cet événement d'agenda pour la concaténation
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 All Day Dates(startDate, endDate)
Définit les dates de l'événement. L'application de cette méthode transforme un événement régulier en événement de toute la journée.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 18th, 2023 that takes // place between 4:00 PM and 5:00 PM. const event = calendar.getEvents( new Date('Feb 18, 2023 16:00:00'), new Date('Feb 18, 2023 17:00:00'), )[0]; if (event) { // If an event exists within the given time frame, sets the event to be an // all-day event from Feb 18th, 2023 until Feb 25th, 2023. Applying this // method changes a regular event into an all-day event. event.setAllDayDates(new Date('Feb 18, 2023'), new Date('Feb 25, 2023')); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Paramètres
Nom | Type | Description |
---|---|---|
start | Date | la date de début de l'événement (l'heure est ignorée) ; |
end | Date | la date de fin de l'événement (l'heure est ignorée) ; |
Renvois
Calendar
: cet événement d'agenda pour la concaténation
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 Anyone Can Add Self(anyoneCanAddSelf)
Indique si les personnes qui ne sont pas invitées peuvent s'ajouter à l'événement.
// Opens the calendar by its ID. You must have edit access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 15th, 2023 that takes // place between 3:30 PM and 4:30 PM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 15, 2023 15:30:00'), new Date('Feb 15, 2023 16:30:00'), )[0]; if (event) { // If an event exists within the given time frame, sets the event so that // non-guests can't add themselves to the event. event.setAnyoneCanAddSelf(false); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Paramètres
Nom | Type | Description |
---|---|---|
anyone | Boolean | si quelqu'un peut s'inviter lui-même |
Renvois
Calendar
: Calendar
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 Color(color)
Définit la couleur de l'événement d'agenda.
// Opens the calendar by its ID. You must have edit access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 1st, 2023 that takes // place between 4:10 PM and 4:25 PM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'), )[0]; if (event) { // If an event exists within the given time frame, sets the color of the // calendar event to green. event.setColor(CalendarApp.EventColor.GREEN); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Paramètres
Nom | Type | Description |
---|---|---|
color | String | Indice de couleur entier sous forme de chaîne ou valeur de Calendar . |
Renvois
Calendar
: cet événement d'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 de l'événement.
// Opens the calendar by its ID. You must have edit access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 4th, 2023 that takes // place between 5:05 PM and 5:35 PM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 04, 2023 17:05:00'), new Date('Feb 04, 2023 17:35:00'), )[0]; if (event) { // If an event exists within the given time frame, sets the description of the // event to 'Meeting.' event.setDescription('Meeting'); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Paramètres
Nom | Type | Description |
---|---|---|
description | String | la nouvelle description |
Renvois
Calendar
: Calendar
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 Guests Can Invite Others(guestsCanInviteOthers)
Indique si les invités peuvent inviter d'autres personnes.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. You must have edit access to // the calendar. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 1st, 2023 that takes // place between 9:35 AM and 9:40 AM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 01, 2023 09:35:00'), new Date('Feb 01, 2023 09:40:00'), )[0]; if (event) { // If an event exists within the given time frame, sets the event so that // guests can invite other guests. event.setGuestsCanInviteOthers(true); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Paramètres
Nom | Type | Description |
---|---|---|
guests | Boolean | si les invités peuvent inviter d'autres personnes ; |
Renvois
Calendar
: Calendar
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 Guests Can Modify(guestsCanModify)
Indique si les invités peuvent modifier l'événement.
Paramètres
Nom | Type | Description |
---|---|---|
guests | Boolean | si les invités peuvent modifier l'événement |
Renvois
Calendar
: Calendar
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 Guests Can See Guests(guestsCanSeeGuests)
Détermine si les invités peuvent voir les autres invités.
Paramètres
Nom | Type | Description |
---|---|---|
guests | Boolean | si les invités peuvent voir les autres |
Renvois
Calendar
: Calendar
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 Location(location)
Définit l'emplacement de l'événement.
// Opens the calendar by its ID. You must have edit access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 1st, 2023 that takes // place between 4:10 PM and 4:25 PM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'), )[0]; if (event) { // If an event exists within the given time frame, sets the location of the // event to Noida. event.setLocation('Noida'); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Paramètres
Nom | Type | Description |
---|---|---|
location | String | le nouvel emplacement |
Renvois
Calendar
: Calendar
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 My Status(status)
Définit l'état de l'événement (par exemple, "Participant" ou "Invité") de l'utilisateur effectif.
// Opens the calendar by its ID. You must have edit access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for February 1st, 2023 that takes // place between 4:10 PM and 4:25 PM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'), )[0]; if (event) { // If an event exists within the given time frame, sets the event status for // the current user to maybe. event.setMyStatus(CalendarApp.GuestStatus.MAYBE); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Paramètres
Nom | Type | Description |
---|---|---|
status | Guest | le nouvel état |
Renvois
Calendar
: Calendar
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.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
set Tag(key, value)
Définit une balise clé/valeur sur l'événement pour stocker des métadonnées personnalisées.
Paramètres
Nom | Type | Description |
---|---|---|
key | String | la clé de tag |
value | String | la valeur du tag |
Renvois
Calendar
: Calendar
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(startTime, endTime)
Définit les dates et heures de début et de fin de l'événement. Cette méthode transforme un événement de la journée en événement normal.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Declares a start time of 11:00 AM on February 20th, 2023 and an end time of // 12:00 PM on February 20th, 2023. const startTime = new Date('Feb 20,2023 11:00:00'); const endTime = new Date('Feb 20, 2023 12:00:00'); // Creates an all-day event on February 20th, 2023. const event = calendar.createAllDayEvent('Meeting', new Date('Feb 20,2023')); // Updates the all-day event to a regular event by setting a start and end time // for the event. event.setTime(startTime, endTime);
Paramètres
Nom | Type | Description |
---|---|---|
start | Date | le nouveau début de l'événement |
end | Date | la nouvelle date de fin de l'événement ; |
Renvois
Calendar
: cet événement d'agenda pour la concaténation
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 Title(title)
Définit le titre de l'événement.
// Opens the calendar by its ID. You must have edit access to the calendar. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Gets the first event from the calendar for January 31st, 2023 that takes // place between 9:05 AM and 9:15 AM. For an event series, use // calendar.getEventSeriesById('abc123456@google.com'); and replace the series // ID with your own. const event = calendar.getEvents( new Date('Jan 31, 2023 09:05:00'), new Date('Jan 31, 2023 09:15:00'), )[0]; if (event) { // If an event exists within the given time frame, changes its title to // Event1. event.setTitle('Event1'); } else { // If no event exists within the given time frame, logs that information to // the console. console.log('No events exist for the specified range'); }
Paramètres
Nom | Type | Description |
---|---|---|
title | String | le nouveau titre |
Renvois
Calendar
: Calendar
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 Transparency(transparency)
Définit la transparence de l'événement. Utilisez cette méthode pour définir si un événement est TRANSPARENT
, meaning the calendar shows as Available during that time, or
OPAQUE
,
meaning the calendar shows as Busy during that time.
// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId)
// instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');
// Sets the event's transparency to TRANSPARENT.
event.setTransparency(CalendarApp.EventTransparency.TRANSPARENT);
Parameters
Name Type Description
transparency
Event Transparency
The transparency value.
Return
Calendar Event
— This Calendar Event
for chaining.
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
set Visibility(visibility)
Sets the visibility of the event.
Parameters
Name Type Description
visibility
Visibility
Return
Calendar Event
— this Calendar Event
for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds