Class CalendarEvent

CalendarEvent

Stellt einen einzelnen Kalendertermin dar.

Methoden

MethodeRückgabetypKurzbeschreibung
addEmailReminder(minutesBefore)CalendarEventFügt dem Termin eine neue E-Mail-Erinnerung hinzu.
addGuest(email)CalendarEventFügt dem Termin einen Gast hinzu.
addPopupReminder(minutesBefore)CalendarEventDem Termin wird eine neue Pop-up-Benachrichtigung hinzugefügt.
addSmsReminder(minutesBefore)CalendarEventFügt dem Termin eine neue SMS-Erinnerung hinzu.
anyoneCanAddSelf()BooleanLegt fest, ob Personen sich selbst als Gäste zu einem Kalendertermin hinzufügen können.
deleteEvent()voidLöscht einen Kalendertermin
deleteTag(key)CalendarEventLöscht ein Schlüssel/Wert-Tag aus dem Ereignis
getAllDayEndDate()DateRuft das Datum ab, an dem dieser ganztägige Kalendertermin endet.
getAllDayStartDate()DateRuft das Datum ab, an dem dieser ganztägige Kalendertermin beginnt.
getAllTagKeys()String[]Ruft alle Schlüssel für Tags ab, die für das Ereignis festgelegt wurden.
getColor()StringGibt die Farbe des Kalendertermins zurück
getCreators()String[]Ruft die Ersteller eines Termins ab.
getDateCreated()DateRuft das Datum ab, an dem der Termin erstellt wurde.
getDescription()StringRuft die Beschreibung des Ereignisses ab.
getEmailReminders()Integer[]Ruft die Minutenwerte aller E-Mail-Erinnerungen für den Termin ab.
getEndTime()DateRuft Datum und Uhrzeit des Endes dieses Kalendertermins ab.
getEventSeries()CalendarEventSeriesRuft die Serie von wiederkehrenden Terminen ab, zu der dieser Termin gehört.
getGuestByEmail(email)EventGuestRuft einen Gast anhand der E-Mail-Adresse ab.
getGuestList()EventGuest[]Hiermit werden die Gäste des Termins ohne den Termineigentümer abgerufen.
getGuestList(includeOwner)EventGuest[]Hiermit werden die Gäste des Termins abgerufen, möglicherweise einschließlich der Termininhaber.
getId()StringRuft die eindeutige iCalUID des Termins ab.
getLastUpdated()DateRuft das Datum der letzten Aktualisierung des Termins ab.
getLocation()StringRuft den Ort des Ereignisses ab.
getMyStatus()GuestStatusRuft den Terminstatus des betreffenden Nutzers ab, z. B. "Teilnahme" oder "Eingeladen".
getOriginalCalendarId()StringRufen Sie die ID des Kalenders ab, in dem dieser Termin ursprünglich erstellt wurde.
getPopupReminders()Integer[]Ruft die Minutenwerte aller Pop-up-Erinnerungen an den Termin ab.
getSmsReminders()Integer[]Ruft die Minutenwerte aller SMS-Erinnerungen für den Termin ab.
getStartTime()DateRuft Datum und Uhrzeit für den Beginn dieses Kalendertermins ab.
getTag(key)StringRuft einen Tag-Wert des Ereignisses ab.
getTitle()StringRuft den Titel des Termins ab.
getVisibility()VisibilityRuft die Sichtbarkeit des Termins ab.
guestsCanInviteOthers()BooleanLegt fest, ob Gäste andere Gäste einladen können.
guestsCanModify()BooleanLegt fest, ob Gäste den Termin bearbeiten können.
guestsCanSeeGuests()BooleanLegt fest, ob Gäste andere Gäste sehen können.
isAllDayEvent()BooleanLegt fest, ob es sich um einen ganztägigen Termin handelt.
isOwnedByMe()BooleanDamit wird festgelegt, ob Sie der Inhaber des Termins sind.
isRecurringEvent()BooleanLegt fest, ob der Termin zu einer Serie gehört.
removeAllReminders()CalendarEventEntfernt alle Erinnerungen aus dem Termin.
removeGuest(email)CalendarEventGast aus dem Termin entfernen
resetRemindersToDefault()CalendarEventDadurch werden die Erinnerungen auf die Standardeinstellungen des Kalenders zurückgesetzt.
setAllDayDate(date)CalendarEventLegt das Datum des Ereignisses fest.
setAllDayDates(startDate, endDate)CalendarEventLegt den Zeitraum des Ereignisses fest.
setAnyoneCanAddSelf(anyoneCanAddSelf)CalendarEventLegt fest, ob Nicht-Gäste sich selbst dem Termin hinzufügen können.
setColor(color)CalendarEventLegt die Farbe des Kalendertermins fest.
setDescription(description)CalendarEventLegt die Beschreibung des Ereignisses fest.
setGuestsCanInviteOthers(guestsCanInviteOthers)CalendarEventLegt fest, ob Gäste andere Gäste einladen können.
setGuestsCanModify(guestsCanModify)CalendarEventLegt fest, ob Gäste den Termin bearbeiten können.
setGuestsCanSeeGuests(guestsCanSeeGuests)CalendarEventLegt fest, ob Gäste andere Gäste sehen können.
setLocation(location)CalendarEventLegt den Ort des Ereignisses fest.
setMyStatus(status)CalendarEventLegt den Ereignisstatus des betreffenden Nutzers fest, z. B. "Teilnahme" oder "Eingeladen".
setTag(key, value)CalendarEventLegt ein Schlüssel/Wert-Tag für das Ereignis zum Speichern benutzerdefinierter Metadaten fest.
setTime(startTime, endTime)CalendarEventLegt Datum und Uhrzeit für Beginn und Ende des Ereignisses fest.
setTitle(title)CalendarEventLegt den Titel des Termins fest.
setVisibility(visibility)CalendarEventLegt die Sichtbarkeit des Ereignisses fest.

