Class Calendar

Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Kalender

Stellt einen Kalender dar, der dem Nutzer gehört oder den er abonniert hat.

Methoden

MethodeRückgabetypKurzbeschreibung
createAllDayEvent(title, date)CalendarEventDadurch wird ein neuer ganztägiger Termin erstellt.
createAllDayEvent(title, startDate, endDate)CalendarEventDadurch wird ein neuer ganztägiger Termin erstellt.
createAllDayEvent(title, startDate, endDate, options)CalendarEventDadurch wird ein neuer ganztägiger Termin erstellt.
createAllDayEvent(title, date, options)CalendarEventDadurch wird ein neuer ganztägiger Termin erstellt.
createAllDayEventSeries(title, startDate, recurrence)CalendarEventSeriesErstellt eine neue ganztägige Terminreihe.
createAllDayEventSeries(title, startDate, recurrence, options)CalendarEventSeriesErstellt eine neue ganztägige Terminreihe.
createEvent(title, startTime, endTime)CalendarEventErstellt einen neuen Termin.
createEvent(title, startTime, endTime, options)CalendarEventErstellt einen neuen Termin.
createEventFromDescription(description)CalendarEventErstellt ein Ereignis aus einer Freitextbeschreibung.
createEventSeries(title, startTime, endTime, recurrence)CalendarEventSeriesErstellt eine neue Terminserie.
createEventSeries(title, startTime, endTime, recurrence, options)CalendarEventSeriesErstellt eine neue Terminserie.
deleteCalendar()voidDer Kalender wird endgültig gelöscht.
getColor()StringRuft die Farbe des Kalenders 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 in einem bestimmten Zeitraum ab.
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 eines bestimmten Tages ab.
getEventsForDay(date, options)CalendarEvent[]Ruft alle Ereignisse ab, die an einem bestimmten Tag stattfinden und die angegebenen Kriterien erfüllen.
getId()StringRuft die ID des Kalenders ab.
getName()StringRuft den Namen des Kalenders ab.
getTimeZone()StringRuft die Zeitzone des Kalenders ab.
isHidden()BooleanLegt fest, ob der Kalender auf der Benutzeroberfläche ausgeblendet ist.
isMyPrimaryCalendar()BooleanLegt fest, ob der Kalender der Standardkalender für den aktuellen Nutzer ist.
isOwnedByMe()BooleanBestimmt, ob der Kalender dem tatsächlichen Nutzer gehört.
isSelected()BooleanLegt fest, ob die Termine des Kalenders auf der Benutzeroberfläche angezeigt werden.
setColor(color)CalendarLegt die Farbe des Kalenders fest.
setDescription(description)CalendarLegt die Beschreibung des 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 auf der Benutzeroberfläche angezeigt werden.
setTimeZone(timeZone)CalendarLegt die Zeitzone des Kalenders fest.
unsubscribeFromCalendar()voidKündigt den Nutzer für den Kalender.

Detaillierte Dokumentation

createAllDayEvent(title, date)

Dadurch wird ein neuer ganztägiger Termin erstellt.

// 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
titleStringTitel der Veranstaltung
dateDatedas Datum des Ereignisses (nur der Tag wird verwendet, die Zeit wird ignoriert)

Zurücksenden

CalendarEvent: Der erstellte Termin

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

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

createAllDayEvent(title, startDate, endDate)

Dadurch wird ein neuer ganztägiger Termin erstellt.

// 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
titleStringTitel der Veranstaltung
startDateDateDas Datum, an dem das Ereignis beginnt. Es wird nur der Tag verwendet und die Uhrzeit ignoriert.
endDateDateDas Datum, an dem das Ereignis endet. Es wird nur der Tag verwendet und die Uhrzeit ignoriert.

Zurücksenden

CalendarEvent: Der erstellte Termin

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

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

createAllDayEvent(title, startDate, endDate, options)

Dadurch wird ein neuer ganztägiger Termin erstellt.

// 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
titleStringTitel der Veranstaltung
startDateDateDas Datum, an dem das Ereignis beginnt. Es wird nur der Tag verwendet und die Uhrzeit ignoriert.
endDateDateDas Datum, an dem das Ereignis endet. Es wird nur der Tag verwendet und die Uhrzeit ignoriert.
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt

Erweiterte Parameter

NameTypBeschreibung
descriptionStringBeschreibung des Ereignisses
locationStringder Veranstaltungsort
guestsStringeine durch Kommas getrennte Liste von E-Mail-Adressen, die als Gäste hinzugefügt werden sollten
sendInvitesBooleanE-Mail-Einladung senden (Standard: false)

Zurücksenden

CalendarEvent: Der erstellte Termin

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

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

createAllDayEvent(title, date, options)

Dadurch wird ein neuer ganztägiger Termin erstellt.

// 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
titleStringTitel der Veranstaltung
dateDatedas Datum des Ereignisses (nur der Tag wird verwendet, die Zeit wird ignoriert)
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt

Erweiterte Parameter

