Class CalendarApp

KalenderApp

Ermöglicht einem Skript, 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

PropertyTypBeschreibung
ColorColorEine Aufzählung, die die benannten Farben enthält, die im Kalenderdienst verfügbar sind.
EventColorEventColorEine Aufzählung, die die benannten Ereignisfarben im Kalenderdienst darstellt.
GuestStatusGuestStatusEine Aufzählung, die den Status eines Gasts für ein Ereignis darstellt.
MonthMonthEine Aufzählung, die die Monate des Jahres darstellt.
VisibilityVisibilityEin Enum-Wert, der die Sichtbarkeit eines Ereignisses darstellt.
WeekdayWeekdayEine Aufzählung, die die Wochentage darstellt.

Methoden

MethodeRückgabetypKurzbeschreibung
createAllDayEvent(title, date)CalendarEventErstellt einen neuen ganztägigen Termin
createAllDayEvent(title, startDate, endDate)CalendarEventDas erstellt einen neuen, ganztägigen Termin, der mehrere Tage umfassen kann.
createAllDayEvent(title, startDate, endDate, options)CalendarEventDas erstellt einen neuen, ganztägigen Termin, der mehrere Tage umfassen 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 ein neues Ereignis.
createEvent(title, startTime, endTime, options)CalendarEventErstellt ein neues Ereignis.
createEventFromDescription(description)CalendarEventErstellt ein Ereignis aus einer kostenlosen Beschreibung.
createEventSeries(title, startTime, endTime, recurrence)CalendarEventSeriesErstellt eine neue Ereignisserie.
createEventSeries(title, startTime, endTime, recurrence, options)CalendarEventSeriesErstellt eine neue Ereignisserie.
getAllCalendars()Calendar[]Ruft alle Kalender ab, die dem Nutzer gehören oder die er abonniert hat.
getAllOwnedCalendars()Calendar[]Ruft alle Kalender ab, deren Eigentümer der Nutzer ist
getCalendarById(id)CalendarRuft den Kalender mit der angegebenen ID ab
getCalendarsByName(name)Calendar[]Ruft alle Kalender mit einem bestimmten Namen ab, den der Nutzer besitzt oder 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 Ereignisserie mit der angegebenen ID ab
getEvents(startTime, endTime)CalendarEvent[]Ruft alle Ereignisse innerhalb eines bestimmten Zeitraums ab
getEvents(startTime, endTime, options)CalendarEvent[]Ruft alle Ereignisse ab, die innerhalb eines bestimmten Zeitraums auftreten und die angegebenen Kriterien erfüllen.
getEventsForDay(date)CalendarEvent[]Ruft alle Ereignisse ab, die an einem bestimmten Tag stattfinden.
getEventsForDay(date, options)CalendarEvent[]Ruft alle Ereignisse ab, die an einem bestimmten Tag stattfinden und bestimmte Kriterien erfüllen.
getId()StringRuft die ID des Kalenders ab
getName()StringRuft den Namen des Kalenders ab
getOwnedCalendarById(id)CalendarRuft den Kalender mit der angegebenen ID ab, sofern sie dem Nutzer gehört
getOwnedCalendarsByName(name)Calendar[]Ruft alle Kalender mit einem bestimmten Namen ab, der dem Nutzer gehört
getTimeZone()StringRuft die Zeitzone des Kalenders ab
isHidden()BooleanLegt fest, ob der Kalender auf der Benutzeroberfläche ausgeblendet wird.
isMyPrimaryCalendar()BooleanLegt fest, ob der Kalender der primäre Kalender für den betreffenden Nutzer ist.
isOwnedByMe()BooleanHier können Sie festlegen, ob Sie der Inhaber des Kalenders sind.
isSelected()BooleanLegt fest, ob die Termine des Kalenders auf der Benutzeroberfläche angezeigt werden
newRecurrence()EventRecurrenceErstellt ein neues Wiederholungsobjekt, mit dem Regeln für Wiederholungen 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 angezeigt wird.
setName(name)CalendarLegt den Namen des Kalenders fest.
setSelected(selected)CalendarLegt fest, ob die Termine des Kalenders auf der Benutzeroberfläche angezeigt werden
setTimeZone(timeZone)CalendarLegt die Zeitzone des Kalenders fest.
subscribeToCalendar(id)CalendarDer Nutzer abonniert den Kalender mit der angegebenen ID, sofern er berechtigt ist.
subscribeToCalendar(id, options)CalendarDer Nutzer abonniert den Kalender mit der angegebenen ID, sofern er 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.
var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Apollo 11 Landing',
    new Date('July 20, 1969'));
