Stellt einen Kalender dar, der dem Nutzer gehört oder abonniert wurde.
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
createAllDayEvent(title, date) | CalendarEvent | Erstellt einen neuen ganztägigen Termin. |
createAllDayEvent(title, startDate, endDate) | CalendarEvent | Erstellt einen neuen ganztägigen Termin, der mehrere Tage umfassen kann. |
createAllDayEvent(title, startDate, endDate, options) | CalendarEvent | Erstellt einen neuen ganztägigen Termin, der mehrere Tage umfassen kann. |
createAllDayEvent(title, date, options) | CalendarEvent | Erstellt einen neuen ganztägigen Termin. |
createAllDayEventSeries(title, startDate, recurrence) | CalendarEventSeries | Erstellt eine neue ganztägige Terminserie. |
createAllDayEventSeries(title, startDate, recurrence, options) | CalendarEventSeries | Erstellt eine neue ganztägige Terminserie. |
createEvent(title, startTime, endTime) | CalendarEvent | Erstellt einen neuen Termin. |
createEvent(title, startTime, endTime, options) | CalendarEvent | Erstellt einen neuen Termin. |
createEventFromDescription(description) | CalendarEvent | Erstellt ein Ereignis aus einer Beschreibung im freien Format. |
createEventSeries(title, startTime, endTime, recurrence) | CalendarEventSeries | Erstellt eine neue Terminserie. |
createEventSeries(title, startTime, endTime, recurrence, options) | CalendarEventSeries | Erstellt eine neue Terminserie. |
deleteCalendar() | void | Der Kalender wird endgültig gelöscht. |
getColor() | String | Ruft die Farbe des Kalenders ab. |
getDescription() | String | Ruft die Beschreibung des Kalenders ab. |
getEventById(iCalId) | CalendarEvent | Ruft das Ereignis mit der angegebenen ID ab. |
getEventSeriesById(iCalId) | CalendarEventSeries | Ruft die Ereignisreihe mit der angegebenen ID ab. |
getEvents(startTime, endTime) | CalendarEvent[] | Ruft alle Ereignisse ab, die in einem bestimmten Zeitraum auftreten. |
getEvents(startTime, endTime, options) | CalendarEvent[] | Ruft alle Ereignisse ab, die innerhalb eines bestimmten Zeitraums auftreten und die angegebenen Kriterien erfüllen. |
getEventsForDay(date) | CalendarEvent[] | Ruft alle Ereignisse ab, die an einem bestimmten Tag auftreten. |
getEventsForDay(date, options) | CalendarEvent[] | Ruft alle Ereignisse ab, die an einem bestimmten Tag auftreten und die angegebenen Kriterien erfüllen. |
getId() | String | Ruft die ID des Kalenders ab. |
getName() | String | Ruft den Namen des Kalenders ab. |
getTimeZone() | String | Zeitzone des Kalenders abrufen. |
isHidden() | Boolean | Legt fest, ob der Kalender auf der Benutzeroberfläche ausgeblendet wird. |
isMyPrimaryCalendar() | Boolean | Bestimmt, ob der Kalender der Hauptkalender des aktiven Nutzers ist. |
isOwnedByMe() | Boolean | Damit wird festgelegt, ob Sie der Inhaber des Kalenders sind. |
isSelected() | Boolean | Legt fest, ob die Termine des Kalenders auf der Benutzeroberfläche angezeigt werden. |
setColor(color) | Calendar | Legt die Farbe des Kalenders fest. |
setDescription(description) | Calendar | Legt die Beschreibung eines Kalenders fest. |
setHidden(hidden) | Calendar | Legt fest, ob der Kalender auf der Benutzeroberfläche sichtbar sein soll. |
setName(name) | Calendar | Legt den Namen des Kalenders fest. |
setSelected(selected) | Calendar | Legt fest, ob die Termine des Kalenders auf der Benutzeroberfläche angezeigt werden. |
setTimeZone(timeZone) | Calendar | Legt die Zeitzone des Kalenders fest. |
unsubscribeFromCalendar() | void | Hiermit wird der Nutzer von einem Kalender abgemeldet. |
Detaillierte Dokumentation
createAllDayEvent(title, date)
Erstellt einen neuen ganztägigen Termin.
// Creates an all-day event for the moon landing and logs the ID. var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Apollo 11 Landing', new Date('July 20, 1969')); Logger.log('Event ID: ' + event.getId());
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | Der Titel des Termins. |
date | Date | Das Datum des Ereignisses (nur der Tag wird verwendet; die Zeit wird ignoriert) |
Return
CalendarEvent
: Das erstellte Ereignis.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, startDate, endDate)
Erstellt einen neuen ganztägigen Termin, der mehrere Tage umfassen kann.
// Creates an all-day event for the Woodstock festival (August 15th to 17th) and logs the ID. var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Woodstock Festival', new Date('August 15, 1969'), new Date('August 18, 1969')); Logger.log('Event ID: ' + event.getId());
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | Der Titel des Termins. |
startDate | Date | Das Datum, an dem das Ereignis beginnt. Es wird nur der Tag verwendet; die Zeit wird ignoriert. |
endDate | Date | Das Datum, an dem das Ereignis endet. Es wird nur der Tag verwendet; die Zeit wird ignoriert. Das Enddatum ist ausgeschlossen. |
Return
CalendarEvent
: Das erstellte Ereignis.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, startDate, endDate, options)
Erstellt einen neuen ganztägigen Termin, der mehrere Tage umfassen kann.
// Creates an all-day event for the Woodstock festival (August 15th to 17th) and logs the ID. var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Woodstock Festival', new Date('August 15, 1969'), new Date('August 18, 1969'), {location: 'Bethel, White Lake, New York, U.S.', sendInvites: true}); Logger.log('Event ID: ' + event.getId());
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | Der Titel des Termins. |
startDate | Date | Das Datum, an dem das Ereignis beginnt. Es wird nur der Tag verwendet; die Zeit wird ignoriert. |
endDate | Date | Das Datum, an dem das Ereignis endet. Es wird nur der Tag verwendet; die Zeit wird ignoriert. Das Enddatum ist ausgeschlossen. |
options | Object | Ein JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt. |
Erweiterte Parameter
Name | Typ | Beschreibung |
---|---|---|
description | String | Die Beschreibung des Ereignisses. |
location | String | Der Veranstaltungsort. |
guests | String | Eine durch Kommas getrennte Liste von E-Mail-Adressen, die als Gäste hinzugefügt werden sollen. |
sendInvites | Boolean | Gibt an, ob Einladungs-E-Mails gesendet werden (Standardeinstellung: false ). |
Return
CalendarEvent
: Das erstellte Ereignis.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, date, options)
Erstellt einen neuen ganztägigen Termin.
// Creates an all-day event for the moon landing and logs the ID. var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Apollo 11 Landing', new Date('July 20, 1969'), {location: 'The Moon'}); Logger.log('Event ID: ' + event.getId());
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | Der Titel des Termins. |
date | Date | Das Datum des Ereignisses (nur der Tag wird verwendet; die Zeit wird ignoriert) |
options | Object | Ein JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt. |
Erweiterte Parameter
Name | Typ | Beschreibung |
---|---|---|
description | String | Die Beschreibung des Ereignisses. |
location | String | Der Veranstaltungsort. |
guests | String | Eine durch Kommas getrennte Liste von E-Mail-Adressen, die als Gäste hinzugefügt werden sollen. |
sendInvites | Boolean | Gibt an, ob Einladungs-E-Mails gesendet werden (Standardeinstellung: false ). |
Return
CalendarEvent
: Das erstellte Ereignis.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEventSeries(title, startDate, recurrence)
Erstellt eine neue ganztägige Terminserie.
// Creates an event series for a no-meetings day, taking place every Wednesday in 2013. var eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries('No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014'))); Logger.log('Event Series ID: ' + eventSeries.getId());
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | den Titel der Termine in der Serie |
startDate | Date | das Datum des ersten Termins in der Serie (nur der Tag wird verwendet; die Zeit wird ignoriert) |
recurrence | EventRecurrence | Die Wiederholungseinstellungen der Terminserie |
Return
CalendarEventSeries
– Die erstellte Terminserie
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEventSeries(title, startDate, recurrence, options)
Erstellt eine neue ganztägige Terminserie.
// Creates an event series for a no-meetings day, taking place every Wednesday in 2013. var eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries('No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014')), {guests: 'everyone@example.com'}); Logger.log('Event Series ID: ' + eventSeries.getId());
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | den Titel der Termine in der Serie |
startDate | Date | das Datum des ersten Termins in der Serie (nur der Tag wird verwendet; die Zeit wird ignoriert) |
recurrence | EventRecurrence | Die Wiederholungseinstellungen der Terminserie |
options | Object | Ein JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt |
Erweiterte Parameter
Name | Typ | Beschreibung |
---|---|---|
description | String | Die Beschreibung der Ereignisse in der Serie |
location | String | Ort der Termine in der Serie |
guests | String | eine durch Kommas getrennte Liste von E-Mail-Adressen, die den Terminen als Gäste hinzugefügt werden sollen |
sendInvites | Boolean | ob Einladungs-E-Mails gesendet werden sollen (Standardeinstellung: false ) |
Return
CalendarEventSeries
– Die erstellte Terminserie
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEvent(title, startTime, endTime)
Erstellt einen neuen Termin.
Wenn keine Zeitzone angegeben ist, werden die Zeitwerte im Kontext der Zeitzone des Skripts interpretiert, die sich von der Zeitzone des Kalenders unterscheiden kann.
// Creates an event for the moon landing and logs the ID. var event = CalendarApp.getDefaultCalendar().createEvent('Apollo 11 Landing', new Date('July 20, 1969 20:00:00 UTC'), new Date('July 21, 1969 21:00:00 UTC')); Logger.log('Event ID: ' + event.getId());
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | den Titel des Termins |
startTime | Date | Datum und Uhrzeit des Terminbeginns |
endTime | Date | Datum und Uhrzeit des Termins |
Return
CalendarEvent
– das erstellte Ereignis
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEvent(title, startTime, endTime, options)
Erstellt einen neuen Termin.
Wenn keine Zeitzone angegeben ist, werden die Zeitwerte im Kontext der Zeitzone des Skripts interpretiert, die sich von der Zeitzone des Kalenders unterscheiden kann.
// Creates an event for the moon landing and logs the ID. var event = CalendarApp.getDefaultCalendar().createEvent('Apollo 11 Landing', new Date('July 20, 1969 20:00:00 UTC'), new Date('July 20, 1969 21:00:00 UTC'), {location: 'The Moon'}); Logger.log('Event ID: ' + event.getId());
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | den Titel des Termins |
startTime | Date | Datum und Uhrzeit des Terminbeginns |
endTime | Date | Datum und Uhrzeit des Termins |
options | Object | Ein JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt |
Erweiterte Parameter
Name | Typ | Beschreibung |
---|---|---|
description | String | Die Beschreibung des Ereignisses |
location | String | den Ort des Ereignisses |
guests | String | eine durch Kommas getrennte Liste von E-Mail-Adressen, die als Gäste hinzugefügt werden sollen |
sendInvites | Boolean | ob Einladungs-E-Mails gesendet werden sollen (Standardeinstellung: false ) |
Return
CalendarEvent
– das erstellte Ereignis
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventFromDescription(description)
Erstellt ein Ereignis aus einer Beschreibung im freien Format.
Die Beschreibung sollte dasselbe Format haben wie die Funktion Schnelleintrag der Benutzeroberfläche.
// Creates a new event and logs its ID. var event = CalendarApp.getDefaultCalendar() .createEventFromDescription('Lunch with Mary, Friday at 1PM'); Logger.log('Event ID: ' + event.getId());
Parameter
Name | Typ | Beschreibung |
---|---|---|
description | String | eine kostenlose Beschreibung des Ereignisses |
Return
CalendarEvent
– das erstellte Ereignis
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventSeries(title, startTime, endTime, recurrence)
Erstellt eine neue Terminserie.
// Creates an event series for a team meeting, taking place every Tuesday and Thursday in 2013. var eventSeries = CalendarApp.getDefaultCalendar().createEventSeries('Team Meeting', new Date('January 1, 2013 03:00:00 PM EST'), new Date('January 1, 2013 04:00:00 PM EST'), CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekdays([CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY]) .until(new Date('January 1, 2014'))); Logger.log('Event Series ID: ' + eventSeries.getId());
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | den Titel der Termine in der Serie |
startTime | Date | Datum und Uhrzeit des ersten Termins der Serie |
endTime | Date | Datum und Uhrzeit des Endes des ersten Termins der Serie |
recurrence | EventRecurrence | Die Wiederholungseinstellungen der Terminserie |
Return
CalendarEventSeries
– Die erstellte Terminserie
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventSeries(title, startTime, endTime, recurrence, options)
Erstellt eine neue Terminserie.
// Creates an event series for a team meeting, taking place every Tuesday and Thursday in 2013. var eventSeries = CalendarApp.getDefaultCalendar().createEventSeries('Team Meeting', new Date('January 1, 2013 03:00:00 PM EST'), new Date('January 1, 2013 04:00:00 PM EST'), CalendarApp.newRecurrence().addWeeklyRule() .onlyOnWeekdays([CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY]) .until(new Date('January 1, 2014')), {location: 'Conference Room'}); Logger.log('Event Series ID: ' + eventSeries.getId());
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | den Titel der Termine in der Serie |
startTime | Date | Datum und Uhrzeit des ersten Termins der Serie |
endTime | Date | Datum und Uhrzeit des Endes des ersten Termins der Serie |
recurrence | EventRecurrence | Die Wiederholungseinstellungen der Terminserie |
options | Object | Ein JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt |
Erweiterte Parameter
Name | Typ | Beschreibung |
---|---|---|
description | String | Die Beschreibung der Ereignisse in der Serie |
location | String | Ort der Termine in der Serie |
guests | String | eine durch Kommas getrennte Liste von E-Mail-Adressen, die den Terminen als Gäste hinzugefügt werden sollen |
sendInvites | Boolean | ob Einladungs-E-Mails gesendet werden sollen (Standardeinstellung: false ) |
Return
CalendarEventSeries
– Die erstellte Terminserie
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
deleteCalendar()
Der Kalender wird endgültig gelöscht. Ein Nutzer kann nur einen Kalender löschen, dessen Eigentümer er ist.
// Creates a calendar to delete. const calendar = CalendarApp.createCalendar('Test'); // Deletes the 'Test' calendar permanently. calendar.deleteCalendar();
Löst aus
Error
: Wenn es sich um einen importierten Kalender handelt.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
getColor()
Ruft die Farbe des Kalenders ab.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Gets the color of the calendar and logs it to the console. // For the default calendar, you can use CalendarApp.getColor() instead. const calendarColor = calendar.getColor(); console.log(calendarColor);
Return
String
: Ein hexadezimaler Farbstring ("#rrggbb").
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden 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 Kalenders ab.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Sets the description of the calendar to 'Test description.' calendar.setDescription('Test description'); // Gets the description of the calendar and logs it to the console. // For the default calendar, you can use CalendarApp.getDescription() instead. const description = calendar.getDescription(); console.log(description);
Return
String
: Die Beschreibung dieses Kalenders.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden 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
getEventById(iCalId)
Ruft das Ereignis mit der angegebenen ID ab. Wenn die Reihe zu einem anderen Kalender als dem Standardkalender gehört, muss diese Methode von diesem Kalender aus aufgerufen werden. Wenn Sie CalendarApp.getEventById(iCalId)
aufrufen, wird nur ein Termin im Standardkalender zurückgegeben.
Mehrere Veranstaltungen können dieselbe ID haben, wenn sie Teil einer Serie sind. In diesem Fall gibt die Methode nur das erste Ereignis aus dieser Serie zurück.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com') // Creates an event for the moon landing. const event = calendar.createEvent('Apollo 11 Landing', new Date('July 20, 1969 20:05:00 UTC'), new Date('July 20, 1969 20:17:00 UTC')); // Gets the calendar event ID and logs it to the console. const iCalId = event.getId(); console.log(iCalId); // Gets the event by its ID and logs the title of the event to the console. // For the default calendar, you can use CalendarApp.getEventById(iCalId) instead. const myEvent = calendar.getEventById(iCalId); console.log(myEvent.getTitle());
Parameter
Name | Typ | Beschreibung |
---|---|---|
iCalId | String | ID des Ereignisses. |
Return
CalendarEvent
: Das Ereignis mit der angegebenen ID oder null
, wenn das Ereignis nicht vorhanden ist oder der Nutzer nicht darauf zugreifen kann.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden 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
getEventSeriesById(iCalId)
Ruft die Ereignisreihe mit der angegebenen ID ab. Wenn die angegebene ID für ein einzelnes CalendarEvent
gilt, wird ein CalendarEventSeries
mit einem einzelnen Ereignis in der Serie zurückgegeben. Wenn die Terminserie zu einem anderen Kalender als dem Standardkalender gehört, muss diese Methode über diesen Calendar
aufgerufen werden. Durch den direkten Aufruf von CalendarApp.getEventSeriesById(iCalId)
wird nur eine Terminreihe zurückgegeben, die im Standardkalender vorhanden ist.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Creates an event series for a daily team meeting from 1 PM to 2 PM. // The series adds the daily event from January 1, 2023 through December 31, 2023. const eventSeries = calendar.createEventSeries('Team meeting', new Date('Jan 1, 2023 13:00:00'), new Date('Jan 1, 2023 14:00:00'), CalendarApp.newRecurrence().addDailyRule().until(new Date('Jan 1, 2024'))); // Gets the ID of the event series. const iCalId = eventSeries.getId(); // Gets the event series by its ID and logs the series title to the console. // For the default calendar, you can use CalendarApp.getEventSeriesById(iCalId) instead. console.log(calendar.getEventSeriesById(iCalId).getTitle());
Parameter
Name | Typ | Beschreibung |
---|---|---|
iCalId | String | ID der Serie. |
Return
CalendarEventSeries
: Die Reihe mit der angegebenen ID oder null
, wenn die Reihe nicht vorhanden ist oder der Nutzer nicht darauf zugreifen kann.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden 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
getEvents(startTime, endTime)
Ruft alle Ereignisse ab, die in einem bestimmten Zeitraum auftreten.
Diese Methode gibt Ereignisse zurück, die innerhalb des angegebenen Zeitraums beginnen, innerhalb des Zeitraums enden oder den Zeitraum umfassen. Wenn keine Zeitzone angegeben ist, werden die Zeitwerte im Kontext der Zeitzone des Skripts interpretiert, die von der Zeitzone des Kalenders abweichen kann.
// Determines how many events are happening in the next two hours. var now = new Date(); var twoHoursFromNow = new Date(now.getTime() + (2 * 60 * 60 * 1000)); var events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow); Logger.log('Number of events: ' + events.length);
Parameter
Name | Typ | Beschreibung |
---|---|---|
startTime | Date | Beginn des Zeitraums |
endTime | Date | Ende des Zeitraums, nicht inbegriffen |
Return
CalendarEvent[]
– die Ereignisse, die innerhalb des Zeitraums auftreten
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden 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
getEvents(startTime, endTime, options)
Ruft alle Ereignisse ab, die innerhalb eines bestimmten Zeitraums auftreten und die angegebenen Kriterien erfüllen.
Diese Methode gibt Ereignisse zurück, die innerhalb des angegebenen Zeitraums beginnen, innerhalb des Zeitraums enden oder den Zeitraum umfassen. Wenn keine Zeitzone angegeben ist, werden die Zeitwerte im Kontext der Zeitzone des Skripts interpretiert, die von der Zeitzone des Kalenders abweichen kann.
Nach der Anwendung von start
und max
wird nach author
, search
oder statusFilters
gefiltert. Das bedeutet, dass die Anzahl der zurückgegebenen Ereignisse kleiner als max
sein kann, obwohl zusätzliche Ereignisse die Kriterien erfüllen.
// Determines how many events are happening in the next two hours that contain the term // "meeting". var now = new Date(); var twoHoursFromNow = new Date(now.getTime() + (2 * 60 * 60 * 1000)); var events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow, {search: 'meeting'}); Logger.log('Number of events: ' + events.length);
Parameter
Name | Typ | Beschreibung |
---|---|---|
startTime | Date | Beginn des Zeitraums |
endTime | Date | Ende des Zeitraums, nicht inbegriffen |
options | Object | Ein JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt |
Erweiterte Parameter
Name | Typ | Beschreibung |
---|---|---|
start | Integer | Index des ersten zurückzugebenden Ereignisses |
max | Integer | die maximale Anzahl der Ereignisse, die zurückgegeben werden sollen |
author | String | Eine E-Mail-Adresse, über die die Ergebnisse nach dem Ersteller des Termins gefiltert werden |
search | String | Eine Volltextsuchanfrage, die zum Filtern von Ergebnissen verwendet wird |
statusFilters[] | GuestStatus | Array mit Status zum Filtern von Ergebnissen |
Return
CalendarEvent[]
: die Ereignisse, die innerhalb des Zeitraums stattfinden und den Kriterien entsprechen
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden 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
getEventsForDay(date)
Ruft alle Ereignisse ab, die an einem bestimmten Tag auftreten.
Diese Methode gibt Ereignisse zurück, wenn sie im angegebenen Tag beginnen, im Laufe des Tages enden oder den Tag umfassen.
Beachten Sie, dass nur der Datumsteil des Datumsobjekts verwendet wird und der Teil mit der Uhrzeit ignoriert wird. Das Datum wird als Mitternacht dieses Tages bis Mitternacht des nächsten Tages in der Zeitzone des Kalenders interpretiert.
// Determines how many events are happening today. var today = new Date(); var events = CalendarApp.getDefaultCalendar().getEventsForDay(today); Logger.log('Number of events: ' + events.length);
Parameter
Name | Typ | Beschreibung |
---|---|---|
date | Date | Datum, für das Ereignisse abgerufen werden sollen (nur der Tag wird verwendet; die Zeit wird ignoriert) |
Return
CalendarEvent[]
: die Ereignisse, die am angegebenen Datum stattfinden
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden 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
getEventsForDay(date, options)
Ruft alle Ereignisse ab, die an einem bestimmten Tag auftreten und die angegebenen Kriterien erfüllen.
Diese Methode gibt Ereignisse zurück, wenn sie im angegebenen Tag beginnen, im Laufe des Tages enden oder den Tag umfassen.
Beachten Sie, dass nur der Datumsteil des Datumsobjekts verwendet wird und der Teil mit der Uhrzeit ignoriert wird. Das Datum wird als Mitternacht dieses Tages bis Mitternacht des nächsten Tages in der Zeitzone des Kalenders interpretiert.
Nach der Anwendung von start
und max
wird nach author
, search
oder statusFilters
gefiltert. Das bedeutet, dass die Anzahl der zurückgegebenen Ereignisse kleiner als max
sein kann, obwohl zusätzliche Ereignisse die Kriterien erfüllen.
// Determines how many events are happening today and contain the term "meeting". var today = new Date(); var events = CalendarApp.getDefaultCalendar().getEventsForDay(today, {search: 'meeting'}); Logger.log('Number of events: ' + events.length);
Parameter
Name | Typ | Beschreibung |
---|---|---|
date | Date | Datum, für das Ereignisse abgerufen werden sollen (nur der Tag wird verwendet; die Zeit wird ignoriert) |
options | Object | erweiterte Filteroptionen |
Erweiterte Parameter
Name | Typ | Beschreibung |
---|---|---|
start | Integer | Index des ersten zurückzugebenden Ereignisses |
max | Integer | die maximale Anzahl der Ereignisse, die zurückgegeben werden sollen |
author | String | Eine E-Mail-Adresse, über die die Ergebnisse nach dem Ersteller des Termins gefiltert werden |
search | String | Eine Volltextsuchanfrage, die zum Filtern von Ergebnissen verwendet wird |
statusFilters[] | GuestStatus | Array mit Status zum Filtern von Ergebnissen |
Return
CalendarEvent[]
: die Ereignisse, die an einem bestimmten Datum auftreten und den Kriterien entsprechen
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden 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()
Ruft die ID des Kalenders ab. Die ID für den Standardkalender eines Nutzers entspricht seiner E-Mail-Adresse.
// Opens the calendar by its ID. // To get the user's default calendar, use CalendarApp.getDefaultCalendar(). // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Gets the ID of the calendar and logs it to the console. const calendarId = calendar.getId(); console.log(calendarId);
Return
String
: Die ID des Kalenders.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden 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
getName()
Ruft den Namen des Kalenders ab.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Gets the name of the calendar and logs it to the console. // For the default calendar, you can use CalendarApp.getName() instead. const calendarName = calendar.getName(); console.log(calendarName);
Return
String
: Name dieses Kalenders.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden 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
getTimeZone()
Zeitzone des Kalenders abrufen.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Gets the time zone of the calendar and logs it to the console. // For the default calendar, you can use CalendarApp.getTimeZone() instead. const timeZone = calendar.getTimeZone(); console.log(timeZone);
Return
String
: Die Zeitzone im „long“-Format (z. B. „America/New_York“, wie auf Joda.org aufgeführt).
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden 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
isHidden()
Legt fest, ob der Kalender auf der Benutzeroberfläche ausgeblendet wird.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Determines whether the calendar is hidden in the user interface and logs it to the console. // For the default calendar, you can use CalendarApp.isHidden() instead. const isHidden = calendar.isHidden(); console.log(isHidden);
Return
Boolean
: true
, wenn der Kalender in der Benutzeroberfläche ausgeblendet ist; false
, wenn nicht.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden 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
isMyPrimaryCalendar()
Bestimmt, ob der Kalender der Hauptkalender des aktiven Nutzers ist.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Determines whether the calendar is the default calendar for // the effective user and logs it to the console. // For the default calendar, you can use CalendarApp.isMyPrimaryCalendar() instead. const isMyPrimaryCalendar = calendar.isMyPrimaryCalendar(); console.log(isMyPrimaryCalendar);
Return
Boolean
: true
, wenn der Kalender der Standardkalender für den aktiven Nutzer ist; false
, wenn nicht.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden 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()
Damit wird festgelegt, ob Sie der Inhaber des Kalenders sind.
// Gets a calendar by its ID. To get the user's default calendar, use // CalendarApp.getDefault() instead. // TODO(developer): Replace the ID with the calendar ID that you want to use. const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com'); // Determines whether the calendar is owned by you and logs it. console.log(calendar.isOwnedByMe());
Return
Boolean
: true
, wenn Sie der Inhaber des Kalenders sind; andernfalls false
.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden 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
isSelected()
Legt fest, ob die Termine des Kalenders auf der Benutzeroberfläche angezeigt werden.
// Gets the user's default calendar. To get a different calendar, use getCalendarById() // instead. const calendar = CalendarApp.getDefaultCalendar(); // Determines whether the calendar's events are displayed in the user interface and logs it. console.log(calendar.isSelected());
Return
Boolean
: true
, wenn die Termine des Kalenders auf der Benutzeroberfläche angezeigt werden; false
, wenn die Termine nicht angezeigt werden
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden 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
setColor(color)
Legt die Farbe des Kalenders fest.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Sets the color of the calendar to pink using the Calendar Color enum. // For the default calendar, you can use CalendarApp.setColor() instead. calendar.setColor(CalendarApp.Color.PINK);
Parameter
Name | Typ | Beschreibung |
---|---|---|
color | String | Ein CalendarApp.Color oder ein hexadezimaler Farbstring ("#rrggbb"). |
Return
Calendar
: Dieser Kalender für Verkettungen.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setDescription(description)
Legt die Beschreibung eines Kalenders fest.
// Gets the user's default calendar. To get a different calendar, use getCalendarById() // instead. const calendar = CalendarApp.getDefaultCalendar(); // Sets the description of the calendar. // TODO(developer): Update the string with the description that you want to use. calendar.setDescription('Updated calendar description.')
Parameter
Name | Typ | Beschreibung |
---|---|---|
description | String | die Beschreibung dieses Kalenders |
Return
Calendar
– dieser Kalender zum Verketten
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setHidden(hidden)
Legt fest, ob der Kalender auf der Benutzeroberfläche sichtbar sein soll.
Parameter
Name | Typ | Beschreibung |
---|---|---|
hidden | Boolean | true , um den Kalender in der Benutzeroberfläche auszublenden; false , um ihn anzuzeigen |
Return
Calendar
– dieser Kalender zum Verketten
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setName(name)
Legt den Namen des Kalenders fest.
// Gets the user's default calendar. To get a different calendar, use getCalendarById() // instead. const calendar = CalendarApp.getDefaultCalendar(); // Sets the name of the calendar. // TODO(developer): Update the string with the name that you want to use. calendar.setName('Example calendar name');
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | der neue Name |
Return
Calendar
– dieser Kalender zum Verketten
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setSelected(selected)
Legt fest, ob die Termine des Kalenders auf der Benutzeroberfläche angezeigt werden.
// Gets the user's default calendar. To get a different calendar, use getCalendarById() // instead. const calendar = CalendarApp.getDefaultCalendar(); // Selects the calendar so that its events are displayed in the user interface. To // unselect the calendar, set the parameter to false. calendar.setSelected(true);
Parameter
Name | Typ | Beschreibung |
---|---|---|
selected | Boolean | true , um die Termine des Kalenders in der Benutzeroberfläche anzuzeigen; false , um sie auszublenden |
Return
Calendar
– dieser Kalender zum Verketten
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setTimeZone(timeZone)
Legt die Zeitzone des Kalenders fest.
// Gets the user's default calendar. To get a different calendar, use getCalendarById() // instead. const calendar = CalendarApp.getDefaultCalendar(); // Sets the time zone of the calendar to America/New York (US/Eastern) time. calendar.setTimeZone('America/New_York');
Parameter
Name | Typ | Beschreibung |
---|---|---|
timeZone | String | Die Zeitzone im „long“-Format (z. B. „America/New_York“, wie auf Joda.org aufgeführt). |
Return
Calendar
: Dieser Kalender für Verkettungen.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
unsubscribeFromCalendar()
Hiermit wird der Nutzer von einem Kalender abgemeldet. Ein Nutzer kann sich nicht von Kalendern abmelden, die in der Liste Meine Kalender aufgeführt sind. Sie können Kalender abbestellen, die unter Weitere Kalender aufgeführt sind.
// Gets the calendar by its ID. // TODO(developer): Replace the calendar ID with the calendar ID that you want to get. const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com'); // Unsubscribes the user from the calendar. const result = calendar.unsubscribeFromCalendar();
Löst aus
Error
: wenn es sich um einen eigenen Kalender handelt
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds