Class CalendarEvent

KalendarzZdarzenie

Reprezentuje pojedyncze wydarzenie w kalendarzu.

Metody

MetodaZwracany typKrótki opis
addEmailReminder(minutesBefore)CalendarEventDodaje nowe e-mailowe przypomnienie do wydarzenia.
addGuest(email)CalendarEventDodaje gościa do wydarzenia.
addPopupReminder(minutesBefore)CalendarEventDodaje nowe powiadomienie wyskakujące do zdarzenia.
addSmsReminder(minutesBefore)CalendarEventDodaje nowe przypomnienie SMS-em do wydarzenia.
anyoneCanAddSelf()BooleanOkreśla, czy użytkownicy mogą dodawać siebie jako gości do wydarzenia w Kalendarzu.
deleteEvent()voidUsuwa wydarzenie z kalendarza.
deleteTag(key)CalendarEventUsuwa z zdarzenia tag klucz-wartość.
getAllDayEndDate()DatePobiera datę zakończenia tego całodniowego wydarzenia w kalendarzu.
getAllDayStartDate()DatePobiera datę rozpoczęcia tego całodniowego wydarzenia w kalendarzu.
getAllTagKeys()String[]Pobiera wszystkie klucze tagów ustawionych w zdarzeniu.
getColor()StringZwraca kolor wydarzenia w kalendarzu.
getCreators()String[]Pobiera twórców wydarzenia.
getDateCreated()DatePobiera datę utworzenia zdarzenia.
getDescription()StringPobiera opis zdarzenia.
getEmailReminders()Integer[]Pobiera wartości minutowe wszystkich przypomnień e-mail dotyczących wydarzenia.
getEndTime()DatePobiera datę i godzinę zakończenia tego wydarzenia w kalendarzu.
getEventSeries()CalendarEventSeriesPobiera serię zdarzeń cyklicznych, do której należy to zdarzenie.
getEventType()EventTypePobiera wartość EventType tego zdarzenia.
getGuestByEmail(email)EventGuestPobiera dane gościa na podstawie adresu e-mail.
getGuestList()EventGuest[]Pobiera listę gości wydarzenia, z wyjątkiem właściciela wydarzenia.
getGuestList(includeOwner)EventGuest[]Pobiera listę gości wydarzenia, w tym ewentualnie właścicieli wydarzenia.
getId()StringPobiera unikalny identyfikator iCalUID wydarzenia.
getLastUpdated()DatePobiera datę ostatniej modyfikacji wydarzenia.
getLocation()StringPobiera lokalizację wydarzenia.
getMyStatus()GuestStatusPobiera stan zdarzenia (np. uczestnictwo lub zaproszenie) skutecznego użytkownika.
getOriginalCalendarId()StringUzyskaj identyfikator kalendarza, w którym to wydarzenie zostało pierwotnie utworzone.
getPopupReminders()Integer[]Pobiera wartości minutowe wszystkich okien z przypomnieniem dla danego wydarzenia.
getSmsReminders()Integer[]Pobiera wartości minutowe wszystkich przypomnień SMS-owych dotyczących wydarzenia.
getStartTime()DatePobiera datę i godzinę rozpoczęcia tego wydarzenia z kalendarza.
getTag(key)StringPobiera wartość tagu zdarzenia.
getTitle()StringPobiera nazwę zdarzenia.
getTransparency()EventTransparencyPobiera przezroczystość zdarzenia.
getVisibility()VisibilityPobiera widoczność zdarzenia.
guestsCanInviteOthers()BooleanOkreśla, czy goście mogą zapraszać innych gości.
guestsCanModify()BooleanOkreśla, czy goście mogą modyfikować wydarzenie.
guestsCanSeeGuests()BooleanOkreśla, czy goście mogą widzieć innych gości.
isAllDayEvent()BooleanOkreśla, czy jest to wydarzenie całodniowe.
isOwnedByMe()BooleanOkreśla, czy jesteś właścicielem wydarzenia.
isRecurringEvent()BooleanOkreśla, czy zdarzenie należy do serii zdarzeń.
removeAllReminders()CalendarEventusuwa wszystkie przypomnienia z wydarzenia.
removeGuest(email)CalendarEventUsuwa gościa z wydarzenia.
resetRemindersToDefault()CalendarEventPrzywraca przypomnienia przy użyciu ustawień domyślnych kalendarza.
setAllDayDate(date)CalendarEventUstawia datę zdarzenia.
setAllDayDates(startDate, endDate)CalendarEventUstawia daty wydarzenia.
setAnyoneCanAddSelf(anyoneCanAddSelf)CalendarEventOkreśla, czy osoby, które nie są gośćmi, mogą dodać się do wydarzenia.
setColor(color)CalendarEventUstawia kolor wydarzenia w kalendarzu.
setDescription(description)CalendarEventUstawia opis zdarzenia.
setGuestsCanInviteOthers(guestsCanInviteOthers)CalendarEventOkreśla, czy goście mogą zapraszać innych gości.
setGuestsCanModify(guestsCanModify)CalendarEventOkreśla, czy goście mogą modyfikować wydarzenie.
setGuestsCanSeeGuests(guestsCanSeeGuests)CalendarEventOkreśla, czy goście mogą widzieć innych gości.
setLocation(location)CalendarEventUstawia lokalizację wydarzenia.
setMyStatus(status)CalendarEventUstawia stan użytkownika (np. uczestnictwo lub zaproszenie) w związku z danym zdarzeniem.
setTag(key, value)CalendarEventUstawia tag klucz-wartość w zdarzeniu na potrzeby przechowywania niestandardowych metadanych.
setTime(startTime, endTime)CalendarEventUstawia daty i godziny rozpoczęcia oraz zakończenia wydarzenia.
setTitle(title)CalendarEventUstawia tytuł zdarzenia.
setTransparency(transparency)CalendarEventUstawia przezroczystość zdarzenia.
setVisibility(visibility)CalendarEventUstawia widoczność zdarzenia.

Szczegółowa dokumentacja

addEmailReminder(minutesBefore)

Dodaje nowe e-mailowe przypomnienie do wydarzenia. Przypomnienie musi być wysłane co najmniej 5 minut, a maksymalnie 4 tygodnie (40320 minut) przed wydarzeniem.

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

Parametry

NazwaTypOpis
minutesBeforeIntegerliczba minut przed wydarzeniem,

Powrót

CalendarEvent – ta CalendarEvent do tworzenia łańcuszków

Rzuty

Error – jeśli przypomnień jest więcej niż 5, lub czas nie jest zgodny z obowiązującymi przepisami.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

addGuest(email)

Dodaje gościa do wydarzenia.

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

  const calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  const 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
  const attendeeEmail =
      'user@example.com';  // Email address of the person you need to add
  const calendarId =
      'calendar_123@group.calendar.google.com';  // ID of calendar with the
  // events
  const startDate =
      new Date('YYYY-MM-DD');  // The first date to add the guest to the events
  const endDate =
      new Date('YYYY-MM-DD');  // The last date to add the guest to the events

  const calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  // Get the events within the specified timeframe
  const 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 (let i = 0; i < calEvents.length; i++) {
    const event = calEvents[i];
    event.addGuest(attendeeEmail);
  }
}

Parametry

NazwaTypOpis
emailStringAdres e-mail gościa.

Powrót

CalendarEvent – ta CalendarEvent służy do łańcuchowania.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

addPopupReminder(minutesBefore)

Dodaje nowe powiadomienie wyskakujące do zdarzenia. Powiadomienie musi zostać wysłane co najmniej 5 minut, a maksymalnie 4 tygodnie (40320 minut) przed wydarzeniem.

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

Parametry

NazwaTypOpis
minutesBeforeIntegerliczba minut przed wydarzeniem,

Powrót

CalendarEvent – ta CalendarEvent do tworzenia łańcuszków

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

addSmsReminder(minutesBefore)

Dodaje nowe przypomnienie SMS-em do wydarzenia. Przypomnienie musi być wysłane co najmniej 5 minut, a maksymalnie 4 tygodnie (40320 minut) przed wydarzeniem.

Parametry

NazwaTypOpis
minutesBeforeIntegerliczba minut przed wydarzeniem,

Powrót

CalendarEvent – ta CalendarEvent do tworzenia łańcuszków

Rzuty

Error – jeśli przypomnień jest więcej niż 5, lub czas nie jest zgodny z obowiązującymi przepisami.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

anyoneCanAddSelf()

