Class Calendar

Kalender

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

Methoden

MethodeRückgabetypKurzbeschreibung
createAllDayEvent(title, date)CalendarEventErstellt einen neuen ganztägigen Termin
createAllDayEvent(title, startDate, endDate)CalendarEventErstellt einen neuen ganztägigen Termin, der mehrere Tage umfassen kann.
createAllDayEvent(title, startDate, endDate, options)CalendarEventErstellt 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 Serie von ganztägigen Terminen.
createAllDayEventSeries(title, startDate, recurrence, options)CalendarEventSeriesErstellt eine neue Serie von ganztägigen Terminen.
createEvent(title, startTime, endTime)CalendarEventErstellt einen neuen Termin.
createEvent(title, startTime, endTime, options)CalendarEventErstellt einen neuen Termin.
createEventFromDescription(description)CalendarEventErstellt ein Ereignis 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.
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 Terminserie mit der angegebenen ID ab.
getEvents(startTime, endTime)CalendarEvent[]Ruft alle Ereignisse ab, die innerhalb eines bestimmten Zeitraums auftreten.
getEvents(startTime, endTime, options)CalendarEvent[]Ruft alle Ereignisse ab, die innerhalb eines bestimmten Zeitraums auftreten und die angegebenen Kriterien erfüllen.
getEventsForDay(date)CalendarEvent[]Ruft alle Ereignisse an einem bestimmten Tag ab.
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.
getTimeZone()StringRuft die Zeitzone des Kalenders ab.
isHidden()BooleanLegt fest, ob der Kalender in der Benutzeroberfläche ausgeblendet wird.
isMyPrimaryCalendar()BooleanLegt fest, ob der Kalender der Hauptkalender für den aktiven Nutzer ist.
isOwnedByMe()BooleanBestimmt, ob der Kalender Ihnen 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 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 auf der Benutzeroberfläche angezeigt werden.
setTimeZone(timeZone)CalendarLegt die Zeitzone des Kalenders fest.
unsubscribeFromCalendar()voidDer Nutzer wird von einem Kalender abgemeldet.

Detaillierte Dokumentation

createAllDayEvent(title, date)

Erstellt einen neuen ganztägigen Termin

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

Parameter

NameTypBeschreibung
titleStringDer Titel des Termins.
dateDateDas Datum des Ereignisses. Es wird nur der Tag verwendet, die Uhrzeit wird ignoriert.

Rückflug

CalendarEvent: Das erstellte Ereignis.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

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

createAllDayEvent(title, startDate, endDate)

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

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

Parameter

NameTypBeschreibung
titleStringDer Titel des Termins.
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. Die Enddatum ist ausschließlich.

Rückflug

CalendarEvent: Das erstellte Ereignis.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

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

createAllDayEvent(title, startDate, endDate, options)

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

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

Parameter

NameTypBeschreibung
titleStringDer Titel des Termins.
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. Die Enddatum ist ausschließlich.
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 von E-Mail-Adressen, die hinzugefügt werden sollten als Gäste hinzufügen.
sendInvitesBooleanLegt fest, ob E-Mail-Einladungen gesendet werden (Standardeinstellung: false).

Rückflug

CalendarEvent: Das erstellte Ereignis.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • 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. Es wird nur der Tag 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 von E-Mail-Adressen, die hinzugefügt werden sollten als Gäste hinzufügen.
sendInvitesBooleanLegt fest, ob E-Mail-Einladungen gesendet werden (Standardeinstellung: false).

Rückflug

CalendarEvent: Das erstellte Ereignis.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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 Serie von ganztägigen Terminen.

// 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 Termins in der Serie (nur der Tag wird verwendet, die Uhrzeit ignoriert)
recurrenceEventRecurrenceWiederholungseinstellungen der Terminserie

Rückflug

CalendarEventSeries – die erstellte Veranstaltungsreihe

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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 Serie von ganztägigen Terminen.

// 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 Termins in der Serie (nur der Tag wird verwendet, die Uhrzeit ignoriert)
recurrenceEventRecurrenceWiederholungseinstellungen der Terminserie
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt

Erweiterte Parameter

NameTypBeschreibung
descriptionStringdie Beschreibung der Termine in der Serie
locationStringden Ort der Termine in der Serie
guestsStringEine durch Kommas getrennte Liste von E-Mail-Adressen, die hinzugefügt werden sollen als Gäste zu den Terminen der Serie
sendInvitesBooleanob E-Mail-Einladungen gesendet werden (Standardeinstellung: false)

Rückflug

CalendarEventSeries – die erstellte Veranstaltungsreihe

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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 Kontext des Skripts Zeitzone, 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
titleStringden Titel des Termins
startTimeDateDatum und Uhrzeit des Ereignisbeginns
endTimeDateDatum und Uhrzeit des Endes des Termins

Rückflug

CalendarEvent – das erstellte Ereignis

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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 Kontext des Skripts Zeitzone, 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
titleStringden Titel des Termins
startTimeDateDatum und Uhrzeit des Ereignisbeginns
endTimeDateDatum und Uhrzeit des Endes des Termins
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt

Erweiterte Parameter

NameTypBeschreibung
descriptionStringdie Beschreibung des Ereignisses
locationStringden Ort des Ereignisses
guestsStringEine durch Kommas getrennte Liste von E-Mail-Adressen, die hinzugefügt werden sollen als Gäste
sendInvitesBooleanob E-Mail-Einladungen gesendet werden (Standardeinstellung: false)

Rückflug

CalendarEvent – das erstellte Ereignis

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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 Beschreibung im freien Format.

Die Beschreibung sollte dasselbe Format wie die Funktion Schnelleintrag der Benutzeroberfläche 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.

Rückflug

CalendarEvent – das erstellte Ereignis

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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
titleStringTitel der Termine in der Serie
startTimeDateDatum und Uhrzeit des Beginns des ersten Termins der Serie
endTimeDateDatum und Uhrzeit des Endes des ersten Termins der Serie
recurrenceEventRecurrenceWiederholungseinstellungen der Terminserie

Rückflug

CalendarEventSeries – die erstellte Veranstaltungsreihe

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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
titleStringTitel der Termine in der Serie
startTimeDateDatum und Uhrzeit des Beginns des ersten Termins der Serie
endTimeDateDatum und Uhrzeit des Endes des ersten Termins der Serie
recurrenceEventRecurrenceWiederholungseinstellungen der Terminserie
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt

Erweiterte Parameter

NameTypBeschreibung
descriptionStringdie Beschreibung der Termine in der Serie
locationStringden Ort der Termine in der Serie
guestsStringEine durch Kommas getrennte Liste von E-Mail-Adressen, die hinzugefügt werden sollen als Gäste zu den Terminen der Serie
sendInvitesBooleanob E-Mail-Einladungen gesendet werden (Standardeinstellung: false)

Rückflug

CalendarEventSeries – die erstellte Veranstaltungsreihe

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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.

// Creates a calendar to delete.
const calendar = CalendarApp.createCalendar('Test');

// Deletes the 'Test' calendar permanently.
calendar.deleteCalendar();

Löst aus

Error – wenn es sich um einen importierten Kalender handelt

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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.

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

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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.

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

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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 Serie zu einem anderen Kalender als dem Standardkalender gehört Kalender, muss diese Methode von diesem Kalender aus aufgerufen werden. Nur CalendarApp.getEventById(iCalId) wird angerufen gibt einen Termin im Standardkalender zurück.

Mehrere Termine können dieselbe ID haben, wenn sie zu einer Serie gehören. In diesem Fall gibt 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 existiert oder der Nutzer kann nicht darauf zugreifen.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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 Terminserie mit der angegebenen ID ab. Wenn die angegebene ID für eine einzelne 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 Calendar aufgerufen; CalendarApp.getEventSeriesById(iCalId) wird angerufen gibt nur eine Terminserie zurück, 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 Ereignisreihe

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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 ab, die innerhalb eines bestimmten Zeitraums auftreten.

Diese Methode gibt Ereignisse zurück, die innerhalb des angegebenen Zeitraums beginnen und während dieses Zeitraums enden oder den Zeitraum selbst umfassen. Wenn keine Zeitzone angegeben ist, sind die Zeitwerte wird im Kontext der Zeitzone des Skripts interpretiert, die von der Zeitzone des Skripts abweichen kann. Zeitzone des Kalenders.

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

Rückflug