Detaillierte Dokumentation

addEmailReminder(minutesBefore)

Fügt dem Termin eine neue E-Mail-Erinnerung hinzu. Die Erinnerung muss mindestens 5 Minuten und höchstens vier Wochen (40.320 Minuten) vor dem Termin erfolgen.

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Adds an email notification for 15 minutes before the event.
event.addEmailReminder(15);

Parameter

NameTypBeschreibung
minutesBeforeIntegerdie Anzahl der Minuten vor dem Termin

Return

CalendarEvent – diese CalendarEvent für Verkettung

Löst aus

Error: Wenn es für den Termin mehr als 5 Erinnerungen gibt oder die Zeit nicht im zulässigen Bereich liegt

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

addGuest(email)

Fügt dem Termin einen Gast hinzu.

// Example 1: Add a guest to one event
function addAttendeeToEvent() {
  // Replace the below values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to add
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar containing event
  let eventId = '123abc'; // ID of event instance

  let calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
    }
  let event = calendar.getEventById(eventId);
  if (event === null) {
    // Event not found
    console.log('Event not found', eventId);
    return;
    }
  event.addGuest(attendeeEmail);
  }

// Example 2: Add a guest to all events on a calendar within a specified timeframe
function addAttendeeToAllEvents(){
// Replace the following values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to add
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar with the events
  let startDate = new Date("YYYY-MM-DD"); // The first date to add the guest to the events
  let endDate = new Date("YYYY-MM-DD"); // The last date to add the guest to the events

  let calendar = CalendarApp.getCalendarById(calendarId);
    if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  // Get the events within the specified timeframe
  let calEvents = calendar.getEvents(startDate,endDate);
  console.log(calEvents.length); // Checks how many events are found
  // Loop through all events and add the attendee to each of them
  for (var i = 0; i < calEvents.length; i++) {
  let event = calEvents[i];
  event.addGuest(attendeeEmail);
  }
}

Parameter

NameTypBeschreibung
emailStringDie E-Mail-Adresse des Gasts.

Return

CalendarEvent: CalendarEvent für Verkettungen.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

addPopupReminder(minutesBefore)

Dem Termin wird eine neue Pop-up-Benachrichtigung hinzugefügt. Die Benachrichtigung muss mindestens 5 Minuten und höchstens vier Wochen (40.320 Minuten) vor dem Ereignis erfolgen.

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Adds a pop-up notification for 15 minutes before the event.
event.addPopupReminder(15);

Parameter

NameTypBeschreibung
minutesBeforeIntegerdie Anzahl der Minuten vor dem Termin

Return

CalendarEvent – diese CalendarEvent für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

addSmsReminder(minutesBefore)

Fügt dem Termin eine neue SMS-Erinnerung hinzu. Die Erinnerung muss mindestens 5 Minuten und höchstens vier Wochen (40.320 Minuten) vor dem Termin erfolgen.

Parameter

NameTypBeschreibung
minutesBeforeIntegerdie Anzahl der Minuten vor dem Termin