Określa, czy użytkownicy mogą dodawać siebie jako gości do wydarzenia w Kalendarzu.

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

Powrót

Boolean – true, jeśli osoby spoza listy gości mogą dodać się do wydarzenia; false, jeśli nie

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

deleteEvent()

Usuwa wydarzenie z kalendarza.

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

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

deleteTag(key)

Usuwa z zdarzenia tag klucz-wartość.

Parametry

NazwaTypOpis
keyStringklucz tagu,

Powrót

CalendarEvent – ta CalendarEvent do łańcucha

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getAllDayEndDate()

Pobiera datę zakończenia tego całodniowego wydarzenia w kalendarzu. (Jeśli nie jest to całodniowe wydarzenie, ta metoda zgłasza wyjątek). Zwrócona wartość Date to północ na początku dnia po zakończeniu zdarzenia w strefie czasowej skryptu. Aby zamiast tego użyć strefy czasowej kalendarza, zadzwoń pod numer getEndTime().

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

Powrót

Date – data zakończenia tego całodniowego wydarzenia w kalendarzu.

Rzuty

Error – jeśli wydarzenie nie jest całodniowe

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getAllDayStartDate()

Pobiera datę rozpoczęcia tego całodniowego wydarzenia w kalendarzu. (jeśli nie jest to całodniowe zdarzenie, metoda zgłasza wyjątek). Zwrócona wartość Date to północ na początku dnia, w którym rozpoczyna się zdarzenie w strefie czasowej skryptu. Aby zamiast tego użyć strefy czasowej kalendarza, wybierz getStartTime().

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

Powrót

Date – data rozpoczęcia tego całodniowego wydarzenia w kalendarzu.

Rzuty

Error – jeśli wydarzenie nie jest całodniowe

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getAllTagKeys()

Pobiera wszystkie klucze tagów ustawionych w zdarzeniu.

Powrót

String[] – tablica kluczy tekstowych

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getColor()

Zwraca kolor wydarzenia w kalendarzu.

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

Powrót

String – ciąg znaków reprezentujący kolor zdarzenia, jako indeks (1–11) wartości z CalendarApp.EventColor.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getCreators()

Pobiera twórców wydarzenia.

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

Powrót

String[] – adresy e-mail twórców wydarzenia,

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getDateCreated()

Pobiera datę utworzenia zdarzenia. Musisz mieć dostęp do kalendarza.

// 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');
}

Powrót

Date – data utworzenia,

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getDescription()

Pobiera opis zdarzenia. Musisz mieć uprawnienia do edycji kalendarza.

// 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');
}

Powrót

String – tekst reklamy,

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getEmailReminders()

Pobiera wartości minutowe wszystkich przypomnień e-mail dotyczących wydarzenia. Musisz mieć uprawnienia do edycji kalendarza.

// 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');
}

Powrót

Integer[] – tablica, w której każda wartość odpowiada liczbie minut przed zdarzeniem, w którym ma być wyświetlone przypomnienie.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getEndTime()

Pobiera datę i godzinę zakończenia tego wydarzenia w kalendarzu. Musisz mieć dostęp do kalendarza. W przypadku zdarzeń niebędących zdarzeniami całodniowymi jest to moment, w którym miało się ono zakończyć. W przypadku wydarzeń całodniowych, które przechowują tylko datę zakończenia (a nie datę i godzinę), jest to północ na początku dnia następującego po zakończeniu wydarzenia według strefy czasowej kalendarza. Umożliwia to porównywanie czasu zakończenia wszystkich typów zdarzeń, ale niekoniecznie zachowuje pierwotną datę.

W przypadku zdarzeń całodniowych metoda getAllDayEndDate() powinna być prawie zawsze wywoływana zamiast tej metody.

// 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');
}

Powrót

Date – czas zakończenia tego wydarzenia w kalendarzu.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getEventSeries()

Pobiera serię zdarzeń cyklicznych, do której należy to zdarzenie. Musisz mieć dostęp do kalendarza. Obiekt CalendarEventSeries jest zwracany, nawet jeśli to zdarzenie nie należy do serii, aby można było dodać nowe ustawienia powtarzania.

// 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');
}

Powrót

CalendarEventSeries – seria wydarzeń, do której należy to wydarzenie, lub nowa seria wydarzeń, jeśli to wydarzenie jeszcze do żadnej nie należy

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getEventType()

Pobiera wartość EventType tego zdarzenia.

// Opens the default calendar and logs all out-of-office events for the current day.
const calendar = CalendarApp.getDefaultCalendar();
const events = calendar.getEventsForDay(new Date());
console.log(events.filter(e => e.getEventType() === CalendarApp.EventType.OUT_OF_OFFICE));

Powrót

EventType – typ zdarzenia.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getGuestByEmail(email)

Pobiera dane gościa na podstawie adresu e-mail.

// 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());
}

Parametry

NazwaTypOpis
emailStringadres Gościa.

Powrót

EventGuest – gość lub wartość null, jeśli adres e-mail nie odpowiada gościowi;

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getGuestList()

Pobiera listę gości wydarzenia, z wyjątkiem właściciela wydarzenia.

// 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());
}

Powrót

EventGuest[] – tablica gości

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getGuestList(includeOwner)

Pobiera listę gości wydarzenia, w tym ewentualnie właścicieli wydarzenia.

// 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());
}

Parametry

NazwaTypOpis
includeOwnerBooleanczy właściciele mają być uwzględnieni jako goście.

Powrót

EventGuest[] – tablica gości

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getId()

Pobiera unikalny identyfikator iCalUID wydarzenia. Pamiętaj, że identyfikator iCalUID i identyfikator zdarzenia id używane przez interfejs Calendar API w wersji 3 i usługę zaawansowaną Kalendarza nie są identyczne i nie można ich stosować zamiennie. Jednym z różnic w semantyce jest to, że w przypadku cyklicznych zdarzeń wszystkie wystąpienia danego zdarzenia mają inny identyfikator ids, ale wszystkie mają ten sam identyfikator iCalUID.

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

Powrót

String – identyfikator iCalUID wydarzenia

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getLastUpdated()

Pobiera datę ostatniej modyfikacji wydarzenia.

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

Powrót

Date – data ostatniej aktualizacji,

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getLocation()

Pobiera lokalizację wydarzenia.

// 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');
}

Powrót

String – lokalizacja wydarzenia,

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getMyStatus()

Pobiera stan zdarzenia (np. uczestnictwo lub zaproszenie) skutecznego użytkownika. Zawsze zwraca GuestStatus.OWNER, jeśli użytkownik skuteczny jest właścicielem zdarzenia.

// 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');
}

Powrót

GuestStatus – stan

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getOriginalCalendarId()

Uzyskaj identyfikator kalendarza, w którym to wydarzenie zostało pierwotnie utworzone.

// 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');
}

Powrót

String – identyfikator oryginalnego kalendarza

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getPopupReminders()

Pobiera wartości minutowe wszystkich okien z przypomnieniem dla danego wydarzenia.

// 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');
}

Powrót

Integer[] – tablica, w której każda wartość odpowiada liczbie minut przed zdarzeniem, w którym ma być wyświetlone przypomnienie.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getSmsReminders()

Pobiera wartości minutowe wszystkich przypomnień SMS-owych dotyczących wydarzenia.

Powrót

Integer[] – tablica, w której każda wartość odpowiada liczbie minut przed zdarzeniem, w którym ma być wyświetlone przypomnienie.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getStartTime()

Pobiera datę i godzinę rozpoczęcia tego wydarzenia z kalendarza. W przypadku zdarzeń nieobejmujących całego dnia jest to moment zdefiniowanego rozpoczęcia. W przypadku wydarzeń całodniowych, które przechowują tylko datę rozpoczęcia (a nie datę i godzinę), jest to północ na początku dnia, w którym rozpoczyna się wydarzenie w strefie czasowej kalendarza. Umożliwia to porównywanie czasów rozpoczęcia wszystkich typów zdarzeń. Niekoniecznie jednak zachowuje pierwotny dzień roku.

W przypadku zdarzeń całodniowych funkcja getAllDayStartDate() powinna być prawie zawsze wywoływana zamiast tej metody.

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

Powrót

Date – czas rozpoczęcia tego wydarzenia w kalendarzu.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getTag(key)

Pobiera wartość tagu zdarzenia.

Parametry

NazwaTypOpis
keyStringklucza

Powrót

String – wartość tagu.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getTitle()

Pobiera nazwę zdarzenia.

// 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');
}

Powrót

String – tytuł

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getTransparency()

