Stellt einen einzelnen Kalendertermin dar.
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addEmailReminder(minutesBefore) | CalendarEvent | Dem Ereignis wird eine neue E-Mail-Erinnerung hinzugefügt. |
addGuest(email) | CalendarEvent | Dem Termin wird ein Gast hinzugefügt. |
addPopupReminder(minutesBefore) | CalendarEvent | Dem Ereignis wird eine neue Pop-up-Benachrichtigung hinzugefügt. |
addSmsReminder(minutesBefore) | CalendarEvent | Dem Ereignis wird eine neue SMS-Erinnerung hinzugefügt. |
anyoneCanAddSelf() | Boolean | Bestimmt, ob sich Personen einem Kalendertermin als Gäste hinzufügen können. |
deleteEvent() | void | Löscht einen Kalendertermin. |
deleteTag(key) | CalendarEvent | Löscht ein Schlüssel/Wert-Tag aus dem Ereignis. |
getAllDayEndDate() | Date | Das Datum, an dem dieser ganztägige Kalendertermin endet. |
getAllDayStartDate() | Date | Das Datum, an dem dieser ganztägige Kalendertermin beginnt. |
getAllTagKeys() | String[] | Hier werden alle Schlüssel für Tags abgerufen, die für das Ereignis festgelegt wurden. |
getColor() | String | Gibt die Farbe des Termins zurück. |
getCreators() | String[] | Ruft die Ersteller eines Ereignisses ab. |
getDateCreated() | Date | Das Datum, an dem das Ereignis erstellt wurde. |
getDescription() | String | Ruft die Beschreibung des Ereignisses ab. |
getEmailReminders() | Integer[] | Die Minutenwerte für alle E-Mail-Erinnerungen für das Ereignis. |
getEndTime() | Date | Das Datum und die Uhrzeit, an dem dieses Kalenderereignis endet. |
getEventSeries() | CalendarEventSeries | Die Reihe der wiederkehrenden Ereignisse, zu denen dieses Ereignis gehört. |
getEventType() | EventType | Ruft den EventType dieses Ereignisses ab. |
getGuestByEmail(email) | EventGuest | Ruft einen Gast anhand seiner E-Mail-Adresse ab. |
getGuestList() | EventGuest[] | Ruft die Gäste für die Veranstaltung ab, ausgenommen den Eigentümer der Veranstaltung. |
getGuestList(includeOwner) | EventGuest[] | Ruft die Gäste für die Veranstaltung ab, möglicherweise einschließlich der Eigentümer der Veranstaltung. |
getId() | String | Die eindeutige iCalUID des Ereignisses wird abgerufen. |
getLastUpdated() | Date | Das Datum, an dem das Ereignis zuletzt aktualisiert wurde. |
getLocation() | String | Der Ort der Veranstaltung. |
getMyStatus() | GuestStatus | Ruft den Ereignisstatus des effektiven Nutzers ab, z. B. „Teilnehmend“ oder „Eingeladen“. |
getOriginalCalendarId() | String | Rufen Sie die ID des Kalenders ab, in dem dieses Ereignis ursprünglich erstellt wurde. |
getPopupReminders() | Integer[] | Die Minutenwerte für alle Pop-up-Erinnerungen für das Ereignis werden abgerufen. |
getSmsReminders() | Integer[] | Die Minutenwerte für alle SMS-Erinnerungen für das Ereignis werden abgerufen. |
getStartTime() | Date | Das Datum und die Uhrzeit, zu der dieser Kalendertermin beginnt. |
getTag(key) | String | Ruft einen Tag-Wert des Ereignisses ab. |
getTitle() | String | Ruft den Titel der Veranstaltung ab. |
getVisibility() | Visibility | Ruft die Sichtbarkeit des Ereignisses ab. |
guestsCanInviteOthers() | Boolean | Hiermit wird festgelegt, ob Gäste andere Gäste einladen können. |
guestsCanModify() | Boolean | Gibt an, ob Gäste den Termin ändern können. |
guestsCanSeeGuests() | Boolean | Hiermit wird festgelegt, ob Gäste andere Gäste sehen können. |
isAllDayEvent() | Boolean | Gibt an, ob es sich um einen ganztägigen Termin handelt. |
isOwnedByMe() | Boolean | Gibt an, ob Sie der Inhaber des Termins sind. |
isRecurringEvent() | Boolean | Gibt an, ob das Ereignis Teil einer Ereignisreihe ist. |
removeAllReminders() | CalendarEvent | Entfernt alle Erinnerungen aus dem Termin. |
removeGuest(email) | CalendarEvent | Entfernt einen Gast aus dem Termin. |
resetRemindersToDefault() | CalendarEvent | Die Erinnerungen werden auf die Standardeinstellungen des Kalenders zurückgesetzt. |
setAllDayDate(date) | CalendarEvent | Das Datum des Ereignisses. |
setAllDayDates(startDate, endDate) | CalendarEvent | Hiermit werden die Termine des Ereignisses festgelegt. |
setAnyoneCanAddSelf(anyoneCanAddSelf) | CalendarEvent | Hier legen Sie fest, ob sich Personen, die keine Gäste sind, dem Termin selbst hinzufügen können. |
setColor(color) | CalendarEvent | Hiermit wird die Farbe des Kalendertermins festgelegt. |
setDescription(description) | CalendarEvent | Hier wird die Beschreibung des Ereignisses festgelegt. |
setGuestsCanInviteOthers(guestsCanInviteOthers) | CalendarEvent | Legen Sie fest, ob Gäste andere Gäste einladen können. |
setGuestsCanModify(guestsCanModify) | CalendarEvent | Hier legen Sie fest, ob Gäste den Termin ändern können. |
setGuestsCanSeeGuests(guestsCanSeeGuests) | CalendarEvent | Legen Sie fest, ob Gäste andere Gäste sehen können. |
setLocation(location) | CalendarEvent | Der Ort des Ereignisses. |
setMyStatus(status) | CalendarEvent | Hiermit wird der Ereignisstatus des tatsächlichen Nutzers festgelegt, z. B. „Teilnehmend“ oder „Eingeladen“. |
setTag(key, value) | CalendarEvent | Hiermit wird ein Schlüssel/Wert-Tag für das Ereignis festgelegt, um benutzerdefinierte Metadaten zu speichern. |
setTime(startTime, endTime) | CalendarEvent | Hier legen Sie das Start- und Enddatum sowie die Start- und Endzeit des Ereignisses fest. |
setTitle(title) | CalendarEvent | Legt den Titel der Veranstaltung fest. |
setVisibility(visibility) | CalendarEvent | Legt die Sichtbarkeit des Ereignisses fest. |
Detaillierte Dokumentation
addEmailReminder(minutesBefore)
Dem Ereignis wird eine neue E-Mail-Erinnerung hinzugefügt. Die Erinnerung muss mindestens 5 Minuten und höchstens 4 Wochen (40.320 Minuten) vor dem Ereignis erfolgen.
// 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);
Parameter
Name | Typ | Beschreibung |
---|---|---|
minutesBefore | Integer | die Anzahl der Minuten vor dem Termin |
Rückflug
CalendarEvent
– dieses CalendarEvent
für die Verkettung
Löst aus
Error
: Wenn für den Termin mehr als fünf Erinnerungen festgelegt sind oder die Uhrzeit nicht im zulässigen Bereich liegt
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
addGuest(email)
Dem Termin wird ein Gast hinzugefügt.
// 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); } }
Parameter
Name | Typ | Beschreibung |
---|---|---|
email | String | Die E-Mail-Adresse des Gastes. |
Rückflug
CalendarEvent
– Dieses CalendarEvent
für die Verkettung.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
addPopupReminder(minutesBefore)
Dem Ereignis wird eine neue Pop-up-Benachrichtigung hinzugefügt. Die Benachrichtigung muss mindestens 5 Minuten und höchstens 4 Wochen (40.320 Minuten) vor dem Ereignis erfolgen.
// 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);
Parameter
Name | Typ | Beschreibung |
---|---|---|
minutesBefore | Integer | die Anzahl der Minuten vor dem Termin |
Rückflug
CalendarEvent
– dieses CalendarEvent
für die Verkettung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
addSmsReminder(minutesBefore)
Dem Ereignis wird eine neue SMS-Erinnerung hinzugefügt. Die Erinnerung muss mindestens 5 Minuten und höchstens 4 Wochen (40.320 Minuten) vor dem Ereignis erfolgen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
minutesBefore | Integer | die Anzahl der Minuten vor dem Termin |
Rückflug
CalendarEvent
– dieses CalendarEvent
für die Verkettung
Löst aus
Error
: Wenn für den Termin mehr als fünf Erinnerungen festgelegt sind oder die Uhrzeit nicht im zulässigen Bereich liegt
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
anyoneCanAddSelf()
Bestimmt, ob sich Personen einem Kalendertermin als Gäste hinzufügen können.
// 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());
Rückflug
Boolean
– true
, wenn sich Personen, die keine Gäste sind, dem Termin selbst hinzufügen können; false
, wenn nicht
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
deleteEvent()
Löscht einen Kalendertermin.
// 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();
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
deleteTag(key)
Löscht ein Schlüssel/Wert-Tag aus dem Ereignis.
Parameter
Name | Typ | Beschreibung |
---|---|---|
key | String | den Tag-Schlüssel |
Rückflug
CalendarEvent
– dieses CalendarEvent
für die Verkettung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
getAllDayEndDate()
Das Datum, an dem dieser ganztägige Kalendertermin endet. Wenn es sich nicht um einen ganztägigen Termin handelt, löst diese Methode eine Ausnahme aus. Der zurückgegebene Wert für Date
entspricht Mitternacht am Anfang des Tages nach dem Ende des Ereignisses in der Zeitzone des Scripts. Wenn Sie stattdessen die Zeitzone des Kalenders verwenden möchten, geben Sie getEndTime()
ein.
// 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);
Rückflug
Date
– das Enddatum dieses ganztägigen Kalenderereignisses
Löst aus
Error
, wenn es sich nicht um einen ganztägigen Termin handelt
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getAllDayStartDate()
Das Datum, an dem dieser ganztägige Kalendertermin beginnt. Wenn es sich nicht um einen ganztägigen Termin handelt, löst diese Methode eine Ausnahme aus. Der zurückgegebene Wert Date
steht für Mitternacht am Anfang des Tages, an dem das Ereignis beginnt, in der Zeitzone des Scripts. Wenn Sie stattdessen die Zeitzone des Kalenders verwenden möchten, geben Sie getStartTime()
ein.
// 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);
Rückflug
Date
– das Startdatum dieses ganztägigen Kalendertermins
Löst aus
Error
, wenn es sich nicht um einen ganztägigen Termin handelt
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getAllTagKeys()
Hier werden alle Schlüssel für Tags abgerufen, die für das Ereignis festgelegt wurden.
Rückflug
String[]
– ein Array von Strings als Schlüssel
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getColor()
Gibt die Farbe des Termins zurück.
// 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);
Rückflug
String
: Die Stringdarstellung der Ereignisfarbe als Index (1–11) der Werte aus CalendarApp.EventColor
.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getCreators()
Ruft die Ersteller eines Ereignisses ab.
// 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());
Rückflug
String[]
– die E-Mail-Adressen der Ersteller des Ereignisses
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getDateCreated()
Das Datum, an dem das Ereignis erstellt wurde. Sie müssen Zugriff auf den Kalender haben.
// 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'); }
Rückflug
Date
– das Erstellungsdatum
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getDescription()
Ruft die Beschreibung des Ereignisses ab. Sie benötigen Bearbeitungszugriff auf den Kalender.
// 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'); }
Rückflug
String
– die Beschreibung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEmailReminders()
Die Minutenwerte für alle E-Mail-Erinnerungen für das Ereignis. Sie benötigen Bearbeitungszugriff auf den Kalender.
// 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'); }
Rückflug
Integer[]
: ein Array, in dem jeder Wert der Anzahl der Minuten vor dem Ereignis entspricht, bei dem eine Erinnerung ausgelöst wird
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEndTime()
Das Datum und die Uhrzeit, an dem dieses Kalenderereignis endet. Sie müssen Zugriff auf den Kalender haben. Bei nicht ganztägigen Ereignissen ist dies der Zeitpunkt, zu dem das Ereignis enden soll. Bei ganztägigen Terminen, für die nur ein Enddatum (kein Datum und keine Uhrzeit) gespeichert wird, ist dies Mitternacht am Anfang des Tages nach dem Ende der Veranstaltung in der Zeitzone des Kalenders. So können Endzeiten für alle Arten von Ereignissen sinnvoll verglichen werden. Der ursprüngliche Tag des Jahres wird dabei jedoch nicht unbedingt unverändert beibehalten.
Bei ganztägigen Terminen sollte getAllDayEndDate()
fast immer anstelle dieser Methode aufgerufen werden.
// 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'); }
Rückflug
Date
– Endzeit dieses Kalendertermins
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventSeries()
Die Reihe der wiederkehrenden Ereignisse, zu denen dieses Ereignis gehört. Sie müssen Zugriff auf den Kalender haben. Ein CalendarEventSeries
-Objekt wird auch dann zurückgegeben, wenn dieses Ereignis nicht zu einer Reihe gehört, damit Sie neue Wiederholungseinstellungen hinzufügen können.
// 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'); }
Rückflug
CalendarEventSeries
: Die Veranstaltungsreihe, zu der dieser Termin gehört, oder eine neue Veranstaltungsreihe, falls er noch keiner Reihe zugewiesen ist
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventType()
Ruft den EventType
dieses Ereignisses ab.
// 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));
Rückflug
EventType
: Der Ereignistyp.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getGuestByEmail(email)
Ruft einen Gast anhand seiner E-Mail-Adresse ab.
// 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()); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
email | String | die Adresse des Gastes |
Rückflug
EventGuest
: der Gast oder „null“, wenn die E-Mail-Adresse keinem Gast zugeordnet ist
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
getGuestList()
Ruft die Gäste für die Veranstaltung ab, ausgenommen den Eigentümer der Veranstaltung.
// 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()); }
Rückflug
EventGuest[]
– ein Array der Gäste
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getGuestList(includeOwner)
Ruft die Gäste für die Veranstaltung ab, möglicherweise einschließlich der Eigentümer der Veranstaltung.
// 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()); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
includeOwner | Boolean | ob die Eigentümer als Gast hinzugefügt werden sollen |
Rückflug
EventGuest[]
– ein Array der Gäste
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getId()
Die eindeutige iCalUID des Ereignisses wird abgerufen. Die iCalUID und das Ereignis id
, die von der Google Kalender API 3 und dem erweiterten Google Kalender-Dienst verwendet werden, sind nicht identisch und können nicht synonym verwendet werden. Ein Unterschied in der Semantik besteht darin, dass bei wiederkehrenden Ereignissen alle Vorkommnisse eines Ereignisses eine unterschiedliche ids
haben, während sie alle dieselbe iCalUID haben.
// 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());
Rückflug
String
: die iCalUID des Ereignisses
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getLastUpdated()
Das Datum, an dem das Ereignis zuletzt aktualisiert wurde.
// 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);
Rückflug
Date
– Datum der letzten Aktualisierung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getLocation()
Der Ort der Veranstaltung.
// 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'); }
Rückflug
String
– der Ereignisort
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getMyStatus()
Ruft den Ereignisstatus des effektiven Nutzers ab, z. B. „Teilnehmend“ oder „Eingeladen“. Wird immer GuestStatus.OWNER
zurückgegeben, wenn der effektive Nutzer der Eigentümer des Ereignisses ist.
// 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'); }
Rückflug
GuestStatus
– der Status
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getOriginalCalendarId()
Rufen Sie die ID des Kalenders ab, in dem dieses Ereignis ursprünglich erstellt wurde.
// 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'); }
Rückflug
String
– die ID des ursprünglichen Kalenders
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getPopupReminders()
Die Minutenwerte für alle Pop-up-Erinnerungen für das Ereignis werden abgerufen.
// 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'); }
Rückflug
Integer[]
: ein Array, in dem jeder Wert der Anzahl der Minuten vor dem Ereignis entspricht, bei dem eine Erinnerung ausgelöst wird
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getSmsReminders()
Die Minutenwerte für alle SMS-Erinnerungen für das Ereignis werden abgerufen.
Rückflug
Integer[]
: ein Array, in dem jeder Wert der Anzahl der Minuten vor dem Ereignis entspricht, bei dem eine Erinnerung ausgelöst wird
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getStartTime()
Das Datum und die Uhrzeit, zu der dieser Kalendertermin beginnt. Bei nicht ganztägigen Ereignissen ist dies der Zeitpunkt, zu dem das Ereignis beginnen soll. Bei ganztägigen Terminen, für die nur ein Startdatum (kein Datum und keine Uhrzeit) gespeichert wird, ist dies Mitternacht am Beginn des Tages, an dem das Ereignis beginnt, in der Zeitzone des Kalenders. So können Startzeiten für alle Arten von Ereignissen sinnvoll verglichen werden. Der ursprüngliche Tag des Jahres wird dabei jedoch nicht unbedingt unverändert beibehalten.
Bei ganztägigen Terminen sollte getAllDayStartDate()
fast immer anstelle dieser Methode aufgerufen werden.
// 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);
Rückflug
Date
– Startzeit dieses Kalendertermins
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getTag(key)
Ruft einen Tag-Wert des Ereignisses ab.
Parameter
Name | Typ | Beschreibung |
---|---|---|
key | String | den Schlüssel |
Rückflug
String
– der Tag-Wert
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getTitle()
Ruft den Titel der Veranstaltung ab.
// 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'); }
Rückflug
String
– der Titel
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getVisibility()
Ruft die Sichtbarkeit des Ereignisses ab.
// 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'); }
Rückflug
Visibility
– der Sichtbarkeitswert
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
guestsCanInviteOthers()
Hiermit wird festgelegt, ob Gäste andere Gäste einladen können.
// 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'); }
Rückflug
Boolean
– true
, wenn Gäste andere einladen können; false
, wenn nicht
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
guestsCanModify()
Gibt an, ob Gäste den Termin ändern können.
// 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'); }
Rückflug
Boolean
– true
, wenn Gäste den Termin ändern können; false
, wenn nicht
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
guestsCanSeeGuests()
Hiermit wird festgelegt, ob Gäste andere Gäste sehen können.
// 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'); }
Rückflug
Boolean
– true
, wenn Gäste andere Gäste sehen können; false
, wenn nicht
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isAllDayEvent()
Gibt an, ob es sich um einen ganztägigen Termin handelt.
// 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());
Rückflug
Boolean
– true
, wenn es sich um einen ganztägigen Termin handelt, false
andernfalls
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isOwnedByMe()
Gibt an, ob Sie der Inhaber des Termins sind.
// 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'); }
Rückflug
Boolean
– true
, wenn der effektive Nutzer Inhaber des Ereignisses ist; false
andernfalls
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isRecurringEvent()
Gibt an, ob das Ereignis Teil einer Ereignisreihe ist.
// 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'); }
Rückflug
Boolean
– true
, wenn das Ereignis Teil einer Ereignisreihe ist, false
andernfalls
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
removeAllReminders()
Entfernt alle Erinnerungen aus dem Termin.
// 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'); }
Rückflug
CalendarEvent
– dieses CalendarEvent
für die Verkettung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
removeGuest(email)
Entfernt einen Gast aus dem Termin.
// 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); } }
Parameter
Name | Typ | Beschreibung |
---|---|---|
email | String | die E-Mail-Adresse des Gastes |
Rückflug
CalendarEvent
– dieses CalendarEvent
für die Verkettung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
resetRemindersToDefault()
Die Erinnerungen werden auf die Standardeinstellungen des Kalenders zurückgesetzt.
// 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'); }
Rückflug
CalendarEvent
– dieses CalendarEvent
für die Verkettung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setAllDayDate(date)
Das Datum des Ereignisses. Wenn Sie diese Methode anwenden, wird ein regelmäßiger Termin in einen ganztägigen Termin umgewandelt.
// 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'); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
date | Date | das Datum des Termins (die Uhrzeit wird ignoriert) |
Rückflug
CalendarEvent
– dieses Kalenderereignis für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setAllDayDates(startDate, endDate)
Hiermit werden die Termine des Ereignisses festgelegt. Dadurch wird ein normales Ereignis in ein ganztägiges Ereignis umgewandelt.
// 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'); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
startDate | Date | das Datum, an dem das Ereignis beginnt (die Uhrzeit wird ignoriert) |
endDate | Date | das Datum, an dem das Ereignis endet (die Uhrzeit wird ignoriert) |
Rückflug
CalendarEvent
– dieses Kalenderereignis für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setAnyoneCanAddSelf(anyoneCanAddSelf)
Hier legen Sie fest, ob sich Personen, die keine Gäste sind, dem Termin selbst hinzufügen können.
// 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'); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
anyoneCanAddSelf | Boolean | ob sich jeder selbst einladen kann |
Rückflug
CalendarEvent
– dieses CalendarEvent
für die Verkettung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setColor(color)
Hiermit wird die Farbe des Kalendertermins festgelegt.
// 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'); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
color | String | Ein ganzzahliger Farbindex als String oder ein Wert aus CalendarApp.EventColor . |
Rückflug
CalendarEvent
– Dieser Kalendertermin zur Verkettung.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setDescription(description)
Hier wird die Beschreibung des Ereignisses festgelegt.
// 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'); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
description | String | die neue Beschreibung |
Rückflug
CalendarEvent
– dieses CalendarEvent
für die Verkettung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setGuestsCanInviteOthers(guestsCanInviteOthers)
Legen Sie fest, ob Gäste andere Gäste einladen können.
// 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'); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
guestsCanInviteOthers | Boolean | ob Gäste andere einladen können |
Rückflug
CalendarEvent
– dieses CalendarEvent
für die Verkettung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setGuestsCanModify(guestsCanModify)
Hier legen Sie fest, ob Gäste den Termin ändern können.
Parameter
Name | Typ | Beschreibung |
---|---|---|
guestsCanModify | Boolean | ob Gäste den Termin bearbeiten können |
Rückflug
CalendarEvent
– dieses CalendarEvent
für die Verkettung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setGuestsCanSeeGuests(guestsCanSeeGuests)
Legen Sie fest, ob Gäste andere Gäste sehen können.
Parameter
Name | Typ | Beschreibung |
---|---|---|
guestsCanSeeGuests | Boolean | ob Gäste andere sehen können |
Rückflug
CalendarEvent
– dieses CalendarEvent
für die Verkettung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setLocation(location)
Der Ort des Ereignisses.
// 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'); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
location | String | den neuen Standort |
Rückflug
CalendarEvent
– dieses CalendarEvent
für die Verkettung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setMyStatus(status)
Hiermit wird der Ereignisstatus des tatsächlichen Nutzers festgelegt, z. B. „Teilnehmend“ oder „Eingeladen“.
// 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'); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
status | GuestStatus | den neuen Status |
Rückflug
CalendarEvent
– dieses CalendarEvent
für die Verkettung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
setTag(key, value)
Hiermit wird ein Schlüssel/Wert-Tag für das Ereignis festgelegt, um benutzerdefinierte Metadaten zu speichern.
Parameter
Name | Typ | Beschreibung |
---|---|---|
key | String | den Tag-Schlüssel |
value | String | den Tag-Wert |
Rückflug
CalendarEvent
– dieses CalendarEvent
für die Verkettung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setTime(startTime, endTime)
Hier legen Sie die Start- und Endzeit des Ereignisses fest. Wenn Sie diese Methode anwenden, wird ein ganztägiger Termin in einen regulären Termin umgewandelt.
// 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);
Parameter
Name | Typ | Beschreibung |
---|---|---|
startTime | Date | den neuen Beginn des Ereignisses |
endTime | Date | das neue Ende des Ereignisses |
Rückflug
CalendarEvent
– dieses Kalenderereignis für die Verknüpfung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setTitle(title)
Legt den Titel der Veranstaltung fest.
// 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'); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | den neuen Titel |
Rückflug
CalendarEvent
– dieses CalendarEvent
für die Verkettung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setVisibility(visibility)
Legt die Sichtbarkeit des Ereignisses fest.
Parameter
Name | Typ | Beschreibung |
---|---|---|
visibility | Visibility |
Rückflug
CalendarEvent
– dieses CalendarEvent
für die Verkettung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds