Class CalendarApp

KalenderApp

Ermöglicht 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, die dem Nutzer gehören oder die er abonniert hat.

Attribute

AttributTypBeschreibung
ColorColorEine Enumeration, die die benannten Farben darstellt, die im Kalenderdienst verfügbar sind.
EventColorEventColorEin Enum, das die benannten Terminfarben darstellt, die im Kalenderdienst verfügbar sind.
EventTransparencyEventTransparencyDie Aufzählung EventTransparency.
EventTypeEventTypeDie Aufzählung EventType.
GuestStatusGuestStatusEin Enum, das die Status darstellt, die ein Gast für einen Termin haben kann.
MonthMonthEin Enum, das die Monate des Jahres darstellt.
VisibilityVisibilityEin Enum-Wert, der die Sichtbarkeit eines Ereignisses darstellt.
WeekdayWeekdayEin Enum, das die Wochentage darstellt.

Methoden

MethodeRückgabetypKurzbeschreibung
createAllDayEvent(title, date)CalendarEventErstellt einen neuen ganztägigen Termin.
createAllDayEvent(title, startDate, endDate)CalendarEventErstellt einen neuen ganztägigen Termin, der sich über mehrere Tage erstrecken kann.
createAllDayEvent(title, startDate, endDate, options)CalendarEventErstellt einen neuen ganztägigen Termin, der sich über mehrere Tage erstrecken kann.
createAllDayEvent(title, date, options)CalendarEventErstellt einen neuen ganztägigen Termin.
createAllDayEventSeries(title, startDate, recurrence)CalendarEventSeriesErstellt eine neue ganztägige Terminserie.
createAllDayEventSeries(title, startDate, recurrence, options)CalendarEventSeriesErstellt eine neue ganztägige Terminserie.
createCalendar(name)CalendarErstellt einen neuen Kalender, der dem Nutzer gehört.
createCalendar(name, options)CalendarErstellt einen neuen Kalender, der dem Nutzer gehört.
createEvent(title, startTime, endTime)CalendarEventErstellt einen neuen Termin.
createEvent(title, startTime, endTime, options)CalendarEventErstellt einen neuen Termin.
createEventFromDescription(description)CalendarEventErstellt einen Termin aus einer Beschreibung im freien Format.
createEventSeries(title, startTime, endTime, recurrence)CalendarEventSeriesErstellt eine neue Terminserie.
createEventSeries(title, startTime, endTime, recurrence, options)CalendarEventSeriesErstellt eine neue Terminserie.
getAllCalendars()Calendar[]Ruft alle Kalender ab, die dem Nutzer gehören oder die er abonniert hat.
getAllOwnedCalendars()Calendar[]Ruft alle Kalender ab, deren Inhaber der Nutzer ist.
getCalendarById(id)Calendar|nullRuft den Kalender mit der angegebenen ID ab.
getCalendarsByName(name)Calendar[]Ruft alle Kalender mit einem bestimmten Namen ab, deren Inhaber der Nutzer ist oder die er abonniert hat.
getColor()StringRuft die Farbe des Kalenders ab.
getDefaultCalendar()CalendarRuft den Standardkalender des Nutzers ab.
getDescription()StringRuft die Beschreibung des Kalenders ab.
getEventById(iCalId)CalendarEventRuft das Ereignis mit der angegebenen ID ab.
getEventSeriesById(iCalId)CalendarEventSeriesRuft die Eventreihe 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 in einem bestimmten Zeitraum auftreten und die angegebenen Kriterien erfüllen.
getEventsForDay(date)CalendarEvent[]Ruft alle Ereignisse ab, die an einem bestimmten Tag stattfinden.
getEventsForDay(date, options)CalendarEvent[]Ruft alle Ereignisse ab, die an einem bestimmten Tag auftreten und bestimmte Kriterien erfüllen.
getId()StringRuft die ID des Kalenders ab.
getName()StringRuft den Namen des Kalenders ab.
getOwnedCalendarById(id)Calendar|nullRuft den Kalender mit der angegebenen ID ab, sofern der Nutzer der Inhaber ist.
getOwnedCalendarsByName(name)Calendar[]Ruft alle Kalender mit einem bestimmten Namen ab, die dem Nutzer gehören.
getTimeZone()StringRuft die Zeitzone des Kalenders ab.
isHidden()BooleanGibt an, ob der Kalender in der Benutzeroberfläche ausgeblendet ist.
isMyPrimaryCalendar()BooleanGibt an, ob der Kalender der primäre Kalender für den effektiven Nutzer ist.
isOwnedByMe()BooleanGibt an, ob der Kalender Ihnen gehört.
isSelected()BooleanGibt an, ob die Termine des Kalenders in der Benutzeroberfläche angezeigt werden.
newRecurrence()EventRecurrenceErstellt ein neues Wiederholungsobjekt, mit dem Regeln für die Wiederholung von Ereignissen erstellt werden können.
setColor(color)CalendarLegt die Farbe des Kalenders fest.
setDescription(description)CalendarLegt die Beschreibung eines Kalenders fest.
setHidden(hidden)CalendarLegt fest, ob der Kalender in der Benutzeroberfläche sichtbar ist.
setName(name)CalendarLegt den Namen des Kalenders fest.
setSelected(selected)CalendarLegt fest, ob die Termine des Kalenders in der Benutzeroberfläche angezeigt werden.
setTimeZone(timeZone)CalendarLegt die Zeitzone des Kalenders fest.
subscribeToCalendar(id)CalendarAbonniert den Kalender mit der angegebenen ID für den Nutzer, sofern der Nutzer das darf.
subscribeToCalendar(id, options)CalendarAbonniert den Kalender mit der angegebenen ID für den Nutzer, sofern der Nutzer das darf.

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

NameTypBeschreibung
titleStringDer Titel des Ereignisses.
dateDateDas Datum des Ereignisses (nur der Tag wird verwendet; die Uhrzeit wird ignoriert).

Rückflug

CalendarEvent: Das erstellte Ereignis.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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

NameTypBeschreibung
titleStringDer Titel des Ereignisses.
startDateDateDas Datum, an dem das Ereignis beginnt. Es wird nur der Tag verwendet, die Uhrzeit wird ignoriert.
endDateDateDas Datum, an dem das Ereignis endet. Es wird nur der Tag verwendet, die Uhrzeit wird ignoriert. Das Enddatum ist exklusiv.

Rückflug

CalendarEvent: Das erstellte Ereignis.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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

NameTypBeschreibung
titleStringDer Titel des Ereignisses.
startDateDateDas Datum, an dem das Ereignis beginnt. Es wird nur der Tag verwendet, die Uhrzeit wird ignoriert.
endDateDateDas Datum, an dem das Ereignis endet. Es wird nur der Tag verwendet, die Uhrzeit wird ignoriert. Das Enddatum ist exklusiv.
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter wie unten aufgeführt angibt.

Erweiterte Parameter

NameTypBeschreibung
descriptionStringDie Beschreibung des Ereignisses.
locationStringDer Veranstaltungsort.
guestsStringEine durch Kommas getrennte Liste mit E‑Mail-Adressen, die als Gäste hinzugefügt werden sollen.
sendInvitesBooleanGibt an, ob E‑Mail-Einladungen gesendet werden sollen (Standard: false).

Rückflug

CalendarEvent: Das erstellte Ereignis.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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

NameTypBeschreibung
titleStringDer Titel des Ereignisses.
dateDateDas Datum des Ereignisses (nur der Tag wird verwendet; die Uhrzeit wird ignoriert).
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter wie unten aufgeführt angibt.

Erweiterte Parameter

NameTypBeschreibung
descriptionStringDie Beschreibung des Ereignisses.
locationStringDer Veranstaltungsort.
guestsStringEine durch Kommas getrennte Liste mit E‑Mail-Adressen, die als Gäste hinzugefügt werden sollen.
sendInvitesBooleanGibt an, ob E‑Mail-Einladungen gesendet werden sollen (Standard: false).

Rückflug

CalendarEvent: Das erstellte Ereignis.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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.
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

NameTypBeschreibung
titleStringTitel der Termine in der Serie
startDateDateDas Datum des ersten Ereignisses in der Reihe. Es wird nur der Tag verwendet, die Uhrzeit wird ignoriert.
recurrenceEventRecurrencedie Einstellungen für das Wiederholen der Terminserie

Rückflug

CalendarEventSeries: Die erstellte Terminserie

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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.
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

NameTypBeschreibung
titleStringTitel der Termine in der Serie
startDateDateDas Datum des ersten Ereignisses in der Reihe. Es wird nur der Tag verwendet, die Uhrzeit wird ignoriert.
recurrenceEventRecurrencedie Einstellungen für das Wiederholen der Terminserie
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt (siehe unten)

Erweiterte Parameter

NameTypBeschreibung
descriptionStringdie Beschreibung der Termine in der Serie
locationStringOrt der Termine in der Serie
guestsStringEine durch Kommas getrennte Liste mit E‑Mail-Adressen, die als Gäste zu den Terminen in der Serie hinzugefügt werden sollen
sendInvitesBooleanob Einladungs-E‑Mails gesendet werden sollen (Standard: false)