NameTypBeschreibung
descriptionStringBeschreibung des Ereignisses
locationStringder Veranstaltungsort
guestsStringeine durch Kommas getrennte Liste von E-Mail-Adressen, die als Gäste hinzugefügt werden sollten
sendInvitesBooleanE-Mail-Einladung senden (Standard: false)

Zurücksenden

CalendarEvent: Der erstellte Termin

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

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

createAllDayEventSeries(title, startDate, recurrence)

Erstellt eine neue ganztägige Terminreihe.

// 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
titleStringDer Titel der Termine in der Serie
startDateDatedas Datum des ersten Ereignisses in der Serie (nur der Tag wird verwendet, die Zeit wird ignoriert)
recurrenceEventRecurrencedie Wiederholungseinstellungen der Veranstaltungsreihe

Zurücksenden

CalendarEventSeries: Die erstellte Terminserie

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

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

createAllDayEventSeries(title, startDate, recurrence, options)

Erstellt eine neue ganztägige Terminreihe.

// 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
titleStringDer Titel der Termine in der Serie
startDateDatedas Datum des ersten Ereignisses in der Serie (nur der Tag wird verwendet, die Zeit wird ignoriert)
recurrenceEventRecurrencedie Wiederholungseinstellungen 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 zu den Terminen der Serie hinzugefügt werden sollen
sendInvitesBooleanE-Mail-Einladung senden (Standard: false)

Zurücksenden

CalendarEventSeries: Die erstellte Terminserie

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • 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 Zusammenhang mit der Zeitzone des Skripts interpretiert, die sich von der Zeitzone des Kalenders unterscheiden kann.

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

Parameter

NameTypBeschreibung
titleStringTitel der Veranstaltung
startTimeDateDatum und Uhrzeit des Terminbeginns
endTimeDateDatum und Uhrzeit des Terminendes

Zurücksenden

CalendarEvent: Der erstellte Termin

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • 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 Zusammenhang mit der Zeitzone des Skripts interpretiert, die sich von der Zeitzone des Kalenders unterscheiden kann.

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

Parameter

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

Erweiterte Parameter

NameTypBeschreibung
descriptionStringBeschreibung des Ereignisses
locationStringder Veranstaltungsort
guestsStringeine durch Kommas getrennte Liste von E-Mail-Adressen, die als Gäste hinzugefügt werden sollten
sendInvitesBooleanE-Mail-Einladung senden (Standard: false)

Zurücksenden

CalendarEvent: Der erstellte Termin

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

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

createEventFromDescription(description)

Erstellt ein Ereignis aus einer Freitextbeschreibung.

Die Beschreibung muss dasselbe Format wie in der UI der Funktion "Quick Add" haben.

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

Zurücksenden

CalendarEvent: Der erstellte Termin

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

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

createEventSeries(title, startTime, endTime, recurrence)

Erstellt eine neue Terminserie.

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

Parameter

NameTypBeschreibung
titleStringDer Titel der Termine in der Serie
startTimeDateDatum und Uhrzeit des ersten Termins der Serie
endTimeDateDatum und Uhrzeit des Endes des ersten Termins der Serie
recurrenceEventRecurrencedie Wiederholungseinstellungen der Veranstaltungsreihe

Zurücksenden

CalendarEventSeries: Die erstellte Terminserie

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

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

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

Erstellt eine neue Terminserie.

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

Parameter

NameTypBeschreibung
titleStringDer Titel der Termine in der Serie
startTimeDateDatum und Uhrzeit des ersten Termins der Serie
endTimeDateDatum und Uhrzeit des Endes des ersten Termins der Serie
recurrenceEventRecurrencedie Wiederholungseinstellungen 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 zu den Terminen der Serie hinzugefügt werden sollen
sendInvitesBooleanE-Mail-Einladung senden (Standard: false)

Zurücksenden

CalendarEventSeries: Die erstellte Terminserie

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

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

deleteCalendar()

Der Kalender wird endgültig gelöscht. Nutzer können nur Kalender löschen, deren Eigentümer sie sind.

Throws

Error – wenn es sich um einen importierten Kalender handelt

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

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

getColor()

Ruft die Farbe des Kalenders ab.

Zurücksenden

String: ein hexadezimaler Farbstring ("#rrggbb")

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • 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.

Zurücksenden

String: Die Beschreibung dieses Kalenders

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • 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 Calendar aufgerufen werden. Wenn Sie CalendarApp.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.

Parameter

NameTypBeschreibung
iCalIdStringID des Ereignisses

Zurücksenden

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • 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 sich die angegebene ID auf einen einzelnen CalendarEvent bezieht, 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 aus diesem Calendar aufgerufen werden. Durch das Aufrufen von CalendarApp.getEventSeriesById(iCalId) wird nur eine Ereignisreihe zurückgegeben, die im Standardkalender vorhanden ist.

Parameter

NameTypBeschreibung
iCalIdStringID der Ereignisserie

Zurücksenden

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • 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 in einem bestimmten Zeitraum ab.

Diese Methode gibt Ereignisse zurück, die im angegebenen Zeitraum beginnen, während des Zeitraums enden oder den Zeitraum umfassen. Wenn keine Zeitzone angegeben ist, werden die Zeitwerte im Zusammenhang mit 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
endTimeDateEnde des Zeitraums, nicht inbegriffen

Zurücksenden

CalendarEvent[]: Ereignisse, die innerhalb des Zeitraums auftreten

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • 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, während des Zeitraums enden oder den Zeitraum umfassen. Wenn keine Zeitzone angegeben ist, werden die Zeitwerte im Zusammenhang mit der Zeitzone des Skripts interpretiert, die sich von der Zeitzone des Kalenders unterscheiden kann.

Beachte, dass nach author, search oder statusFilters gefiltert wird, nachdem start und max angewendet wurden. 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
endTimeDateEnde des Zeitraums, nicht inbegriffen
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt

Erweiterte Parameter

NameTypBeschreibung
startIntegerIndex des ersten zurückzugebenden Ereignisses
maxIntegerdie maximale Anzahl der zurückzugebenden Ereignisse
authorStringeine E-Mail-Adresse, mit der Ergebnisse vom Ersteller des Ereignisses gefiltert werden
searchStringeine Volltextabfrage zum Filtern von Ergebnissen
statusFilters[]GuestStatusArray mit Statusangaben zum Filtern von Ergebnissen

Zurücksenden

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

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

getEventsForDay(date)

Ruft alle Ereignisse eines bestimmten Tages ab.

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

Es wird nur der Datumsteil des Datumsobjekts verwendet und der Zeitteil ignoriert. Das Datum wird von Mitternacht bis Mitternacht des nächsten Tages in der Zeitzone des Kalenders interpretiert.

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

Parameter

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

Zurücksenden

CalendarEvent[]: Ereignisse, die an einem bestimmten Datum auftreten

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • 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 die angegebenen Kriterien erfüllen.

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

Es wird nur der Datumsteil des Datumsobjekts verwendet und der Zeitteil ignoriert. Das Datum wird von Mitternacht bis Mitternacht des nächsten Tages in der Zeitzone des Kalenders interpretiert.

Beachte, dass nach author, search oder statusFilters gefiltert wird, nachdem start und max angewendet wurden. 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 der zurückzugebenden Ereignisse
authorStringeine E-Mail-Adresse, mit der Ergebnisse vom Ersteller des Ereignisses gefiltert werden
searchStringeine Volltextabfrage zum Filtern von Ergebnissen
statusFilters[]GuestStatusArray mit Statusangaben zum Filtern von Ergebnissen

Zurücksenden

CalendarEvent[]: Ereignisse, die am angegebenen Datum auftreten und die Kriterien erfüllen

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • 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 des Standardkalenders eines Nutzers ist seine E-Mail-Adresse.

Zurücksenden

String: ID des Kalenders

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • 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.

Zurücksenden

String – dieser Kalendername

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • 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.

Zurücksenden

String: Die Zeitzone im Format „&longs“ (z.B. "America/New_York", wie von Joda.org aufgelistet)

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • 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 ist.

Zurücksenden

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • 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 Standardkalender für den aktuellen Nutzer ist.

Zurücksenden

Boolean: true, wenn der Kalender der Standardkalender für den betroffenen Nutzer ist; false wenn nicht

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

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

isOwnedByMe()

Bestimmt, ob der Kalender dem tatsächlichen Nutzer gehört.

Zurücksenden

Booleantrue, wenn der Kalender dem tatsächlichen Nutzer gehört; andernfalls false

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • 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.

Zurücksenden

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • 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.

Parameter

NameTypBeschreibung
colorStringEin hexadezimaler Farbstring ("#rrggbb") oder ein Wert aus CalendarApp.Color.

Zurücksenden

Calendar: Dieser Kalender zum Verketten.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

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

setDescription(description)

Legt die Beschreibung des Kalenders fest.

Parameter

NameTypBeschreibung
descriptionStringdie Beschreibung dieses Kalenders

Zurücksenden

Calendar – dieser Kalender zum Verketten

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • 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, um den Kalender in der Benutzeroberfläche auszublenden; false, um ihn anzuzeigen

Zurücksenden

Calendar – dieser Kalender zum Verketten

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

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

setName(name)

Legt den Namen des Kalenders fest.

Parameter

NameTypBeschreibung
nameStringder neue Name

Zurücksenden

Calendar – dieser Kalender zum Verketten

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • 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.

Parameter

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

Zurücksenden

Calendar – dieser Kalender zum Verketten

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

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

setTimeZone(timeZone)

Legt die Zeitzone des Kalenders fest.

Parameter

NameTypBeschreibung
timeZoneStringZeitzone im Format „long“ (z.B. "America/New_York", wie von Joda.org aufgelistet)

Zurücksenden

Calendar – dieser Kalender zum Verketten

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

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

unsubscribeFromCalendar()

Kündigt den Nutzer für den Kalender. Nutzer können ihre Kalender nicht abbestellen.

Throws

Error – wenn es sich um einen eigenen Kalender handelt

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

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