Pobiera przezroczystość zdarzenia. Za pomocą tej metody możesz określić, czy wydarzenie jest TRANSPARENT, co oznacza, że w tym czasie kalendarz jest widoczny jako Dostępny, czy OPAQUE, co oznacza, że w tym czasie kalendarz jest widoczny jako Zajęty.

// Gets the first event from the default calendar for today.
const today = new Date();
const event = CalendarApp.getDefaultCalendar().getEventsForDay(today)[0];
// Gets the event's transparency and logs it.
const transparency = event.getTransparency();
Logger.log(transparency);

Powrót

EventTransparency – wartość przezroczystości.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

getVisibility()

Pobiera widoczność zdarzenia.

// 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');
}

Powrót

Visibility – wartość widoczności

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

guestsCanInviteOthers()

Określa, czy goście mogą zapraszać innych gości.

// 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');
}

Powrót

Booleantrue, jeśli goście mogą zapraszać inne osoby; false, jeśli nie

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

guestsCanModify()

Określa, czy goście mogą modyfikować wydarzenie.

// 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');
}

Powrót

Booleantrue, jeśli goście mogą modyfikować wydarzenie; false, jeśli nie

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

guestsCanSeeGuests()

Określa, czy goście mogą widzieć innych gości.

// 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');
}

Powrót

Boolean – true, jeśli goście mogą widzieć innych gości; false, jeśli nie

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

isAllDayEvent()

Określa, czy jest to wydarzenie całodniowe.

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

Powrót

Boolean – true, jeśli wydarzenie trwa cały dzień, false w przeciwnym razie.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

isOwnedByMe()

Określa, czy jesteś właścicielem wydarzenia.

// 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');
}

Powrót

Boolean – true, jeśli właścicielem zdarzenia jest efektywny użytkownik, false w przeciwnym razie

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

isRecurringEvent()

Określa, czy zdarzenie należy do serii zdarzeń.

// 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');
}

Powrót

Boolean – true, jeśli zdarzenie należy do serii zdarzeń; false, jeśli tak nie jest.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

removeAllReminders()

usuwa wszystkie przypomnienia z wydarzenia.

// 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');
}

Powrót

CalendarEvent – ta CalendarEvent do tworzenia łańcuszków

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

removeGuest(email)

Usuwa gościa z wydarzenia.

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

  const calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  const 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
  const attendeeEmail =
      'user@example.com';  // Email address of the person you need to remove
  const calendarId =
      'calendar_123@group.calendar.google.com';  // ID of calendar with the
  // events
  const startDate = new Date(
      'YYYY-MM-DD');  // The first date to remove the guest from the events
  const endDate = new Date(
      'YYYY-MM-DD');  // The last date to remove the attendee from the events

  const calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  // Get the events within the specified timeframe
  const 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 (let i = 0; i < calEvents.length; i++) {
    const event = calEvents[i];
    event.removeGuest(attendeeEmail);
  }
}

Parametry

NazwaTypOpis
emailStringadres e-mail gościa.

Powrót

CalendarEvent – ta CalendarEvent do łańcucha

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

resetRemindersToDefault()

Przywraca przypomnienia przy użyciu ustawień domyślnych kalendarza.

// 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');
}

Powrót

CalendarEvent – ta CalendarEvent do łańcucha

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

setAllDayDate(date)

Ustawia datę zdarzenia. Zastosowanie tej metody powoduje przekształcenie zwykłego wydarzenia w wydarzenie całodniowe.

// 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');
}

Parametry

NazwaTypOpis
dateDatedata zdarzenia (czas jest ignorowany);

Powrót

CalendarEvent – to zdarzenie w kalendarzu do łańcucha;

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

setAllDayDates(startDate, endDate)

Ustawia daty wydarzenia. Zastosowanie tej metody powoduje przekształcenie zwykłego wydarzenia w wydarzenie całodniowe.

// 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');
}

Parametry

NazwaTypOpis
startDateDatedata rozpoczęcia zdarzenia (godzina jest ignorowana);
endDateDatedata zakończenia zdarzenia (godzina jest ignorowana);

Powrót

CalendarEvent – to zdarzenie w kalendarzu do łańcucha;

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

setAnyoneCanAddSelf(anyoneCanAddSelf)

Określa, czy osoby, które nie są gośćmi, mogą dodać się do wydarzenia.