Rückflug

CalendarEventSeries: Die erstellte Terminserie

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createCalendar(name)

Erstellt einen neuen Kalender, der dem Nutzer gehört.

// 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

NameTypBeschreibung
nameStringDer Name des neuen Kalenders

Rückflug

Calendar – der neu erstellte Kalender

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createCalendar(name, options)

Erstellt einen neuen Kalender, der dem Nutzer gehört.

// 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

NameTypBeschreibung
nameStringDer Name des neuen Kalenders
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt (siehe unten)

Erweiterte Parameter

NameTypBeschreibung
locationStringSpeicherort des Kalenders
descriptionStringdie Beschreibung des Kalenders
timeZoneStringDie Zeitzone, die für den Kalender festgelegt werden soll, im Format „lang“ (z.B. „America/New_York“ (wie auf Joda.org aufgeführt)
colorStringein Hex-Farbcode („#rrggbb“) oder ein Wert aus CalendarApp.Colors
hiddenBooleanob der Kalender in der Benutzeroberfläche ausgeblendet ist (Standard: false)
selectedBooleanob 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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. Diese kann sich von der Zeitzone des Kalenders unterscheiden.

// 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

NameTypBeschreibung
titleStringTitel des Termins
startTimeDateDatum und Uhrzeit für den Start des Ereignisses
endTimeDateDatum und Uhrzeit, zu der das Ereignis endet

Rückflug

CalendarEvent: Das erstellte Ereignis

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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. Diese kann sich von der Zeitzone des Kalenders unterscheiden.

// 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

NameTypBeschreibung
titleStringTitel des Termins
startTimeDateDatum und Uhrzeit für den Start des Ereignisses
endTimeDateDatum und Uhrzeit, zu der das Ereignis endet
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt (siehe unten)

Erweiterte Parameter

NameTypBeschreibung
descriptionStringdie Beschreibung des Ereignisses
locationStringOrt des Termins
guestsStringEine durch Kommas getrennte Liste mit E‑Mail-Adressen, die als Gäste hinzugefügt werden sollen
sendInvitesBooleanob Einladungs-E‑Mails gesendet werden sollen (Standard: false)

Rückflug

CalendarEvent: Das erstellte Ereignis

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

createEventFromDescription(description)

Erstellt einen Termin aus einer Beschreibung im freien Format.

Die Beschreibung sollte dasselbe Format wie die Funktion Schnelles Hinzufügen der Benutzeroberfläche verwenden.

// 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

NameTypBeschreibung
descriptionStringEine Beschreibung des Ereignisses in kostenloser Form

Rückflug

CalendarEvent: Das erstellte Ereignis

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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.
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

NameTypBeschreibung
titleStringTitel der Termine in der Serie
startTimeDateDatum und Uhrzeit des Beginns des ersten Ereignisses in der Reihe
endTimeDateDatum und Uhrzeit des Endes des ersten Ereignisses in der Reihe
recurrenceEventRecurrencedie Einstellungen für das Wiederholen der Terminserie

Rückflug

CalendarEventSeries: Die erstellte Terminserie

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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.
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

NameTypBeschreibung
titleStringTitel der Termine in der Serie
startTimeDateDatum und Uhrzeit des Beginns des ersten Ereignisses in der Reihe
endTimeDateDatum und Uhrzeit des Endes des ersten Ereignisses in der Reihe
recurrenceEventRecurrencedie Einstellungen für das Wiederholen der Terminserie
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt (siehe unten)

Erweiterte Parameter

NameTypBeschreibung
descriptionStringdie Beschreibung der Termine in der Serie
locationStringOrt der Termine in der Serie
guestsStringEine durch Kommas getrennte Liste mit E‑Mail-Adressen, die als Gäste zu den Terminen in der Serie hinzugefügt werden sollen
sendInvitesBooleanob Einladungs-E‑Mails gesendet werden sollen (Standard: false)

Rückflug

CalendarEventSeries: Die erstellte Terminserie

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

getAllCalendars()

Ruft alle Kalender ab, 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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()

Ruft alle Kalender ab, 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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

NameTypBeschreibung
idStringdie Kalender-ID

Rückflug

Calendar|null – der Kalender mit der angegebenen ID oder null, wenn der Kalender nicht vorhanden ist, der Nutzer nicht darauf zugreifen kann oder der Nutzer den Kalender nicht abonniert hat

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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)

Ruft alle Kalender mit einem bestimmten Namen ab, deren Inhaber der Nutzer ist 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

NameTypBeschreibung
nameStringden Kalendernamen

Rückflug

Calendar[] – alle Kalender mit diesem Namen, auf die der Nutzer zugreifen kann

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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()

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);

Rückflug

String: Ein hexadezimaler Farbstring („#rrggbb“).

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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 – der Standardkalender des Nutzers

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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 Serie zu einem anderen Kalender als dem Standardkalender gehört, muss diese Methode über diesen Kalender aufgerufen werden. Wenn Sie nur getEventById(iCalId) aufrufen, wird ein Termin im Standardkalender zurückgegeben.

Mehrere Ereignisse können dieselbe ID haben, wenn sie Teil einer Veranstaltungsreihe 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

NameTypBeschreibung
iCalIdStringID des Ereignisses.

Rückflug

CalendarEvent – Das Ereignis mit der angegebenen ID oder null, wenn das Ereignis nicht vorhanden ist oder der Nutzer nicht darauf zugreifen kann.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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 Eventreihe 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 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

NameTypBeschreibung
iCalIdStringID der Eventreihe.

Rückflug

CalendarEventSeries – Die Serie mit der angegebenen ID oder null, wenn die Serie nicht vorhanden ist oder der Nutzer nicht darauf zugreifen kann.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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 im angegebenen Zeitraum beginnen, im Zeitraum enden oder den Zeitraum umfassen. Wenn keine Zeitzone angegeben ist, werden die Zeitwerte im Kontext der Zeitzone des Skripts interpretiert. Diese kann sich von der Zeitzone des Kalenders unterscheiden.

// 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

NameTypBeschreibung
startTimeDateBeginn des Zeitraums
endTimeDateDas Ende des Zeitraums (nicht eingeschlossen)

Rückflug

CalendarEvent[] – die Ereignisse, die im Zeitraum auftreten

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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 in einem bestimmten Zeitraum auftreten und die angegebenen Kriterien erfüllen.

Diese Methode gibt Ereignisse zurück, die im angegebenen Zeitraum beginnen, im Zeitraum enden oder den Zeitraum umfassen. Wenn keine Zeitzone angegeben ist, werden die Zeitwerte im Kontext der Zeitzone des Skripts interpretiert. Diese kann sich von der Zeitzone des Kalenders unterscheiden.

Das Filtern nach author, search oder statusFilters erfolgt nach dem Anwenden von start und max. Das bedeutet, dass die Anzahl der zurückgegebenen Ereignisse möglicherweise geringer als max ist, obwohl zusätzliche 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

NameTypBeschreibung
startTimeDateBeginn des Zeitraums
endTimeDateDas Ende des Zeitraums (nicht eingeschlossen)
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt (siehe unten)

Erweiterte Parameter

NameTypBeschreibung
startIntegerDer Index des ersten zurückzugebenden Ereignisses
maxIntegerdie maximale Anzahl der zurückzugebenden Ereignisse
authorStringEine E-Mail-Adresse, mit der Ergebnisse nach dem Ersteller des Ereignisses gefiltert werden können
searchStringEine Volltextsuchanfrage, mit der Ergebnisse gefiltert werden
statusFilters[]GuestStatusEin Array von Status, mit denen Ergebnisse gefiltert werden

Rückflug

CalendarEvent[]: die Ereignisse, die im Zeitraum stattfinden und den Kriterien entsprechen

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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 stattfinden.

Diese Methode gibt Ereignisse zurück, wenn sie am angegebenen Tag beginnen, enden oder den Tag umfassen.

Es wird nur der Datumsanteil des Date-Objekts verwendet. Der Zeitanteil wird ignoriert. Das Datum wird in der Zeitzone des Kalenders als Zeitraum von Mitternacht 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

NameTypBeschreibung
dateDateDas Datum, für das Ereignisse abgerufen werden sollen. Es wird nur der Tag verwendet, die Uhrzeit wird ignoriert.

Rückflug

CalendarEvent[] – die Ereignisse, die am angegebenen Datum stattfinden

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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 bestimmte Kriterien erfüllen.

Diese Methode gibt Ereignisse zurück, wenn sie am angegebenen Tag beginnen, enden oder den Tag umfassen.

Es wird nur der Datumsanteil des Date-Objekts verwendet. Der Zeitanteil wird ignoriert. Das Datum wird in der Zeitzone des Kalenders als Zeitraum von Mitternacht 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 möglicherweise geringer als max ist, obwohl zusätzliche 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

NameTypBeschreibung
dateDateDas Datum, für das Ereignisse abgerufen werden sollen. Es wird nur der Tag verwendet, die Uhrzeit wird ignoriert.
optionsObjecterweiterte Filteroptionen

Erweiterte Parameter

NameTypBeschreibung
startIntegerDer Index des ersten zurückzugebenden Ereignisses
maxIntegerdie maximale Anzahl der zurückzugebenden Ereignisse
authorStringEine E-Mail-Adresse, mit der Ergebnisse nach dem Ersteller des Ereignisses gefiltert werden können
searchStringEine Volltextsuchanfrage, mit der Ergebnisse gefiltert werden
statusFilters[]GuestStatusEin Array von Status, mit denen Ergebnisse gefiltert werden

Rückflug

CalendarEvent[]: Die Ereignisse, die am angegebenen Datum eintreten und den Kriterien entsprechen

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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, sofern der Nutzer der Inhaber ist.

Wenn Sie eine Kalender-ID aufrufen möchten, klicken Sie in Google Kalender neben dem Namen des Kalenders auf den Pfeil und wählen Sie Kalendereinstellungen aus. Die ID wird unten auf der Seite mit den 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

NameTypBeschreibung
idStringdie Kalender-ID

Rückflug

Calendar|null – der Kalender mit der angegebenen ID oder null, wenn der Kalender nicht vorhanden ist oder der Nutzer nicht der Inhaber ist

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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)