Return

CalendarEvent – diese CalendarEvent für Verkettung

Löst aus

Error: Wenn es für den Termin mehr als 5 Erinnerungen gibt oder die Zeit nicht im zulässigen Bereich liegt

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

anyoneCanAddSelf()

Legt fest, ob Personen sich selbst als Gäste zu einem Kalendertermin hinzufügen können.

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Determines whether people can add themselves as guests to the event and logs it.
console.log(event.anyoneCanAddSelf());

Return

Boolean: true, wenn Nichtgäste sich selbst dem Termin hinzufügen können; false wenn nicht

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

deleteEvent()

Löscht einen Kalendertermin

// Gets an event by its ID.
// TODO(developer): Replace the string with the ID of the event that you want to delete.
const event = CalendarApp.getEventById('abc123456');

// Deletes the event.
event.deleteEvent();

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

deleteTag(key)

Löscht ein Schlüssel/Wert-Tag aus dem Ereignis

Parameter

NameTypBeschreibung
keyStringTag-Schlüssel

Return

CalendarEvent – diese CalendarEvent für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getAllDayEndDate()

Ruft das Datum ab, an dem dieser ganztägige Kalendertermin endet. (Wenn dies kein ganztägiges Ereignis ist, löst diese Methode eine Ausnahme aus.) Der zurückgegebene Date steht für Mitternacht am Anfang des Tages nach dem Ende des Ereignisses in der Zeitzone des Skripts. Wenn Sie stattdessen die Zeitzone des Kalenders verwenden möchten, rufen Sie getEndTime() auf.

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

// Creates an event named 'My all-day event' for May 16, 2023.
const event = calendar.createAllDayEvent('My all-day event', new Date('May 16, 2023'));

// Gets the event's end date and logs it.
const endDate = event.getAllDayEndDate();
console.log(endDate);

Return

Date – Das Enddatum dieses ganztägigen Kalendertermins

Löst aus

Error: wenn es sich nicht um einen ganztägigen Termin handelt

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getAllDayStartDate()

Ruft das Datum ab, an dem dieser ganztägige Kalendertermin beginnt. Wenn dies kein ganztägiges Ereignis ist, löst diese Methode eine Ausnahme aus. Der zurückgegebene Date steht für Mitternacht am Beginn des Tages, an dem das Ereignis in der Zeitzone des Skripts beginnt. Wenn Sie stattdessen die Zeitzone des Kalenders verwenden möchten, rufen Sie getStartTime() auf.

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

// Creates an event named 'My all-day event' for May 16, 2023.
const event = calendar.createAllDayEvent('My all-day event', new Date('May 16, 2023'));

// Gets the event's start date and logs it.
const startDate = event.getAllDayStartDate();
console.log(startDate);

Return

Date – Startdatum dieses ganztägigen Kalendertermins

Löst aus

Error: wenn es sich nicht um einen ganztägigen Termin handelt

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getAllTagKeys()

Ruft alle Schlüssel für Tags ab, die für das Ereignis festgelegt wurden.

Return

String[] – ein Array von Stringschlüsseln

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getColor()

Gibt die Farbe des Kalendertermins zurück

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Gets the color of the calendar event and logs it.
const eventColor = event.getColor();
console.log(eventColor);

Return

String: Die Stringdarstellung der Ereignisfarbe als Index (1–11) der Werte aus CalendarApp.EventColor.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getCreators()

Ruft die Ersteller eines Termins ab.

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Gets a list of the creators of the event and logs it.
console.log(event.getCreators());

Return

String[]: die E-Mail-Adressen der Ersteller der Veranstaltung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getDateCreated()

Ruft das Datum ab, an dem der Termin erstellt wurde. Sie benötigen Zugriff auf den Kalender.

// Opens the calendar by using its ID.
// To get the user's default calendar use CalendarApp.getDefault() instead.
// TODO(developer): Replace the calendar ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 8:10 AM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 08:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, gets the date that the event
 // was created and logs it.
 const eventCreated = event.getDateCreated();
 console.log(eventCreated);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Return

Date: Das Erstellungsdatum

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getDescription()

Ruft die Beschreibung des Ereignisses ab. Sie benötigen Bearbeitungszugriff auf den Kalender.

// Opens the calendar by its ID.
// To get the user's default calendar use CalendarApp.getDefault() instead.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 4th, 2023 that takes place
between 4:00 PM and 5:00 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 04, 2023 16:00:00'), new Date('Feb 04, 2023 17:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the description of the event.
 event.setDescription('Important meeting');

 // Gets the description of the event and logs it.
 const description = event.getDescription();
 console.log(description);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Return