Logger.log('Event ID: ' + event.getId());

Parameter

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

Rückflug

CalendarEvent: Das erstellte Ereignis.

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden REST API:

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

createAllDayEvent(title, startDate, endDate)

Das erstellt einen neuen, ganztägigen Termin, der mehrere Tage umfassen kann.

// Creates an all-day event for the Woodstock festival (August 15th to 17th) and logs the ID.
var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Woodstock Festival',
    new Date('August 15, 1969'),
    new Date('August 18, 1969'));
Logger.log('Event ID: ' + event.getId());

Parameter

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

Rückflug

CalendarEvent: Das erstellte Ereignis.

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden REST API:

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

createAllDayEvent(title, startDate, endDate, options)

Das erstellt einen neuen, ganztägigen Termin, der mehrere Tage umfassen kann.

// Creates an all-day event for the Woodstock festival (August 15th to 17th) and logs the ID.
var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Woodstock Festival',
    new Date('August 15, 1969'),
    new Date('August 18, 1969'),
    {location: 'Bethel, White Lake, New York, U.S.', sendInvites: true});
Logger.log('Event ID: ' + event.getId());

Parameter

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

Erweiterte Parameter

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

Rückflug

CalendarEvent: Das erstellte Ereignis.

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden REST API:

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

createAllDayEvent(title, date, options)

Erstellt einen neuen ganztägigen Termin

// Creates an all-day event for the moon landing and logs the ID.
var event = CalendarApp.getDefaultCalendar().createAllDayEvent('Apollo 11 Landing',
    new Date('July 20, 1969'),
    {location: 'The Moon'});
Logger.log('Event ID: ' + event.getId());

Parameter

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

Erweiterte Parameter

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

Rückflug

CalendarEvent: Das erstellte Ereignis.

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden REST API:

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

createAllDayEventSeries(title, startDate, recurrence)

Erstellt eine neue ganztägige Terminserie.

// Creates an event series for a no-meetings day, taking place every Wednesday in 2013.
var eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries('No Meetings',
    new Date('January 2, 2013 03:00:00 PM EST'),
    CalendarApp.newRecurrence().addWeeklyRule()
        .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
        .until(new Date('January 1, 2014')));
Logger.log('Event Series ID: ' + eventSeries.getId());

Parameter

NameTypBeschreibung
titleStringTitel der Termine in der Serie
startDateDatedas Datum des ersten Ereignisses in der Serie (nur der Tag wird verwendet, die Zeit wird ignoriert)
recurrenceEventRecurrenceWiederholungseinstellungen der Veranstaltungsreihe

Rückflug

CalendarEventSeries: Die erstellte Ereignisserie

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden REST API:

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

createAllDayEventSeries(title, startDate, recurrence, options)

Erstellt eine neue ganztägige Terminserie.

// Creates an event series for a no-meetings day, taking place every Wednesday in 2013.
var eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries('No Meetings',
    new Date('January 2, 2013 03:00:00 PM EST'),
    CalendarApp.newRecurrence().addWeeklyRule()
        .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
        .until(new Date('January 1, 2014')),
    {guests: 'everyone@example.com'});
Logger.log('Event Series ID: ' + eventSeries.getId());

Parameter

NameTypBeschreibung
titleStringTitel der Termine in der Serie
startDateDatedas Datum des ersten Ereignisses in der Serie (nur der Tag wird verwendet, die Zeit wird ignoriert)
recurrenceEventRecurrenceWiederholungseinstellungen der Veranstaltungsreihe
optionsObjectein JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt

Erweiterte Parameter

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

Rückflug

CalendarEventSeries: Die erstellte Ereignisserie

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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".
var calendar = CalendarApp.createCalendar('Travel Plans');
Logger.log('Created the calendar "%s", with the ID "%s".',
    calendar.getName(), calendar.getId());

Parameter

NameTypBeschreibung
nameStringName des neuen Kalenders

Rückflug

Calendar: Der neu erstellte Kalender

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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 summary and color.
var calendar = CalendarApp.createCalendar('Travel Plans', {
  summary: '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
nameStringName des neuen Kalenders
optionsObjectein JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt

Erweiterte Parameter

NameTypBeschreibung
locationStringKalenderstandort
summaryStringder Kalenderbeschreibung
timeZoneStringder Zeitzone, auf die der Kalender gesetzt werden soll, angegeben im „long“-Format (z.B. „America/New_York“, wie von Joda.org aufgelistet)
colorStringEin hexadezimaler Farbstring („#rrggbb“) oder ein Wert aus CalendarApp.Colors
hiddenBooleanGibt an, ob der Kalender auf der Benutzeroberfläche ausgeblendet wird (Standard: false)
selectedBooleanGibt an, ob die Termine des Kalenders auf der Benutzeroberfläche angezeigt werden (Standard: true)

Rückflug

Calendar: Der neu erstellte Kalender

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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 Skripts interpretiert, die von der Zeitzone des Kalenders abweichen kann.

// Creates an event for the moon landing and logs the ID.
var event = CalendarApp.getDefaultCalendar().createEvent('Apollo 11 Landing',
    new Date('July 20, 1969 20:00:00 UTC'),
    new Date('July 21, 1969 21:00:00 UTC'));
Logger.log('Event ID: ' + event.getId());

Parameter

NameTypBeschreibung
titleStringTitel des Termins
startTimeDateDatum und Uhrzeit des Terminbeginns
endTimeDateDatum und Uhrzeit des Terminendes

Rückflug

CalendarEvent: Das erstellte Ereignis

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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 Skripts interpretiert, die von der Zeitzone des Kalenders abweichen kann.

// Creates an event for the moon landing and logs the ID.
var event = CalendarApp.getDefaultCalendar().createEvent('Apollo 11 Landing',
    new Date('July 20, 1969 20:00:00 UTC'),
    new Date('July 20, 1969 21:00:00 UTC'),
    {location: 'The Moon'});
Logger.log('Event ID: ' + event.getId());

Parameter

NameTypBeschreibung
titleStringTitel des Termins
startTimeDateDatum und Uhrzeit des Terminbeginns
endTimeDateDatum und Uhrzeit des Terminendes
optionsObjectein JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt

Erweiterte Parameter

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

Rückflug

CalendarEvent: Das erstellte Ereignis

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden REST API:

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

createEventFromDescription(description)

Erstellt ein Ereignis aus einer kostenlosen Beschreibung.

Die Beschreibung muss das gleiche Format haben wie die Benutzeroberfläche zum schnellen Hinzufügen.

// Creates a new event and logs its ID.
var event = CalendarApp.getDefaultCalendar()
    .createEventFromDescription('Lunch with Mary, Friday at 1PM');
Logger.log('Event ID: ' + event.getId());

Parameter

NameTypBeschreibung
descriptionStringeine kostenlose Beschreibung der Veranstaltung

Rückflug

CalendarEvent: Das erstellte Ereignis

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden REST API:

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

createEventSeries(title, startTime, endTime, recurrence)

Erstellt eine neue Ereignisserie.

// Creates an event series for a team meeting, taking place every Tuesday and Thursday in 2013.
var eventSeries = CalendarApp.getDefaultCalendar().createEventSeries('Team Meeting',
    new Date('January 1, 2013 03:00:00 PM EST'),
    new Date('January 1, 2013 04:00:00 PM EST'),
    CalendarApp.newRecurrence().addWeeklyRule()
        .onlyOnWeekdays([CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY])
        .until(new Date('January 1, 2014')));
Logger.log('Event Series ID: ' + eventSeries.getId());

Parameter

NameTypBeschreibung
titleStringTitel der Termine in der Serie
startTimeDateDatum und Uhrzeit des ersten Termins der Serie
endTimeDatedas Datum und die Uhrzeit, wann das erste Ereignis der Serie endet
recurrenceEventRecurrenceWiederholungseinstellungen der Veranstaltungsreihe

Rückflug

CalendarEventSeries: Die erstellte Ereignisserie

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden REST API:

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

createEventSeries(title, startTime, endTime, recurrence, options)

Erstellt eine neue Ereignisserie.

// Creates an event series for a team meeting, taking place every Tuesday and Thursday in 2013.
var eventSeries = CalendarApp.getDefaultCalendar().createEventSeries('Team Meeting',
    new Date('January 1, 2013 03:00:00 PM EST'),
    new Date('January 1, 2013 04:00:00 PM EST'),
    CalendarApp.newRecurrence().addWeeklyRule()
        .onlyOnWeekdays([CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY])
        .until(new Date('January 1, 2014')),
    {location: 'Conference Room'});
Logger.log('Event Series ID: ' + eventSeries.getId());

Parameter

NameTypBeschreibung
titleStringTitel der Termine in der Serie
startTimeDateDatum und Uhrzeit des ersten Termins der Serie
endTimeDatedas Datum und die Uhrzeit, wann das erste Ereignis der Serie endet
recurrenceEventRecurrenceWiederholungseinstellungen der Veranstaltungsreihe
optionsObjectein JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt

Erweiterte Parameter

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

Rückflug

CalendarEventSeries: Die erstellte Ereignisserie

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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.
var 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

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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 Eigentümer der Nutzer ist

// Determines how many calendars the user owns.
var calendars = CalendarApp.getAllOwnedCalendars();
Logger.log('This user owns %s calendars.', calendars.length);

Rückflug

Calendar[]: alle Kalender des Nutzers

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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.
var calendar = CalendarApp.getCalendarById(
    'en.usa#holiday@group.v.calendar.google.com');
Logger.log('The calendar is named "%s".', calendar.getName());

Parameter

NameTypBeschreibung
idStringKalender-ID

Rückflug

Calendar: 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

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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, den der Nutzer besitzt oder abonniert hat. Die Groß- und Kleinschreibung spielt dabei keine Rolle.

// Gets the public calendar named "US Holidays".
var calendars = CalendarApp.getCalendarsByName('US Holidays');
Logger.log('Found %s matching calendars.', calendars.length);

Parameter

NameTypBeschreibung
nameStringder Kalendername

Rückflug

Calendar[]: Alle Kalender mit diesem Namen, auf die der Nutzer zugreifen kann

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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.
var 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

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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 aus diesem Kalender aufgerufen werden. Wenn Sie getEventById(iCalId) aufrufen, wird nur ein Termin im Standardkalender zurückgegeben.

Mehrere Ereignisse haben möglicherweise dieselbe ID, wenn sie Teil einer Ereignisserie sind. In diesem Fall gibt diese Methode nur das erste Ereignis aus dieser Serie zurück.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com')

// Creates an event for the moon landing.
const event = calendar.createEvent('Apollo 11 Landing',
  new Date('July 20, 1969 20:05:00 UTC'),
  new Date('July 20, 1969 20:17:00 UTC'));

// Gets the calendar event ID and logs it to the console.
const iCalId = event.getId();
console.log(iCalId);

// Gets the event by its ID and logs the title of the event to the console.
// For the default calendar, you can use CalendarApp.getEventById(iCalId) instead.
const myEvent = calendar.getEventById(iCalId);
console.log(myEvent.getTitle());

Parameter

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

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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 Ereignisserie mit der angegebenen ID ab Wenn die angegebene ID für ein einzelnes CalendarEvent-Objekt bestimmt ist, wird ein CalendarEventSeries-Objekt mit einem einzelnen Ereignis in der Serie zurückgegeben. Wenn die Terminreihe zu einem anderen Kalender als dem Standardkalender gehört, muss diese Methode aus diesem CalendarApp aufgerufen werden. Durch den Aufruf von getEventSeriesById(iCalId) wird nur eine Ereignisserie 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 Ereignisserie.

Rückflug

CalendarEventSeries: Die Reihe mit der angegebenen ID oder null, wenn die Reihe nicht existiert oder der Nutzer nicht darauf zugreifen kann.

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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 innerhalb eines bestimmten Zeitraums ab

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

// Determines how many events are happening in the next two hours.
var now = new Date();
var twoHoursFromNow = new Date(now.getTime() + (2 * 60 * 60 * 1000));
var events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow);
Logger.log('Number of events: ' + events.length);

Parameter

NameTypBeschreibung
startTimeDateBeginn des Zeitraums
endTimeDatedes Zeitraums, nicht einschließen

Rückflug

CalendarEvent[]: Ereignisse, die innerhalb des Zeitraums auftreten

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden REST API:

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

getEvents(startTime, endTime, options)

Ruft alle Ereignisse ab, die innerhalb eines bestimmten Zeitraums auftreten und die angegebenen Kriterien erfüllen.

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

Die Filterung nach author, search oder statusFilters findet nach Anwendung von start und max statt. Das bedeutet, dass die Anzahl der zurückgegebenen Ereignisse kleiner als max sein kann, obwohl zusätzliche Ereignisse die Kriterien erfüllen.

// Determines how many events are happening in the next two hours that contain the term
// "meeting".
var now = new Date();
var twoHoursFromNow = new Date(now.getTime() + (2 * 60 * 60 * 1000));
var events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow,
    {search: 'meeting'});
Logger.log('Number of events: ' + events.length);

Parameter

NameTypBeschreibung
startTimeDateBeginn des Zeitraums
endTimeDatedes Zeitraums, nicht einschließen
optionsObjectein JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt

Erweiterte Parameter

NameTypBeschreibung
startIntegerIndex des ersten zurückzugebenden Ereignisses
maxIntegerdie maximale Anzahl von Ereignissen, die zurückgegeben werden sollen
authorStringeine E-Mail-Adresse, nach der Ergebnisse vom Ersteller des Termins gefiltert werden
searchStringeine Volltextabfrage, mit der Ergebnisse gefiltert werden
statusFilters[]GuestStatusEin Array von Status zum Filtern von Ergebnissen.

Rückflug

CalendarEvent[]: Die Ereignisse, die innerhalb des Zeitraums stattfinden und den Kriterien entsprechen

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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, während des Tages enden oder den Tag einschließen.

Es wird nur der Datumsteil des Datumsobjekts verwendet und der Zeitabschnitt wird ignoriert. Das Datum wird von Mitternacht bis Mitternacht in der Zeitzone des Kalenders als Mitternacht interpretiert.

// Determines how many events are happening today.
var today = new Date();
var events = CalendarApp.getDefaultCalendar().getEventsForDay(today);
Logger.log('Number of events: ' + events.length);

Parameter

NameTypBeschreibung
dateDatedas Datum, für das Ereignisse abgerufen werden sollen (nur der Tag wird verwendet, die Zeit wird ignoriert)

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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 stattfinden und bestimmte Kriterien erfüllen.

Diese Methode gibt Ereignisse zurück, wenn sie am angegebenen Tag beginnen, während des Tages enden oder den Tag einschließen.

Es wird nur der Datumsteil des Datumsobjekts verwendet und der Zeitabschnitt wird ignoriert. Das Datum wird von Mitternacht bis Mitternacht in der Zeitzone des Kalenders als Mitternacht interpretiert.

Die Filterung nach author, search oder statusFilters findet nach Anwendung von start und max statt. Das bedeutet, dass die Anzahl der zurückgegebenen Ereignisse kleiner als max sein kann, obwohl zusätzliche Ereignisse die Kriterien erfüllen.

// Determines how many events are happening today and contain the term "meeting".
var today = new Date();
var events = CalendarApp.getDefaultCalendar().getEventsForDay(today, {search: 'meeting'});
Logger.log('Number of events: ' + events.length);

Parameter

NameTypBeschreibung
dateDatedas Datum, für das Ereignisse abgerufen werden sollen (nur der Tag wird verwendet, die Zeit wird ignoriert)
optionsObjecterweiterte Filteroptionen

Erweiterte Parameter

NameTypBeschreibung
startIntegerIndex des ersten zurückzugebenden Ereignisses
maxIntegerdie maximale Anzahl von Ereignissen, die zurückgegeben werden sollen
authorStringeine E-Mail-Adresse, nach der Ergebnisse vom Ersteller des Termins gefiltert werden
searchStringeine Volltextabfrage, mit der Ergebnisse gefiltert werden
statusFilters[]GuestStatusEin Array von Status zum Filtern von Ergebnissen.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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 dessen 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

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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 sie dem Nutzer gehört

Klicken Sie in Google Kalender auf den Pfeil neben dem Namen des Kalenders, um die Kalender-ID aufzurufen, und wählen Sie Kalendereinstellungen aus. Die ID wird unten auf der Seite „Einstellungen“ angezeigt.

// Gets a (non-existent) private calendar by ID.
var calendar = CalendarApp.getOwnedCalendarById(
    '123456789@group.calendar.google.com');
Logger.log('The calendar is named "%s".', calendar.getName());

Parameter

NameTypBeschreibung
idStringKalender-ID

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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, der dem Nutzer gehört Die Groß- und Kleinschreibung spielt dabei keine Rolle.

// Gets a private calendar named "Travel Plans".
var calendars = CalendarApp.getOwnedCalendarsByName('Travel Plans');
Logger.log('Found %s matching calendars.', calendars.length);

Parameter

NameTypBeschreibung
nameStringder Kalendername

Rückflug

Calendar[]: Alle Kalender mit diesem Namen, der dem Nutzer gehört

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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, angegeben im „long“-Format (z. B. „America/New_York“, wie von Joda.org aufgelistet).

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden REST API:

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

isHidden()

Legt fest, ob der Kalender auf der Benutzeroberfläche ausgeblendet wird.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Determines whether the calendar is hidden in the user interface and logs it to the console.
// For the default calendar, you can use CalendarApp.isHidden() instead.
const isHidden = calendar.isHidden();
console.log(isHidden);

Rückflug

Boolean: true, wenn der Kalender in der Benutzeroberfläche ausgeblendet ist; false, wenn nicht.

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden REST API:

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

isMyPrimaryCalendar()

Legt fest, ob der Kalender der primäre Kalender für den betreffenden 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

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden REST API:

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

isOwnedByMe()

Hier können Sie festlegen, 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 Kalender gehören. false, wenn nicht.

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden REST API:

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

isSelected()

Legt fest, ob die Termine des Kalenders auf der Benutzeroberfläche angezeigt werden

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Determines whether the calendar's events are displayed in the user interface and logs it.
console.log(calendar.isSelected());

Rückflug

Boolean: true, wenn die Termine des Kalenders auf der Benutzeroberfläche angezeigt werden; false, wenn nicht

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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 Wiederholungen von Ereignissen erstellt werden können.

// Creates an event series for a no-meetings day, taking place every Wednesday in 2013.
var recurrence = CalendarApp.newRecurrence().addWeeklyRule()
    .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
    .until(new Date('January 1, 2014'));
var 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 (funktioniert als wöchentliche Wiederholung)

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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
colorStringEinen CalendarApp.Color-String oder einen hexadezimalen Farbstring („#rrggbb“).

Rückflug

Calendar: Dieser Kalender für die Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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 angezeigt wird.

Parameter

NameTypBeschreibung
hiddenBooleantrue zum Ausblenden des Kalenders in der Benutzeroberfläche; false zum Einblenden

Rückflug

Calendar – dieser Kalender für die Verkettung

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden REST API:

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

setSelected(selected)

Legt fest, ob die Termine des Kalenders auf der Benutzeroberfläche angezeigt werden

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Selects the calendar so that its events are displayed in the user interface. To
// unselect the calendar, set the parameter to false.
calendar.setSelected(true);

Parameter

NameTypBeschreibung
selectedBooleantrue, um die Termine des Kalenders auf der Benutzeroberfläche anzuzeigen; false, um sie auszublenden

Rückflug

Calendar – dieser Kalender für die Verkettung

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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 im Format „long“ angegebene Zeitzone (z. B. „America/New_York“, wie von Joda.org aufgelistet).

Rückflug

Calendar: Dieser Kalender für die Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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 berechtigt ist.

// Subscribe to the calendar "US Holidays".
var calendar = CalendarApp.subscribeToCalendar(
    'en.usa#holiday@group.v.calendar.google.com');
Logger.log('Subscribed to the calendar "%s".', calendar.getName());

Parameter

NameTypBeschreibung
idStringID 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

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden 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 berechtigt ist.

// Subscribe to the calendar "US Holidays", and set it to the color blue.
var 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
idStringID des Kalenders, den Sie abonnieren möchten
optionsObjectein JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt

Erweiterte Parameter

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

Rückflug

Calendar: Der neu abonnierte Kalender

Löst aus

Error: wenn kein Kalender mit dieser ID vorhanden ist

Autorisierung

Skripts, die diese Methode verwenden, benötigen eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen von der entsprechenden REST API:

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