// 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');
}

Parametry

NazwaTypOpis
anyoneCanAddSelfBooleanczy każdy może zaprosić samego siebie.

Powrót

CalendarEvent – ta CalendarEvent do łańcucha

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

setColor(color)

Ustawia kolor wydarzenia w kalendarzu.

// 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');
}

Parametry

NazwaTypOpis
colorStringCiąg znaków zawierający liczbę całkowitą indeksu koloru lub wartość z CalendarApp.EventColor.

Powrót

CalendarEvent – to wydarzenie w kalendarzu, które ma być połączone z innym wydarzeniem.

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

setDescription(description)

Ustawia opis zdarzenia.

// 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');
}

Parametry

NazwaTypOpis
descriptionStringnowy opis

Powrót

CalendarEvent – ta CalendarEvent do tworzenia łańcuszków

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

setGuestsCanInviteOthers(guestsCanInviteOthers)

Określa, czy goście mogą zapraszać innych gości.

// 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');
}

Parametry

NazwaTypOpis
guestsCanInviteOthersBooleanczy goście mogą zapraszać inne osoby.

Powrót

CalendarEvent – ta CalendarEvent do łańcucha

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

setGuestsCanModify(guestsCanModify)

Określa, czy goście mogą modyfikować wydarzenie.

Parametry

NazwaTypOpis
guestsCanModifyBooleanczy goście mogą modyfikować wydarzenie.

Powrót

CalendarEvent – ta CalendarEvent do łańcucha

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

setGuestsCanSeeGuests(guestsCanSeeGuests)

Określa, czy goście mogą widzieć innych gości.

Parametry

NazwaTypOpis
guestsCanSeeGuestsBooleanczy goście mogą widzieć innych

Powrót

CalendarEvent – ta CalendarEvent do tworzenia łańcuszków

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

setLocation(location)

Ustawia lokalizację wydarzenia.

// 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');
}

Parametry

NazwaTypOpis
locationStringnowa lokalizacja

Powrót

CalendarEvent – ta CalendarEvent do tworzenia łańcuszków

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

setMyStatus(status)

Ustawia stan użytkownika (np. uczestnictwo lub zaproszenie) w związku z danym zdarzeniem.

// 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');
}

Parametry

NazwaTypOpis
statusGuestStatusnowy stan

Powrót

CalendarEvent – ta CalendarEvent do łańcucha

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

setTag(key, value)

Ustawia tag klucz-wartość w zdarzeniu na potrzeby przechowywania niestandardowych metadanych.

Parametry

NazwaTypOpis
keyStringklucz tagu,
valueStringwartość tagu.

Powrót

CalendarEvent – ta CalendarEvent do tworzenia łańcuszków

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

setTime(startTime, endTime)

Ustawia daty i godziny rozpoczęcia oraz zakończenia wydarzenia. Zastosowanie tej metody powoduje przekształcenie wydarzenia całodniowego w zwykłe.

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

Parametry

NazwaTypOpis
startTimeDatenowy czas rozpoczęcia wydarzenia.
endTimeDatenowy koniec zdarzenia

Powrót

CalendarEvent – to zdarzenie w kalendarzu, które ma być połączone z innym zdarzeniem

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

setTitle(title)

Ustawia tytuł zdarzenia.

// 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');
}

Parametry

NazwaTypOpis
titleStringnowy tytuł

Powrót

CalendarEvent – ta CalendarEvent do łańcucha

Autoryzacja

Scenariusze, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów lub odpowiednich zakresów z powiązanego interfejsu API REST:

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

setTransparency(transparency)

Określa przezroczystość zdarzenia. Użyj tej metody, aby określić, czy zdarzenie jest TRANSPARENT, meaning the calendar shows as Available during that time, or OPAQUE, meaning the calendar shows as Busy during that time.

// 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');
// Sets the event's transparency to TRANSPARENT.
event.setTransparency(CalendarApp.EventTransparency.TRANSPARENT);

Parameters

NameTypeDescription
transparencyEventTransparencyThe transparency value.

Return

CalendarEvent — This CalendarEvent for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

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

setVisibility(visibility)

Sets the visibility of the event.

Parameters

NameTypeDescription
visibilityVisibility

Return

CalendarEvent — this CalendarEvent for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:

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