String – die Beschreibung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getEmailReminders()

Ruft die Minutenwerte aller E-Mail-Erinnerungen für den Termin ab. Sie benötigen Bearbeitungszugriff auf den Kalender.

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

// Gets the first event from the calendar for February 4th, 2023 that takes place
between 5:00 PM and 6:00 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 04, 2023 15:00:00'), new Date('Feb 04, 2023 18:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, adds email reminders for the user to be
 // sent at 4 and 7 minutes before the event.
 event.addEmailReminder(4);
 event.addEmailReminder(7);

 // Gets the minute values for all email reminders that are set up for the user for this event
 // and logs it.
 const emailReminder = event.getEmailReminders();
 console.log(emailReminder);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Return

Integer[]: ein Array, in dem jeder Wert der Anzahl der Minuten vor dem Ereignis entspricht, das eine Erinnerung auslöst

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getEndTime()

Ruft Datum und Uhrzeit des Endes dieses Kalendertermins ab. Sie benötigen Zugriff auf den Kalender. Bei nicht ganztägigen Ereignissen ist dies der Zeitpunkt, zu dem das Ereignis endet. Bei ganztägigen Terminen, bei denen nur ein Enddatum (kein Datum und keine Uhrzeit) gespeichert werden, ist Mitternacht in der Zeitzone des Kalenders am Anfang des Tages nach dem Ende des Termins. Dies ermöglicht einen sinnvollen Vergleich der Endzeiten für alle Ereignistypen. Der ursprüngliche Tag des Jahres bleibt jedoch nicht unverändert erhalten.

Für ganztägige Ereignisse sollte getAllDayEndDate() fast immer aufgerufen werden, bevor diese Methode verwendet wird.

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

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:00 PM and 5:00 PM.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:00:00'), new Date('Feb 01, 2023 17:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, gets the date and time at which the
 // event ends and logs it.
 console.log(event.getEndTime());
} else {
 // If no event exists within the given time frame, logs that info to the console.
 console.log('No events exist for the specified range');
}

Return

Date – Ende dieses Kalendertermins

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getEventSeries()

Ruft die Serie von wiederkehrenden Terminen ab, zu der dieser Termin gehört. Sie müssen Zugriff auf den Kalender haben. Auch wenn dieses Ereignis nicht zu einer Serie gehört, wird ein CalendarEventSeries-Objekt zurückgegeben, sodass Sie neue Wiederholungseinstellungen hinzufügen können.

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

