Ermöglicht es einem Script, den Google-Kalender des Nutzers zu lesen und zu aktualisieren. Diese Klasse bietet direkten Zugriff auf den Standardkalender des Nutzers sowie die Möglichkeit, zusätzliche Kalender abzurufen, deren Inhaber der Nutzer ist oder die er abonniert hat.
Attribute
Attribut | Typ | Beschreibung |
---|---|---|
Color | Color | Ein Enum, das die im Kalenderdienst verfügbaren benannten Farben darstellt. |
EventColor | EventColor | Ein Enum, das die benannten Terminfarben im Kalenderdienst darstellt. |
GuestStatus | GuestStatus | Ein Enum, das die Status darstellt, die ein Gast für eine Veranstaltung haben kann. |
Month | Month | Ein Enum, das die Monate des Jahres darstellt. |
Visibility | Visibility | Ein Enum, das die Sichtbarkeit eines Ereignisses darstellt. |
Weekday | Weekday | Ein Enum, das die Wochentage darstellt. |
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 sich über mehrere Tage erstrecken kann. |
createAllDayEvent(title, startDate, endDate, options) | CalendarEvent | Erstellt einen neuen ganztägigen Termin, der sich über mehrere Tage erstrecken kann. |
createAllDayEvent(title, date, options) | CalendarEvent | Erstellt einen neuen ganztägigen Termin. |
createAllDayEventSeries(title, startDate, recurrence) | CalendarEventSeries | Erstellt eine neue Reihe ganztägiger Termine. |
createAllDayEventSeries(title, startDate, recurrence, options) | CalendarEventSeries | Erstellt eine neue Reihe ganztägiger Termine. |
createCalendar(name) | Calendar | Es wird ein neuer Kalender erstellt, dessen Inhaber der Nutzer ist. |
createCalendar(name, options) | Calendar | Es wird ein neuer Kalender erstellt, dessen Inhaber der Nutzer ist. |
createEvent(title, startTime, endTime) | CalendarEvent | Erstellt ein neues Ereignis. |
createEvent(title, startTime, endTime, options) | CalendarEvent | Erstellt ein neues Ereignis. |
createEventFromDescription(description) | CalendarEvent | Erstellt ein Ereignis aus einer Beschreibung im freien Format. |
createEventSeries(title, startTime, endTime, recurrence) | CalendarEventSeries | Erstellt eine neue Ereignisreihe. |
createEventSeries(title, startTime, endTime, recurrence, options) | CalendarEventSeries | Erstellt eine neue Ereignisreihe. |
getAllCalendars() | Calendar[] | Alle Kalender abrufen, die dem Nutzer gehören oder die er abonniert hat |
getAllOwnedCalendars() | Calendar[] | Alle Kalender abrufen, deren Inhaber der Nutzer ist. |
getCalendarById(id) | Calendar | Ruft den Kalender mit der angegebenen ID ab. |
getCalendarsByName(name) | Calendar[] | Alle Kalender mit einem bestimmten Namen abrufen, die dem Nutzer gehören oder die er abonniert hat. |
getColor() | String | Ruft die Farbe des Kalenders ab. |
getDefaultCalendar() | Calendar | Ruft den Standardkalender des Nutzers 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[] | Hiermit werden alle Ereignisse abgerufen, die in einem bestimmten Zeitraum auftreten. |
getEvents(startTime, endTime, options) | CalendarEvent[] | Hiermit werden alle Ereignisse abgerufen, die in einem bestimmten Zeitraum auftreten und die angegebenen Kriterien erfüllen. |
getEventsForDay(date) | CalendarEvent[] | Alle Ereignisse abrufen, die an einem bestimmten Tag stattfinden |
getEventsForDay(date, options) | CalendarEvent[] | Hiermit werden alle Ereignisse abgerufen, 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. |
getOwnedCalendarById(id) | Calendar | Ruft den Kalender mit der angegebenen ID ab, wenn der Nutzer der Inhaber ist. |
getOwnedCalendarsByName(name) | Calendar[] | Hiermit werden alle Kalender mit einem bestimmten Namen abgerufen, die dem Nutzer gehören. |
getTimeZone() | String | Ruft die Zeitzone des Kalenders ab. |
isHidden() | Boolean | Bestimmt, ob der Kalender in der Benutzeroberfläche ausgeblendet ist. |
isMyPrimaryCalendar() | Boolean | Bestimmt, ob der Kalender der primäre Kalender für den effektiven Nutzer ist. |
isOwnedByMe() | Boolean | Gibt an, ob Sie der Inhaber des Kalenders sind. |
isSelected() | Boolean | Bestimmt, ob die Termine des Kalenders in der Benutzeroberfläche angezeigt werden. |
newRecurrence() | EventRecurrence | Erstellt ein neues Wiederholungsobjekt, mit dem Regeln für die Wiederholung von Ereignissen erstellt werden können. |
setColor(color) | Calendar | Hiermit wird die Farbe des Kalenders festgelegt. |
setDescription(description) | Calendar | Hiermit wird die Beschreibung eines Kalenders festgelegt. |
setHidden(hidden) | Calendar | Legt fest, ob der Kalender in der Benutzeroberfläche sichtbar ist. |
setName(name) | Calendar | Legt den Namen des Kalenders fest. |
setSelected(selected) | Calendar | Hiermit wird festgelegt, ob die Termine des Kalenders in der Benutzeroberfläche angezeigt werden. |
setTimeZone(timeZone) | Calendar | Hier legen Sie die Zeitzone des Kalenders fest. |
subscribeToCalendar(id) | Calendar | Der Nutzer abonniert den Kalender mit der angegebenen ID, sofern er zum Abonnieren berechtigt ist. |
subscribeToCalendar(id, options) | Calendar | Der Nutzer abonniert den Kalender mit der angegebenen ID, sofern er zum Abonnieren berechtigt ist. |
Detaillierte Dokumentation
createAllDayEvent(title, date)
Erstellt einen neuen ganztägigen Termin.
// Creates an all-day event for the moon landing and logs the ID. const event = CalendarApp.getDefaultCalendar().createAllDayEvent( 'Apollo 11 Landing', new Date('July 20, 1969'), ); Logger.log(`Event ID: ${event.getId()}`);
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | Der Titel der Veranstaltung. |
date | Date | Das Datum des Ereignisses (nur der Tag wird verwendet, die Uhrzeit wird ignoriert). |
Rückflug
CalendarEvent
: Das erstellte Ereignis.
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
createAllDayEvent(title, startDate, endDate)
Erstellt einen neuen ganztägigen Termin, der sich über mehrere Tage erstrecken kann.
// Creates an all-day event for the Woodstock festival (August 15th to 17th) and // logs the ID. const event = CalendarApp.getDefaultCalendar().createAllDayEvent( 'Woodstock Festival', new Date('August 15, 1969'), new Date('August 18, 1969'), ); Logger.log(`Event ID: ${event.getId()}`);
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | Der Titel der Veranstaltung. |
startDate | Date | Das Datum, an dem das Ereignis beginnt. Es wird nur der Tag verwendet, die Uhrzeit wird ignoriert. |
endDate | Date | Das Datum, an dem das Ereignis endet. Es wird nur der Tag verwendet, die Uhrzeit wird ignoriert. Das Enddatum ist ausschließend. |
Rückflug
CalendarEvent
: Das erstellte Ereignis.
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
createAllDayEvent(title, startDate, endDate, options)
Erstellt einen neuen ganztägigen Termin, der sich über mehrere Tage erstrecken kann.
// Creates an all-day event for the Woodstock festival (August 15th to 17th) and // logs the ID. const event = CalendarApp.getDefaultCalendar().createAllDayEvent( 'Woodstock Festival', new Date('August 15, 1969'), new Date('August 18, 1969'), {location: 'Bethel, White Lake, New York, U.S.', sendInvites: true}, ); Logger.log(`Event ID: ${event.getId()}`);
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | Der Titel der Veranstaltung. |
startDate | Date | Das Datum, an dem das Ereignis beginnt. Es wird nur der Tag verwendet, die Uhrzeit wird ignoriert. |
endDate | Date | Das Datum, an dem das Ereignis endet. Es wird nur der Tag verwendet, die Uhrzeit wird ignoriert. Das Enddatum ist ausschließend. |
options | Object | Ein JavaScript-Objekt, das die unten aufgeführten erweiterten Parameter angibt. |
Erweiterte Parameter
Name | Typ | Beschreibung |
---|---|---|
description | String | Die Beschreibung des Ereignisses. |
location | String | Der Veranstaltungsort. |
guests | String | Eine durch Kommas getrennte Liste mit E-Mail-Adressen, die als Gäste hinzugefügt werden sollen. |
sendInvites | Boolean | Ob E-Mail-Einladungen gesendet werden sollen (Standard: false ). |
Rückflug
CalendarEvent
: Das erstellte Ereignis.
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
createAllDayEvent(title, date, options)
Erstellt einen neuen ganztägigen Termin.
// Creates an all-day event for the moon landing and logs the ID. const event = CalendarApp.getDefaultCalendar().createAllDayEvent( 'Apollo 11 Landing', new Date('July 20, 1969'), {location: 'The Moon'}, ); Logger.log(`Event ID: ${event.getId()}`);
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | Der Titel der Veranstaltung. |
date | Date | Das Datum des Ereignisses (nur der Tag wird verwendet, die Uhrzeit wird ignoriert). |
options | Object | Ein JavaScript-Objekt, das die unten aufgeführten erweiterten Parameter angibt. |
Erweiterte Parameter
Name | Typ | Beschreibung |
---|---|---|
description | String | Die Beschreibung des Ereignisses. |
location | String | Der Veranstaltungsort. |
guests | String | Eine durch Kommas getrennte Liste mit E-Mail-Adressen, die als Gäste hinzugefügt werden sollen. |
sendInvites | Boolean | Ob E-Mail-Einladungen gesendet werden sollen (Standard: false ). |
Rückflug
CalendarEvent
: Das erstellte Ereignis.
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
createAllDayEventSeries(title, startDate, recurrence)
Erstellt eine neue Reihe ganztägiger Termine.
// Creates an event series for a no-meetings day, taking place every Wednesday // in 2013. const eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries( 'No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), CalendarApp.newRecurrence() .addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014')), ); Logger.log(`Event Series ID: ${eventSeries.getId()}`);
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | den Titel der Ereignisse in der Reihe |
startDate | Date | das Datum des ersten Ereignisses in der Reihe (nur der Tag wird verwendet, die Uhrzeit wird ignoriert) |
recurrence | EventRecurrence | die Wiederholungseinstellungen der Ereignisreihe |
Rückflug
CalendarEventSeries
– die erstellte Ereignisreihe
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
createAllDayEventSeries(title, startDate, recurrence, options)
Erstellt eine neue Reihe ganztägiger Termine.
// Creates an event series for a no-meetings day, taking place every Wednesday // in 2013. const eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries( 'No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), CalendarApp.newRecurrence() .addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014')), {guests: 'everyone@example.com'}, ); Logger.log(`Event Series ID: ${eventSeries.getId()}`);
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | den Titel der Ereignisse in der Reihe |
startDate | Date | das Datum des ersten Ereignisses in der Reihe (nur der Tag wird verwendet, die Uhrzeit wird ignoriert) |
recurrence | EventRecurrence | die Wiederholungseinstellungen der Ereignisreihe |
options | Object | ein JavaScript-Objekt, das die unten aufgeführten erweiterten Parameter angibt |
Erweiterte Parameter
Name | Typ | Beschreibung |
---|---|---|
description | String | die Beschreibung der Ereignisse in der Reihe |
location | String | den Ort der Ereignisse in der Reihe |
guests | String | eine durch Kommas getrennte Liste von E-Mail-Adressen, die den Terminen in der Reihe als Gäste hinzugefügt werden sollen |
sendInvites | Boolean | ob E-Mail-Einladungen gesendet werden sollen (Standard: false ) |
Rückflug
CalendarEventSeries
– die erstellte Ereignisreihe
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
createCalendar(name)
Es wird ein neuer Kalender erstellt, dessen Inhaber der Nutzer ist.
// Creates a new calendar named "Travel Plans". const calendar = CalendarApp.createCalendar('Travel Plans'); Logger.log( 'Created the calendar "%s", with the ID "%s".', calendar.getName(), calendar.getId(), );
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | den Namen des neuen Kalenders |
Rückflug
Calendar
– der neu erstellte Kalender
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
createCalendar(name, options)
Es wird ein neuer Kalender erstellt, dessen Inhaber der Nutzer ist.
// Creates a new calendar named "Travel Plans" with a description and color. const calendar = CalendarApp.createCalendar('Travel Plans', { description: 'A calendar to plan my travel schedule.', color: CalendarApp.Color.BLUE, }); Logger.log( 'Created the calendar "%s", with the ID "%s".', calendar.getName(), calendar.getId(), );
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | den Namen des neuen Kalenders |
options | Object | ein JavaScript-Objekt, das die unten aufgeführten erweiterten Parameter angibt |
Erweiterte Parameter
Name | Typ | Beschreibung |
---|---|---|
location | String | den Speicherort des Kalenders |
description | String | die Beschreibung des Kalenders |
timeZone | String | die Zeitzone, die für den Kalender festgelegt werden soll, im Format „long“ (z.B. „America/New_York“, wie von Joda.org aufgeführt) |
color | String | einen Hexadezimal-Farbcode („#rrggbb“) oder einen Wert aus CalendarApp.Colors |
hidden | Boolean | ob der Kalender in der Benutzeroberfläche ausgeblendet ist (Standard: false ) |
selected | Boolean | ob die Termine des Kalenders in der Benutzeroberfläche angezeigt werden (Standard: true ) |
Rückflug
Calendar
– der neu erstellte Kalender
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
createEvent(title, startTime, endTime)
Erstellt ein neues Ereignis.
Wenn keine Zeitzone angegeben ist, werden die Zeitwerte im Kontext der Zeitzone des Scripts interpretiert, die sich von der Zeitzone des Kalenders unterscheiden kann.
// Creates an event for the moon landing and logs the ID. const event = CalendarApp.getDefaultCalendar().createEvent( 'Apollo 11 Landing', new Date('July 20, 1969 20:00:00 UTC'), new Date('July 21, 1969 21:00:00 UTC'), ); Logger.log(`Event ID: ${event.getId()}`);
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | den Titel der Veranstaltung |
startTime | Date | Datum und Uhrzeit des Beginns des Ereignisses |
endTime | Date | Datum und Uhrzeit des Endes des Ereignisses |
Rückflug
CalendarEvent
– das erstellte Ereignis
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
createEvent(title, startTime, endTime, options)
Erstellt ein neues Ereignis.
Wenn keine Zeitzone angegeben ist, werden die Zeitwerte im Kontext der Zeitzone des Scripts interpretiert, die sich von der Zeitzone des Kalenders unterscheiden kann.
// Creates an event for the moon landing and logs the ID. const event = CalendarApp.getDefaultCalendar().createEvent( 'Apollo 11 Landing', new Date('July 20, 1969 20:00:00 UTC'), new Date('July 20, 1969 21:00:00 UTC'), {location: 'The Moon'}, ); Logger.log(`Event ID: ${event.getId()}`);
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | den Titel der Veranstaltung |
startTime | Date | Datum und Uhrzeit des Beginns des Ereignisses |
endTime | Date | Datum und Uhrzeit des Endes des Ereignisses |
options | Object | ein JavaScript-Objekt, das die unten aufgeführten erweiterten Parameter angibt |
Erweiterte Parameter
Name | Typ | Beschreibung |
---|---|---|
description | String | die Beschreibung des Ereignisses |
location | String | den Ort der Veranstaltung |
guests | String | eine durch Kommas getrennte Liste von E-Mail-Adressen, die als Gäste hinzugefügt werden sollen |
sendInvites | Boolean | ob E-Mail-Einladungen gesendet werden sollen (Standard: false ) |
Rückflug
CalendarEvent
– das erstellte Ereignis
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
createEventFromDescription(description)
Erstellt ein Ereignis aus einer Beschreibung im freien Format.
Die Beschreibung sollte dasselbe Format wie die Funktion Schnell hinzufügen der Benutzeroberfläche haben.
// Creates a new event and logs its ID. const event = CalendarApp.getDefaultCalendar().createEventFromDescription( 'Lunch with Mary, Friday at 1PM', ); Logger.log(`Event ID: ${event.getId()}`);
Parameter
Name | Typ | Beschreibung |
---|---|---|
description | String | eine kostenlose Beschreibung des Ereignisses |
Rückflug
CalendarEvent
– das erstellte Ereignis
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
createEventSeries(title, startTime, endTime, recurrence)
Erstellt eine neue Ereignisreihe.
// Creates an event series for a team meeting, taking place every Tuesday and // Thursday in 2013. const eventSeries = CalendarApp.getDefaultCalendar().createEventSeries( 'Team Meeting', new Date('January 1, 2013 03:00:00 PM EST'), new Date('January 1, 2013 04:00:00 PM EST'), CalendarApp.newRecurrence() .addWeeklyRule() .onlyOnWeekdays( [CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY]) .until(new Date('January 1, 2014')), ); Logger.log(`Event Series ID: ${eventSeries.getId()}`);
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | den Titel der Ereignisse in der Reihe |
startTime | Date | Datum und Uhrzeit des Beginns des ersten Ereignisses in der Reihe |
endTime | Date | Datum und Uhrzeit, an dem das erste Ereignis der Reihe endet |
recurrence | EventRecurrence | die Wiederholungseinstellungen der Ereignisreihe |
Rückflug
CalendarEventSeries
– die erstellte Ereignisreihe
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
createEventSeries(title, startTime, endTime, recurrence, options)
Erstellt eine neue Ereignisreihe.
// Creates an event series for a team meeting, taking place every Tuesday and // Thursday in 2013. const eventSeries = CalendarApp.getDefaultCalendar().createEventSeries( 'Team Meeting', new Date('January 1, 2013 03:00:00 PM EST'), new Date('January 1, 2013 04:00:00 PM EST'), CalendarApp.newRecurrence() .addWeeklyRule() .onlyOnWeekdays( [CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY]) .until(new Date('January 1, 2014')), {location: 'Conference Room'}, ); Logger.log(`Event Series ID: ${eventSeries.getId()}`);
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | den Titel der Ereignisse in der Reihe |
startTime | Date | Datum und Uhrzeit des Beginns des ersten Ereignisses in der Reihe |
endTime | Date | Datum und Uhrzeit, an dem das erste Ereignis der Reihe endet |
recurrence | EventRecurrence | die Wiederholungseinstellungen der Ereignisreihe |
options | Object | ein JavaScript-Objekt, das die unten aufgeführten erweiterten Parameter angibt |
Erweiterte Parameter
Name | Typ | Beschreibung |
---|---|---|
description | String | die Beschreibung der Ereignisse in der Reihe |
location | String | den Ort der Ereignisse in der Reihe |
guests | String | eine durch Kommas getrennte Liste von E-Mail-Adressen, die den Terminen in der Reihe als Gäste hinzugefügt werden sollen |
sendInvites | Boolean | ob E-Mail-Einladungen gesendet werden sollen (Standard: false ) |
Rückflug
CalendarEventSeries
– die erstellte Ereignisreihe
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
getAllCalendars()
Alle Kalender abrufen, die dem Nutzer gehören oder die er abonniert hat
// Determines how many calendars the user can access. const calendars = CalendarApp.getAllCalendars(); Logger.log( 'This user owns or is subscribed to %s calendars.', calendars.length, );
Rückflug
Calendar[]
: alle Kalender, auf die der Nutzer zugreifen kann
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
getAllOwnedCalendars()
Alle Kalender abrufen, deren Inhaber der Nutzer ist.
// Determines how many calendars the user owns. const calendars = CalendarApp.getAllOwnedCalendars(); Logger.log('This user owns %s calendars.', calendars.length);
Rückflug
Calendar[]
– alle Kalender, die dem Nutzer gehören
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
getCalendarById(id)
Ruft den Kalender mit der angegebenen ID ab.
// Gets the public calendar "US Holidays" by ID. const calendar = CalendarApp.getCalendarById( 'en.usa#holiday@group.v.calendar.google.com', ); Logger.log('The calendar is named "%s".', calendar.getName());
Parameter
Name | Typ | Beschreibung |
---|---|---|
id | String | die Kalender-ID |
Rückflug
Calendar
: Der Kalender mit der angegebenen ID oder null
, wenn der Kalender nicht existiert, der Nutzer keinen Zugriff darauf hat oder der Nutzer den Kalender nicht abonniert hat
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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
getCalendarsByName(name)
Alle Kalender mit einem bestimmten Namen abrufen, die dem Nutzer gehören oder die er abonniert hat. Bei Namen wird die Groß- und Kleinschreibung nicht berücksichtigt.
// Gets the public calendar named "US Holidays". const calendars = CalendarApp.getCalendarsByName('US Holidays'); Logger.log('Found %s matching calendars.', calendars.length);
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | den Namen des Kalenders |
Rückflug
Calendar[]
: alle Kalender mit diesem Namen, auf die der Nutzer zugreifen kann
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()
Die Farbe des Kalenders.
// 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);
Rückflug
String
: Hexadezimal-Farbcode („#rrggbb“)
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
getDefaultCalendar()
Ruft den Standardkalender des Nutzers ab.
// Determines the time zone of the user's default calendar. const calendar = CalendarApp.getDefaultCalendar(); Logger.log( 'My default calendar is set to the time zone "%s".', calendar.getTimeZone(), );
Rückflug
Calendar
: Standardkalender des Nutzers
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 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);
Rückflug
String
: Die Beschreibung dieses 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
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 getEventById(iCalId)
aufrufen, wird nur ein Termin im Standardkalender zurückgegeben.
Mehrere Ereignisse können dieselbe ID haben, wenn sie Teil einer Ereignisreihe sind. In diesem Fall gibt diese Methode nur das erste Ereignis aus dieser Reihe 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. |
Rückflug
CalendarEvent
: Das Ereignis mit der angegebenen ID oder null
, wenn das Ereignis nicht vorhanden ist oder der Nutzer keinen Zugriff darauf hat.
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
getEventSeriesById(iCalId)
Ruft die Ereignisreihe mit der angegebenen ID ab. Wenn die angegebene ID für eine einzelne CalendarEvent
gilt, wird eine CalendarEventSeries
mit einem einzelnen Ereignis in der Reihe zurückgegeben. Wenn die Terminserie zu einem anderen Kalender als dem Standardkalender gehört, muss diese Methode von diesem CalendarApp
aufgerufen werden. Wenn getEventSeriesById(iCalId)
direkt aufgerufen wird, wird nur eine Terminserie 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 Ereignisreihe. |
Rückflug
CalendarEventSeries
: Die Reihe mit der angegebenen ID oder null
, wenn die Reihe nicht vorhanden ist oder der Nutzer keinen Zugriff darauf hat.
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
getEvents(startTime, endTime)
Hiermit werden alle Ereignisse abgerufen, die in einem bestimmten Zeitraum auftreten.
Mit dieser Methode werden Ereignisse zurückgegeben, die im angegebenen Zeitraum beginnen, enden oder den Zeitraum umfassen. Wenn keine Zeitzone angegeben ist, werden die Zeitwerte im Kontext der Zeitzone des Scripts interpretiert, die sich von der Zeitzone des Kalenders unterscheiden kann.
// Determines how many events are happening in the next two hours. const now = new Date(); const twoHoursFromNow = new Date(now.getTime() + 2 * 60 * 60 * 1000); const events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow); Logger.log(`Number of events: ${events.length}`);
Parameter
Name | Typ | Beschreibung |
---|---|---|
startTime | Date | den Beginn des Zeitraums |
endTime | Date | das Ende des Zeitraums, nicht inklusive |
Rückflug
CalendarEvent[]
: Ereignisse, die innerhalb des Zeitraums auftreten
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
getEvents(startTime, endTime, options)
Hiermit werden alle Ereignisse abgerufen, die in einem bestimmten Zeitraum auftreten und die angegebenen Kriterien erfüllen.
Mit dieser Methode werden Ereignisse zurückgegeben, die im angegebenen Zeitraum beginnen, enden oder den Zeitraum umfassen. Wenn keine Zeitzone angegeben ist, werden die Zeitwerte im Kontext der Zeitzone des Scripts interpretiert, die sich von der Zeitzone des Kalenders unterscheiden kann.
Beachten Sie, dass das Filtern nach author
, search
oder statusFilters
nach dem Anwenden von start
und max
erfolgt. Das bedeutet, dass die Anzahl der zurückgegebenen Ereignisse unter max
liegen kann, auch wenn weitere Ereignisse die Kriterien erfüllen.
// Determines how many events are happening in the next two hours that contain // the term "meeting". const now = new Date(); const twoHoursFromNow = new Date(now.getTime() + 2 * 60 * 60 * 1000); const events = CalendarApp.getDefaultCalendar().getEvents( now, twoHoursFromNow, {search: 'meeting'}, ); Logger.log(`Number of events: ${events.length}`);
Parameter
Name | Typ | Beschreibung |
---|---|---|
startTime | Date | den Beginn des Zeitraums |
endTime | Date | das Ende des Zeitraums, nicht inklusive |
options | Object | ein JavaScript-Objekt, das die unten aufgeführten erweiterten Parameter angibt |
Erweiterte Parameter
Name | Typ | Beschreibung |
---|---|---|
start | Integer | Der Index des ersten Ereignisses, das zurückgegeben werden soll. |
max | Integer | Die maximale Anzahl der Ereignisse, die zurückgegeben werden sollen. |
author | String | eine E-Mail-Adresse, mit der Ergebnisse nach dem Ersteller des Ereignisses gefiltert werden |
search | String | Volltextsuchabfrage, mit der Ergebnisse gefiltert werden |
statusFilters[] | GuestStatus | ein Array von Status, mit dem Ergebnisse gefiltert werden |
Rückflug
CalendarEvent[]
: Ereignisse, die im angegebenen Zeitraum stattfinden und den Kriterien entsprechen
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
getEventsForDay(date)
Alle Ereignisse abrufen, die an einem bestimmten Tag stattfinden
Mit dieser Methode werden Ereignisse zurückgegeben, die an dem angegebenen Tag beginnen, an dem angegebenen Tag enden oder den angegebenen Tag umfassen.
Hinweis: Es wird nur der Datumsteil des Datumsobjekts verwendet. Der Uhrzeitteil wird ignoriert. Das Datum wird in der Zeitzone des Kalenders von Mitternacht des betreffenden Tages bis Mitternacht des Folgetages interpretiert.
// Determines how many events are happening today. const today = new Date(); const events = CalendarApp.getDefaultCalendar().getEventsForDay(today); Logger.log(`Number of events: ${events.length}`);
Parameter
Name | Typ | Beschreibung |
---|---|---|
date | Date | Das Datum, für das Ereignisse abgerufen werden sollen (nur der Tag wird verwendet, die Uhrzeit wird ignoriert) |
Rückflug
CalendarEvent[]
– die Ereignisse, die am angegebenen Datum stattfinden
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
getEventsForDay(date, options)
Hiermit werden alle Ereignisse abgerufen, die an einem bestimmten Tag auftreten und die angegebenen Kriterien erfüllen.
Mit dieser Methode werden Ereignisse zurückgegeben, die an dem angegebenen Tag beginnen, an dem angegebenen Tag enden oder den angegebenen Tag umfassen.
Hinweis: Es wird nur der Datumsteil des Datumsobjekts verwendet. Der Uhrzeitteil wird ignoriert. Das Datum wird in der Zeitzone des Kalenders von Mitternacht des betreffenden Tages bis Mitternacht des Folgetages interpretiert.
Das Filtern nach author
, search
oder statusFilters
erfolgt nach dem Anwenden von start
und max
. Das bedeutet, dass die Anzahl der zurückgegebenen Ereignisse unter max
liegen kann, auch wenn weitere Ereignisse die Kriterien erfüllen.
// Determines how many events are happening today and contain the term // "meeting". const today = new Date(); const events = CalendarApp.getDefaultCalendar().getEventsForDay(today, { search: 'meeting', }); Logger.log(`Number of events: ${events.length}`);
Parameter
Name | Typ | Beschreibung |
---|---|---|
date | Date | Das Datum, für das Ereignisse abgerufen werden sollen (nur der Tag wird verwendet, die Uhrzeit wird ignoriert) |
options | Object | Erweiterte Filteroptionen |
Erweiterte Parameter
Name | Typ | Beschreibung |
---|---|---|
start | Integer | Der Index des ersten Ereignisses, das zurückgegeben werden soll. |
max | Integer | Die maximale Anzahl der Ereignisse, die zurückgegeben werden sollen. |
author | String | eine E-Mail-Adresse, mit der Ergebnisse nach dem Ersteller des Ereignisses gefiltert werden |
search | String | Volltextsuchabfrage, mit der Ergebnisse gefiltert werden |
statusFilters[] | GuestStatus | ein Array von Status, mit dem Ergebnisse gefiltert werden |
Rückflug
CalendarEvent[]
: Ereignisse, die am angegebenen Datum auftreten und den Kriterien entsprechen
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()
Ruft die ID des Kalenders ab. Die ID für den Standardkalender eines Nutzers ist seine 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);
Rückflug
String
: Die ID des 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
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);
Rückflug
String
: Der Name dieses 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
getOwnedCalendarById(id)
Ruft den Kalender mit der angegebenen ID ab, wenn der Nutzer der Inhaber ist.
Wenn Sie eine Kalender-ID ermitteln möchten, klicken Sie in Google Kalender auf den Pfeil neben dem Namen des Kalenders und wählen Sie Kalendereinstellungen aus. Die ID wird unten auf der Seite „Einstellungen“ angezeigt.
// Gets a (non-existent) private calendar by ID. const calendar = CalendarApp.getOwnedCalendarById( '123456789@group.calendar.google.com', ); Logger.log('The calendar is named "%s".', calendar.getName());
Parameter
Name | Typ | Beschreibung |
---|---|---|
id | String | die Kalender-ID |
Rückflug
Calendar
: Der Kalender mit der angegebenen ID oder null
, wenn der Kalender nicht vorhanden ist oder nicht dem Nutzer gehört
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
getOwnedCalendarsByName(name)
Hiermit werden alle Kalender mit einem bestimmten Namen abgerufen, die dem Nutzer gehören. Bei Namen wird die Groß- und Kleinschreibung nicht berücksichtigt.
// Gets a private calendar named "Travel Plans". const calendars = CalendarApp.getOwnedCalendarsByName('Travel Plans'); Logger.log('Found %s matching calendars.', calendars.length);
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | den Namen des Kalenders |
Rückflug
Calendar[]
– alle Kalender mit diesem Namen, deren Inhaber der Nutzer 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
getTimeZone()
Ruft die Zeitzone 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 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);
Rückflug
String
: Die Zeitzone im Langformat (z. B. „America/New_York“, wie von Joda.org aufgeführt).
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
isHidden()
Bestimmt, ob der Kalender in der Benutzeroberfläche ausgeblendet 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 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);
Rückflug
Boolean
– true
, wenn der Kalender in der Benutzeroberfläche ausgeblendet ist, 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
isMyPrimaryCalendar()
Bestimmt, ob der Kalender der primäre Kalender für den effektiven Nutzer 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);
Rückflug
Boolean
– true
, wenn der Kalender der Standardkalender für den effektiven Nutzer ist; 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
isOwnedByMe()
Gibt an, 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());
Rückflug
Boolean
– true
, wenn Sie der Inhaber des Kalenders sind, 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
isSelected()
Bestimmt, ob die Termine des Kalenders in 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());
Rückflug
Boolean
– true
, wenn die Termine des Kalenders in der Benutzeroberfläche angezeigt werden; 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
newRecurrence()
Erstellt ein neues Wiederholungsobjekt, mit dem Regeln für die Wiederholung von Ereignissen erstellt werden können.
// Creates an event series for a no-meetings day, taking place every Wednesday // in 2013. const recurrence = CalendarApp.newRecurrence() .addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014')); const eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries( 'No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), recurrence, ); Logger.log(`Event Series ID: ${eventSeries.getId()}`);
Rückflug
EventRecurrence
– neues Wiederholungsobjekt ohne festgelegte Regeln (funktioniert wie eine wöchentliche Wiederholung)
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
setColor(color)
Hiermit wird die Farbe des Kalenders festgelegt.
// 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 | CalendarApp.Color oder ein Hexadezimalfarbcode („#rrggbb“). |
Rückflug
Calendar
: Dieser Kalender 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
setDescription(description)
Hiermit wird die Beschreibung eines Kalenders festgelegt.
// 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 |
Rückflug
Calendar
– dieser Kalender 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
setHidden(hidden)
Legt fest, ob der Kalender in der Benutzeroberfläche sichtbar ist.
Parameter
Name | Typ | Beschreibung |
---|---|---|
hidden | Boolean | true , um den Kalender in der Benutzeroberfläche auszublenden, oder false , um ihn einzublenden |
Rückflug
Calendar
– dieser Kalender 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
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 | den neuen Namen |
Rückflug
Calendar
– dieser Kalender für die Verkettung
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setSelected(selected)
Hiermit wird festgelegt, ob die Termine des Kalenders in 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, oder false , um sie auszublenden |
Rückflug
Calendar
– dieser Kalender 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
setTimeZone(timeZone)
Hier legen Sie 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 Langformat (z. B. „America/New_York“, wie von Joda.org aufgeführt). |
Rückflug
Calendar
: Dieser Kalender 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
subscribeToCalendar(id)
Der Nutzer abonniert den Kalender mit der angegebenen ID, sofern er zum Abonnieren berechtigt ist.
// Subscribe to the calendar "US Holidays". const calendar = CalendarApp.subscribeToCalendar( 'en.usa#holiday@group.v.calendar.google.com', ); Logger.log('Subscribed to the calendar "%s".', calendar.getName());
Parameter
Name | Typ | Beschreibung |
---|---|---|
id | String | die ID des Kalenders, den Sie abonnieren möchten |
Rückflug
Calendar
– der neu abonnierte Kalender
Löst aus
Error
, wenn kein Kalender mit dieser ID vorhanden 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
subscribeToCalendar(id, options)
Der Nutzer abonniert den Kalender mit der angegebenen ID, sofern er zum Abonnieren berechtigt ist.
// Subscribe to the calendar "US Holidays", and set it to the color blue. const calendar = CalendarApp.subscribeToCalendar( 'en.usa#holiday@group.v.calendar.google.com', {color: CalendarApp.Color.BLUE}, ); Logger.log('Subscribed to the calendar "%s".', calendar.getName());
Parameter
Name | Typ | Beschreibung |
---|---|---|
id | String | Die ID des Kalenders, den Sie abonnieren möchten. |
options | Object | Ein JavaScript-Objekt, das die unten aufgeführten erweiterten Parameter angibt. |
Erweiterte Parameter
Name | Typ | Beschreibung |
---|---|---|
color | String | Ein Hexadezimal-Farbcode („#rrggbb“) oder ein Wert aus CalendarApp.Colors . |
hidden | Boolean | Ob der Kalender in der Benutzeroberfläche ausgeblendet ist (Standard: false ). |
selected | Boolean | Gibt an, ob die Termine des Kalenders in der Benutzeroberfläche angezeigt werden. Standardmäßig: true , wenn auch color angegeben ist, andernfalls false . |
Rückflug
Calendar
: Der neu abonnierte Kalender.
Löst aus
Error
, wenn kein Kalender mit dieser ID vorhanden 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