CalendarEvent[]: die Ereignisse, die innerhalb des Zeitraums auftreten

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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 innerhalb eines bestimmten Zeitraums auftreten und die angegebenen Kriterien erfüllen.

Diese Methode gibt Ereignisse zurück, die innerhalb des angegebenen Zeitraums beginnen und während dieses Zeitraums enden oder umfasst den Zeitraum. Wenn keine Zeitzone angegeben ist, sind die Zeitwerte wird im Kontext der Zeitzone des Skripts interpretiert, die von der Zeitzone des Skripts abweichen kann. Zeitzone des Kalenders.

Wenn Sie nach author, search oder statusFilters filtern, nach Anwendung von start und max. Das bedeutet, dass die Anzahl der Ereignisse zurückgegebener Wert kleiner als max sein kann, auch wenn 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 eingeschlossen
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt

Erweiterte Parameter

NameTypBeschreibung
startIntegerIndex des ersten zurückzugebenden Ereignisses
maxIntegerMaximale Anzahl von Ereignissen, die zurückgegeben werden sollen
authorStringEine E-Mail-Adresse, mit der Ergebnisse nach dem Ersteller des Ereignisses gefiltert werden
searchStringEine Volltextsuchanfrage zum Filtern von Ergebnissen
statusFilters[]GuestStatusArray von Statusangaben zum Filtern von Ergebnissen

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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 an einem bestimmten Tag ab.

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

Beachten Sie, dass nur der Datumsteil des Date-Objekts verwendet und der Zeitteil ignoriert wird. Das Datum wird als Mitternacht an diesem Tag bis Mitternacht des nächsten Tages in der Zeit 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 Uhrzeit wird ignoriert)

Rückflug

CalendarEvent[]: die Ereignisse, die an dem angegebenen Datum auftreten

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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 auftreten 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 umfassen.

Beachten Sie, dass nur der Datumsteil des Date-Objekts verwendet und der Zeitteil ignoriert wird. Das Datum wird als Mitternacht an diesem Tag bis Mitternacht des nächsten Tages in der Zeit des Kalenders interpretiert .

Wenn Sie nach author, search oder statusFilters filtern, nach Anwendung von start und max. Das bedeutet, dass die Anzahl der Ereignisse zurückgegebener Wert kleiner als max sein kann, auch wenn 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 Uhrzeit wird ignoriert)
optionsObjecterweiterte Filteroptionen

Erweiterte Parameter

NameTypBeschreibung
startIntegerIndex des ersten zurückzugebenden Ereignisses
maxIntegerMaximale Anzahl von Ereignissen, die zurückgegeben werden sollen
authorStringEine E-Mail-Adresse, mit der Ergebnisse nach dem Ersteller des Ereignisses gefiltert werden
searchStringEine Volltextsuchanfrage zum Filtern von Ergebnissen
statusFilters[]GuestStatusArray von Statusangaben zum Filtern von Ergebnissen

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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 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

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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.

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

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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.

// 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 in "long" angegebene Zeitzone Format (z. B. "America/New_York", wie in der Liste von Joda.org)

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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 in 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

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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 Hauptkalender für den aktiven 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 aktiven Nutzer ist false, wenn nicht.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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 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

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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.

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

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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.

// 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 hexadezimaler Farbstring („#rrggbb“).

Rückflug

Calendar: Dieser Kalender für die Verkettung.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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 Zum Anzeigen false

Rückflug

Calendar – dieser Kalender für Verkettungen

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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.

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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.

// 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 anzuzeigen false zum Ausblenden

Rückflug

Calendar – dieser Kalender für Verkettungen

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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.

// 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 in „long“ angegebene Zeitzone Format (z. B. "America/New_York", als aufgelistet bei Joda.org).

Rückflug

Calendar: Dieser Kalender für die Verkettung.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

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

unsubscribeFromCalendar()

Der Nutzer wird von einem Kalender abgemeldet. Ein Nutzer kann keine Kalender abbestellen, die unter der Meine Kalender. Sie können Kalender abbestellen, die unter Sonstige Kalender.

// Gets the calendar by its ID.
// TODO(developer): Replace the calendar ID with the calendar ID that you want to get.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Unsubscribes the user from the calendar.
const result = calendar.unsubscribeFromCalendar();

Löst aus

Error – wenn es sich um einen eigenen Kalender handelt

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

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