// Gets the first event from the calendar for February 18th, 2023 that takes place between
// 1:00 PM and 2:00 PM.
const event =
  calendar.getEvents(new Date('Feb 18, 2023 13:00:00'), new Date('Feb 18, 2023 14:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, gets the event series for the event
 // and sets the color to pale green.
 event.getEventSeries().setColor(CalendarApp.EventColor.PALE_GREEN);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Return

CalendarEventSeries: Die Serie, zu der dieser Termin gehört, oder eine neue Serie, falls er noch nicht zu einer Serie gehört

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getGuestByEmail(email)

Ruft einen Gast anhand der E-Mail-Adresse ab.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 25th, 2023 that takes place
// between 5:00 PM and 5:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 25,2023 17:00:00'), new Date('Feb 25,2023 17:25:00'))[0];

// Gets a guest by email address.
const guestEmailId = event.getGuestByEmail('alex@example.com');

// If the email address corresponds to an event guest, logs the email address.
if (guestEmailId) {
  console.log(guestEmailId.getEmail());
}

Parameter

NameTypBeschreibung
emailStringdie Adresse des Gasts

Return

EventGuest: der Gast oder null, wenn die E-Mail-Adresse keinem Gast entspricht

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getGuestList()

Hiermit werden die Gäste des Termins ohne den Termineigentümer abgerufen.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 25th, 2023 that takes place
// between 5:00 PM and 5:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 25,2023 17:00:00'), new Date('Feb 25,2023 17:25:00'))[0];

// Adds two guests to the event by using their email addresses.
event.addGuest('alex@example.com');
event.addGuest('cruz@example.com');

// Gets the guests list for the event.
const guestList = event.getGuestList();

// Loops through the list to get all the guests and logs their email addresses.
for (const guest of guestList){
  console.log(guest.getEmail());
}

Return

EventGuest[]: ein Array der Gäste

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getGuestList(includeOwner)

Hiermit werden die Gäste des Termins abgerufen, möglicherweise einschließlich der Termininhaber.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 25th, 2023 that takes place
// between 5:00 PM and 5:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 25,2023 17:00:00'), new Date('Feb 25,2023 17:25:00'))[0];

// Gets the guests list for the event, including the owner of the event.
const guestList = event.getGuestList(true);

// Loops through the list to get all the guests and logs it.
for (const guest of guestList) {
  console.log(guest.getEmail());
}

Parameter

NameTypBeschreibung
includeOwnerBooleanob die Eigentümer als Gast aufgenommen werden sollen

Return

EventGuest[]: ein Array der Gäste

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getId()

Ruft die eindeutige iCalUID des Termins ab. Hinweis: Die iCalUID und der Termin id, die von der Calendar v3 API und dem erweiterten Kalenderdienst verwendet werden, sind nicht identisch und können nicht austauschbar verwendet werden. Ein Unterschied in der Semantik besteht darin, dass bei wiederkehrenden Terminen alle Vorkommen eines Ereignisses eine andere ids haben, obwohl sie alle dieselben iCalUIDs haben.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for January 5th, 2023 that takes place
// between 9:00 AM and 9:25 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Jan 05, 2023 09:00:00'), new Date('Jan 05, 2023 09:25:00'))[0];

// Gets the ID of the event and logs it.
console.log(event.getId());

Return

String: die iCalUID des Termins

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getLastUpdated()

Ruft das Datum der letzten Aktualisierung des Termins ab.

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
between 4:00 PM and 5:00 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:00:00'), new Date('Feb 01, 2023 17:00:00'))[0];

// Gets the date the event was last updated and logs it.
const eventUpdatedDate = event.getLastUpdated();
console.log(eventUpdatedDate);

Return

Date – das Datum der letzten Aktualisierung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getLocation()

Ruft den Ort des Ereignisses ab.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the location of the event to Mumbai.
 event.setLocation('Mumbai');

 // Gets the location of the event and logs it.
 const eventLocation = event.getLocation();
 console.log(eventLocation);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Return

String: der Veranstaltungsort

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getMyStatus()

Ruft den Terminstatus des betreffenden Nutzers ab, z. B. "Teilnahme" oder "Eingeladen". Gibt immer GuestStatus.OWNER zurück, wenn der aktive Nutzer der Inhaber des Ereignisses ist.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, gets the event status of
 // the effective user and logs it.
 const myStatus = event.getMyStatus();
 console.log(myStatus.toString());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Return

GuestStatus – der Status

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getOriginalCalendarId()

Rufen Sie die ID des Kalenders ab, in dem dieser Termin ursprünglich erstellt wurde.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 25th, 2023 that takes place
// between 4:00 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 25,2023 16:00:00'), new Date('Feb 25,2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, gets the ID of the calendar where the
 // event was originally created and logs it.
 const calendarId = event.getOriginalCalendarId();
 console.log(calendarId);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Return

String: die ID des ursprünglichen Kalenders

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getPopupReminders()

Ruft die Minutenwerte aller Pop-up-Erinnerungen an den Termin ab.

  // Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 4th, 2023 that takes place
// between 5:05 PM and 5:35 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 04, 2023 17:05:00'), new Date('Feb 04, 2023 17:35:00'))[0];

if (event) {
 // If an event exists within the given time frame, adds two pop-up reminders to the event.
 // The first reminder pops up 5 minutes before the event starts and the second reminder
 // pops up 3 minutes before the event starts.
 event.addPopupReminder(3);
 event.addPopupReminder(5);

 // Gets the minute values for all pop-up reminders for the event and logs it.
 const popUpReminder = event.getPopupReminders();
 console.log(popUpReminder);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Return

Integer[]: ein Array, in dem jeder Wert der Anzahl der Minuten vor dem Ereignis entspricht, das eine Erinnerung auslöst

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getSmsReminders()

Ruft die Minutenwerte aller SMS-Erinnerungen für den Termin ab.

Return

Integer[]: ein Array, in dem jeder Wert der Anzahl der Minuten vor dem Ereignis entspricht, das eine Erinnerung auslöst

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getStartTime()

Ruft Datum und Uhrzeit für den Beginn dieses Kalendertermins ab. Bei nicht ganztägigen Ereignissen ist dies der Zeitpunkt, zu dem das Ereignis gestartet wurde. Bei ganztägigen Terminen, bei denen nur das Startdatum (kein Datum und keine Uhrzeit) gespeichert werden, ist Mitternacht am Anfang des Tages, an dem der Termin in der Zeitzone des Kalenders beginnt. Dies ermöglicht einen sinnvollen Vergleich der Startzeiten für alle Ereignistypen. Dabei wird jedoch nicht unbedingt der ursprüngliche Wochentag unverändert beibehalten.

Für ganztägige Ereignisse sollte getAllDayStartDate() fast immer vor dieser Methode aufgerufen werden.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

// Gets the date and time at which this calendar event begins and logs it.
const startTime = event.getStartTime();
console.log(startTime);

Return

Date – Beginn dieses Kalendertermins

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getTag(key)

Ruft einen Tag-Wert des Ereignisses ab.

Parameter

NameTypBeschreibung
keyStringder Schlüssel

Return

String: der Tag-Wert

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getTitle()

Ruft den Titel des Termins ab.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for January 31st, 2023 that takes place
// between 9:05 AM and 9:15 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Jan 31, 2023 09:05:00'), new Date('Jan 31, 2023 09:15:00'))[0];

if (event) {
 // If an event exists within the given time frame, logs the title of the event.
 console.log(event.getTitle());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Return

String – der Titel

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

getVisibility()

Ruft die Sichtbarkeit des Termins ab.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, gets the visibility of the event
 // and logs it.
 const eventVisibility = event.getVisibility();
 console.log(eventVisibility.toString());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Return

Visibility: der Wert für die Sichtbarkeit

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

guestsCanInviteOthers()

Legt fest, ob Gäste andere Gäste einladen können.

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 9:35 AM and 9:40 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 09:35:00'), new Date('Feb 01, 2023 09:40:00'))[0];

if (event) {
 // If an event exists within the given time frame, determines whether guests can invite
 // other guests and logs it.
 console.log(event.guestsCanInviteOthers());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Return

Boolean: true, wenn Gäste andere einladen können; false, wenn nicht

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

guestsCanModify()

Legt fest, ob Gäste den Termin bearbeiten können.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 9:35 AM and 9:40 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 09:35:00'), new Date('Feb 01, 2023 09:40:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the event so that guests can't
 // modify it.
 event.setGuestsCanModify(false);

 // Determines whether guests can modify the event and logs it.
 console.log(event.guestsCanModify());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Return

Boolean: true, wenn Gäste den Termin bearbeiten können; false wenn nicht

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

guestsCanSeeGuests()

Legt fest, ob Gäste andere Gäste sehen können.

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 9:35 AM and 9:40 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 09:35:00'), new Date('Feb 01, 2023 09:40:00'))[0];

if (event) {
 // If an event exists within the given time frame, determines whether guests can see other
 // guests and logs it.
 console.log(event.guestsCanSeeGuests());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Return

Boolean: true, wenn Gäste andere Gäste sehen können; false wenn nicht

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

isAllDayEvent()

Legt fest, ob es sich um einen ganztägigen Termin handelt.

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for January 31st, 2023 that takes place
// between 9:05 AM and 9:15 AM.
const event =
  calendar.getEvents(new Date('Jan 31, 2023 09:05:00'), new Date('Jan 31, 2023 09:15:00'))[0];

// Determines whether this event is an all-day event and logs it.
console.log(event.isAllDayEvent());

Return

Boolean: true, wenn es sich um einen ganztägigen Termin handelt; andernfalls false

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

isOwnedByMe()

Damit wird festgelegt, ob Sie der Inhaber des Termins sind.

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for January 31st, 2023 that takes place
// between 9:05 AM and 9:15 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Jan 31, 2023 09:05:00'), new Date('Jan 31, 2023 09:15:00'))[0];

if (event) {
 // If an event exists within the given time frame, determines whether you're the owner
 // of the event and logs it.
 console.log(event.isOwnedByMe());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Return

Boolean: true, wenn das Ereignis dem aktiven Nutzer gehört; false, wenn nicht

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

isRecurringEvent()

Legt fest, ob der Termin zu einer Serie gehört.

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for Januart 31st, 2023 that takes place
// between 9:00 AM and 10:00 AM.
const event =
  calendar.getEvents(new Date('Jan 31, 2023 09:00:00'), new Date('Jan 31, 2023 10:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, determines whether the event is part of an
 // event series and logs it.
 console.log(event.isRecurringEvent());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Return

Boolean: true, wenn der Termin zu einer Serie gehört; false, wenn nicht

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

removeAllReminders()

Entfernt alle Erinnerungen aus dem Termin.

// Opens the calendar by its ID. You must have edit access to the calendar
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 1,2023 16:10:00'), new Date('Feb 1,2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, removes all reminders from the event.
 event.removeAllReminders();
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Return

CalendarEvent – diese CalendarEvent für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

removeGuest(email)

Gast aus dem Termin entfernen

// Example 1: Remove a guest from one event
function removeGuestFromEvent() {
  // Replace the below values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to remove
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar containing event
  let eventId = '123abc'; // ID of event instance

  let calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
    }
  let event = calendar.getEventById(eventId);
  if (event === null) {
    // Event not found
    console.log('Event not found', eventId);
    return;
    }
  event.removeGuest(attendeeEmail);
  }

// Example 2: Remove a guest from all events on a calendar within a specified timeframe
function removeGuestFromAllEvents(){
// Replace the following values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to remove
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar with the events
  let startDate = new Date("YYYY-MM-DD"); // The first date to remove the guest from the events
  let endDate = new Date("YYYY-MM-DD"); // The last date to remove the attendee from the events

  let calendar = CalendarApp.getCalendarById(calendarId);
    if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  // Get the events within the specified timeframe
  let calEvents = calendar.getEvents(startDate,endDate);
  console.log(calEvents.length); // Checks how many events are found
  // Loop through all events and remove the attendee from each of them
  for (var i = 0; i < calEvents.length; i++) {
  let event = calEvents[i];
  event.removeGuest(attendeeEmail);
  }
}

Parameter

NameTypBeschreibung
emailStringdie E-Mail-Adresse des Gasts

Return

CalendarEvent – diese CalendarEvent für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

resetRemindersToDefault()

Dadurch werden die Erinnerungen auf die Standardeinstellungen des Kalenders zurückgesetzt.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 1, 2023 16:10:00'), new Date('Feb 1, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, resets the reminders using the calendar's
 // default settings.
 event.resetRemindersToDefault();
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Return

CalendarEvent – diese CalendarEvent für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

setAllDayDate(date)

Legt das Datum des Ereignisses fest. Mit dieser Methode wird ein regulärer Termin in einen ganztägigen Termin umgewandelt.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 17th, 2023 that takes place
// between 4:00 PM and 5:00 PM.
const event =
  calendar.getEvents(new Date('Feb 17, 2023 16:00:00'), new Date('Feb 17, 2023 17:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the date of the event and updates
 // it to an all-day event.
 event.setAllDayDate(new Date('Feb 17, 2023'));
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Parameter

NameTypBeschreibung
dateDatedas Datum des Ereignisses (die Zeit wird ignoriert)

Return

CalendarEvent – dieser CalendarEvent zum Verketten

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

setAllDayDates(startDate, endDate)

Legt den Zeitraum des Ereignisses fest. Mit dieser Methode wird ein reguläres Ereignis in ein ganztägiges Ereignis umgewandelt.

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

// Gets the first event from the calendar for February 18th, 2023 that takes place
// between 4:00 PM and 5:00 PM.
const event =
  calendar.getEvents(new Date('Feb 18, 2023 16:00:00'), new Date('Feb 18, 2023 17:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the event to be an all-day event from
 // Feb 18th, 2023 until Feb 25th, 2023. Applying this method changes a regular event into an
 // all-day event.
 event.setAllDayDates(new Date('Feb 18, 2023'), new Date('Feb 25, 2023'));
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Parameter

NameTypBeschreibung
startDateDateDas Datum, an dem das Ereignis beginnt (die Zeit wird ignoriert)
endDateDatedas Datum, an dem das Ereignis endet (Uhrzeit wird ignoriert)

Return

CalendarEvent – dieser CalendarEvent zum Verketten

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

setAnyoneCanAddSelf(anyoneCanAddSelf)

Legt fest, ob Nicht-Gäste sich selbst dem Termin hinzufügen können.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 15th, 2023 that takes place
// between 3:30 PM and 4:30 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 15, 2023 15:30:00'), new Date('Feb 15, 2023 16:30:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the event so that non-guests
 // can't add themselves to the event.
 event.setAnyoneCanAddSelf(false);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Parameter

NameTypBeschreibung
anyoneCanAddSelfBooleanob jemand sich selbst

Return

CalendarEvent – diese CalendarEvent für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

setColor(color)

Legt die Farbe des Kalendertermins fest.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the color of the calendar event to
 // green.
 event.setColor(CalendarApp.EventColor.GREEN);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Parameter

NameTypBeschreibung
colorStringEin ganzzahliger Farbindex als String oder ein Wert aus CalendarApp.EventColor.

Return

CalendarEvent: Dieser Kalendertermin zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

setDescription(description)

Legt die Beschreibung des Ereignisses fest.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 4th, 2023 that takes place
// between 5:05 PM and 5:35 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 04, 2023 17:05:00'), new Date('Feb 04, 2023 17:35:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the description of the event to
 // 'Meeting.'
 event.setDescription('Meeting');
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Parameter

NameTypBeschreibung
descriptionStringdie neue Beschreibung

Return

CalendarEvent – diese CalendarEvent für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

setGuestsCanInviteOthers(guestsCanInviteOthers)

Legt fest, ob Gäste andere Gäste einladen können.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own. You must have edit access to the calendar.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 9:35 AM and 9:40 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 09:35:00'), new Date('Feb 01, 2023 09:40:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the event so that guests can invite
 // other guests.
 event.setGuestsCanInviteOthers(true);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Parameter

NameTypBeschreibung
guestsCanInviteOthersBooleanob Gäste andere Personen einladen können

Return

CalendarEvent – diese CalendarEvent für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

setGuestsCanModify(guestsCanModify)

Legt fest, ob Gäste den Termin bearbeiten können.

Parameter

NameTypBeschreibung
guestsCanModifyBooleanob Gäste den Termin bearbeiten können

Return

CalendarEvent – diese CalendarEvent für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

setGuestsCanSeeGuests(guestsCanSeeGuests)

Legt fest, ob Gäste andere Gäste sehen können.

Parameter

NameTypBeschreibung
guestsCanSeeGuestsBooleanob Gäste andere Personen sehen können

Return

CalendarEvent – diese CalendarEvent für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

setLocation(location)

Legt den Ort des Ereignisses fest.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the location of the event to Noida.
 event.setLocation('Noida');
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Parameter

NameTypBeschreibung
locationStringder neue Speicherort

Return

CalendarEvent – diese CalendarEvent für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

setMyStatus(status)

Legt den Ereignisstatus des betreffenden Nutzers fest, z. B. "Teilnahme" oder "Eingeladen".

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the event status for the current user
 to maybe.
 event.setMyStatus(CalendarApp.GuestStatus.MAYBE);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Parameter

NameTypBeschreibung
statusGuestStatusden neuen Status

Return

CalendarEvent – diese CalendarEvent für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

setTag(key, value)

Legt ein Schlüssel/Wert-Tag für das Ereignis zum Speichern benutzerdefinierter Metadaten fest.

Parameter

NameTypBeschreibung
keyStringTag-Schlüssel
valueStringTag-Wert

Return

CalendarEvent – diese CalendarEvent für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

setTime(startTime, endTime)

Legt Datum und Uhrzeit für Beginn und Ende des Ereignisses fest. Mit dieser Methode wird ein ganztägiges Ereignis in einen regulären Termin umgewandelt.

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

// Declares a start time of 11:00 AM on February 20th, 2023 and an end time of 12:00 PM on
// February 20th, 2023.
const startTime = new Date('Feb 20,2023 11:00:00');
const endTime = new Date('Feb 20, 2023  12:00:00');

// Creates an all-day event on February 20th, 2023.
const event = calendar.createAllDayEvent('Meeting', new Date('Feb 20,2023'));

// Updates the all-day event to a regular event by setting a start and end time for the event.
event.setTime(startTime, endTime);

Parameter

NameTypBeschreibung
startTimeDateder neue Beginn des Ereignisses
endTimeDatedas neue Ende des Termins

Return

CalendarEvent – dieser CalendarEvent zum Verketten

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

setTitle(title)

Legt den Titel des Termins fest.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for January 31st, 2023 that takes place
// between 9:05 AM and 9:15 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Jan 31, 2023 09:05:00'), new Date('Jan 31, 2023 09:15:00'))[0];

if (event) {
 // If an event exists within the given time frame, changes its title to Event1.
 event.setTitle('Event1');
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

Parameter

NameTypBeschreibung
titleStringder neue Titel

Return

CalendarEvent – diese CalendarEvent für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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

setVisibility(visibility)

Legt die Sichtbarkeit des Ereignisses fest.

Parameter

NameTypBeschreibung
visibilityVisibility

Return

CalendarEvent – diese CalendarEvent für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche oder entsprechenden Bereichen aus der zugehörigen REST API:

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