Ruft alle Kalender mit einem bestimmten Namen ab, 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

NameTypBeschreibung
nameStringden Kalendernamen

Rückflug

Calendar[] – alle Kalender mit diesem Namen, die dem Nutzer gehören

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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 Format „long“ (z. B. „America/New_York“, wie auf Joda.org aufgeführt).

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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()

Gibt an, 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 er nicht ausgeblendet ist.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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()

Gibt an, 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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 der Kalender Ihnen gehört.

// 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, wenn nicht.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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()

Gibt an, 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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 – ein neues Wiederholungsobjekt ohne festgelegte Regeln (verhält sich wie eine wöchentliche Wiederholung)

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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

NameTypBeschreibung
colorStringEin CalendarApp.Color oder ein hexadezimaler Farbstring („#rrggbb“).

Rückflug

Calendar: Dieser Kalender für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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

NameTypBeschreibung
descriptionStringdie Beschreibung dieses Kalenders

Rückflug

Calendar – dieser Kalender für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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

NameTypBeschreibung
hiddenBooleantrue – Kalender in der Benutzeroberfläche ausblenden; false – Kalender einblenden

Rückflug

Calendar – dieser Kalender für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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

NameTypBeschreibung
nameStringder neue Name

Rückflug

Calendar – dieser Kalender für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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 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

NameTypBeschreibung
selectedBooleantrue, um die Termine des Kalenders in der Benutzeroberfläche ein- oder auszublenden.false

Rückflug

Calendar – dieser Kalender für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche 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

NameTypBeschreibung
timeZoneStringDie Zeitzone im langen Format, z. B. „America/New_York“ (wie auf Joda.org aufgeführt).

Rückflug

Calendar: Dieser Kalender für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

subscribeToCalendar(id)

Abonniert den Kalender mit der angegebenen ID für den Nutzer, sofern der Nutzer das darf.

// 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

NameTypBeschreibung
idStringdie ID des Kalenders, der abonniert werden soll

Rückflug

Calendar: Der neu abonnierte Kalender

Löst

Error – wenn kein Kalender mit dieser ID vorhanden ist

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

subscribeToCalendar(id, options)

Abonniert den Kalender mit der angegebenen ID für den Nutzer, sofern der Nutzer das darf.

// 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

NameTypBeschreibung
idStringDie ID des Kalenders, der abonniert werden soll.
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter wie unten aufgeführt angibt.

Erweiterte Parameter

NameTypBeschreibung
colorStringEin hexadezimaler Farbstring („#rrggbb“) oder ein Wert aus CalendarApp.Colors.
hiddenBooleanGibt an, ob der Kalender in der Benutzeroberfläche ausgeblendet ist (Standard: false).
selectedBooleanGibt an, ob die Termine des Kalenders in der Benutzeroberfläche angezeigt werden (Standard: true, wenn auch color angegeben ist, andernfalls false).

Rückflug

Calendar: Der neu abonnierte Kalender.

Löst

Error – wenn kein Kalender mit dieser ID vorhanden ist

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche oder entsprechende Zugriffsbereiche aus der zugehörigen REST API:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds