Class Calendar

Kalender

Merepresentasikan kalender yang dimiliki atau disubscribe pengguna.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
createAllDayEvent(title, date)CalendarEventMembuat acara baru sepanjang hari.
createAllDayEvent(title, startDate, endDate)CalendarEventMembuat acara baru sepanjang hari yang dapat berlangsung beberapa hari.
createAllDayEvent(title, startDate, endDate, options)CalendarEventMembuat acara baru sepanjang hari yang dapat berlangsung beberapa hari.
createAllDayEvent(title, date, options)CalendarEventMembuat acara baru sepanjang hari.
createAllDayEventSeries(title, startDate, recurrence)CalendarEventSeriesMembuat rangkaian acara baru sepanjang hari.
createAllDayEventSeries(title, startDate, recurrence, options)CalendarEventSeriesMembuat rangkaian acara baru sepanjang hari.
createEvent(title, startTime, endTime)CalendarEventMembuat peristiwa baru.
createEvent(title, startTime, endTime, options)CalendarEventMembuat peristiwa baru.
createEventFromDescription(description)CalendarEventMembuat peristiwa dari deskripsi bentuk bebas.
createEventSeries(title, startTime, endTime, recurrence)CalendarEventSeriesMembuat rangkaian acara baru.
createEventSeries(title, startTime, endTime, recurrence, options)CalendarEventSeriesMembuat rangkaian acara baru.
deleteCalendar()voidMenghapus kalender secara permanen.
getColor()StringMendapatkan warna kalender.
getDescription()StringMendapatkan deskripsi kalender.
getEventById(iCalId)CalendarEventMendapatkan peristiwa dengan ID yang diberikan.
getEventSeriesById(iCalId)CalendarEventSeriesMendapatkan rangkaian acara dengan ID yang diberikan.
getEvents(startTime, endTime)CalendarEvent[]Mendapatkan semua peristiwa yang terjadi dalam rentang waktu tertentu.
getEvents(startTime, endTime, options)CalendarEvent[]Mendapatkan semua peristiwa yang terjadi dalam rentang waktu tertentu dan memenuhi kriteria yang ditentukan.
getEventsForDay(date)CalendarEvent[]Mendapatkan semua peristiwa yang terjadi pada hari tertentu.
getEventsForDay(date, options)CalendarEvent[]Mendapatkan semua peristiwa yang terjadi pada hari tertentu dan memenuhi kriteria yang ditentukan.
getId()StringMendapatkan ID kalender.
getName()StringMendapatkan nama kalender.
getTimeZone()StringMendapatkan zona waktu kalender.
isHidden()BooleanMenentukan apakah kalender disembunyikan di antarmuka pengguna.
isMyPrimaryCalendar()BooleanMenentukan apakah kalender adalah kalender utama untuk pengguna yang efektif.
isOwnedByMe()BooleanMenentukan apakah kalender tersebut milik Anda.
isSelected()BooleanMenentukan apakah acara kalender ditampilkan di antarmuka pengguna.
setColor(color)CalendarMenetapkan warna kalender.
setDescription(description)CalendarMenetapkan deskripsi kalender.
setHidden(hidden)CalendarMenetapkan apakah kalender terlihat di antarmuka pengguna.
setName(name)CalendarMenetapkan nama kalender.
setSelected(selected)CalendarMenetapkan apakah acara kalender ditampilkan di antarmuka pengguna.
setTimeZone(timeZone)CalendarMenetapkan zona waktu kalender.
unsubscribeFromCalendar()voidMenghentikan langganan pengguna dari kalender.

Dokumentasi mendetail

createAllDayEvent(title, date)

Membuat acara baru sepanjang hari.

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

Parameter

NamaJenisDeskripsi
titleStringJudul acara.
dateDateTanggal peristiwa (hanya hari yang digunakan; waktu akan diabaikan).

Pulang pergi

CalendarEvent — Peristiwa yang dibuat.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

createAllDayEvent(title, startDate, endDate)

Membuat acara baru sepanjang hari yang dapat berlangsung beberapa hari.

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

Parameter

NamaJenisDeskripsi
titleStringJudul acara.
startDateDateTanggal saat acara dimulai (hanya hari yang digunakan; waktu akan diabaikan).
endDateDateTanggal saat acara berakhir (hanya hari yang digunakan; waktu diabaikan). Tujuan tanggal akhir bersifat eksklusif.

Pulang pergi

CalendarEvent — Peristiwa yang dibuat.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

createAllDayEvent(title, startDate, endDate, options)

Membuat acara baru sepanjang hari yang dapat berlangsung beberapa hari.

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

Parameter

NamaJenisDeskripsi
titleStringJudul acara.
startDateDateTanggal saat acara dimulai (hanya hari yang digunakan; waktu akan diabaikan).
endDateDateTanggal saat acara berakhir (hanya hari yang digunakan; waktu diabaikan). Tujuan tanggal akhir bersifat eksklusif.
optionsObjectObjek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah ini.

Parameter lanjutan

NamaJenisDeskripsi
descriptionStringDeskripsi peristiwa.
locationStringLokasi acara tersebut.
guestsStringDaftar alamat email yang dipisahkan koma yang harus ditambahkan sebagai tamu.
sendInvitesBooleanApakah akan mengirim email undangan (default: false).

Pulang pergi

CalendarEvent — Peristiwa yang dibuat.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

createAllDayEvent(title, date, options)

Membuat acara baru sepanjang hari.

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

Parameter

NamaJenisDeskripsi
titleStringJudul acara.
dateDateTanggal peristiwa (hanya hari yang digunakan; waktu akan diabaikan).
optionsObjectObjek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah ini.

Parameter lanjutan

NamaJenisDeskripsi
descriptionStringDeskripsi peristiwa.
locationStringLokasi acara tersebut.
guestsStringDaftar alamat email yang dipisahkan koma yang harus ditambahkan sebagai tamu.
sendInvitesBooleanApakah akan mengirim email undangan (default: false).

Pulang pergi

CalendarEvent — Peristiwa yang dibuat.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

createAllDayEventSeries(title, startDate, recurrence)

Membuat rangkaian acara baru sepanjang hari.

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

Parameter

NamaJenisDeskripsi
titleStringjudul acara dalam seri
startDateDatetanggal acara pertama dalam rangkaian (hanya hari yang digunakan; waktu diabaikan)
recurrenceEventRecurrencesetelan pengulangan rangkaian acara

Pulang pergi

CalendarEventSeries — rangkaian acara yang dibuat

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

createAllDayEventSeries(title, startDate, recurrence, options)

Membuat rangkaian acara baru sepanjang hari.

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

Parameter

NamaJenisDeskripsi
titleStringjudul acara dalam seri
startDateDatetanggal acara pertama dalam rangkaian (hanya hari yang digunakan; waktu diabaikan)
recurrenceEventRecurrencesetelan pengulangan rangkaian acara
optionsObjectobjek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah ini

Parameter lanjutan

NamaJenisDeskripsi
descriptionStringdeskripsi acara dalam rangkaian
locationStringlokasi acara dalam rangkaian
guestsStringdaftar alamat email yang dipisahkan koma yang harus ditambahkan sebagai tamu acara dalam rangkaian
sendInvitesBooleanapakah akan mengirimkan email undangan (default: false)

Pulang pergi

CalendarEventSeries — rangkaian acara yang dibuat

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

createEvent(title, startTime, endTime)

Membuat peristiwa baru.

Jika tidak ada zona waktu yang ditentukan, nilai waktu akan ditafsirkan dalam konteks zona waktu, yang mungkin berbeda dari zona waktu kalender.

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

Parameter

NamaJenisDeskripsi
titleStringjudul acara
startTimeDatetanggal dan waktu acara dimulai
endTimeDatetanggal dan waktu acara berakhir

Pulang pergi

CalendarEvent — peristiwa yang dibuat

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

createEvent(title, startTime, endTime, options)

Membuat peristiwa baru.

Jika tidak ada zona waktu yang ditentukan, nilai waktu akan ditafsirkan dalam konteks zona waktu, yang mungkin berbeda dari zona waktu kalender.

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

Parameter

NamaJenisDeskripsi
titleStringjudul acara
startTimeDatetanggal dan waktu acara dimulai
endTimeDatetanggal dan waktu acara berakhir
optionsObjectobjek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah ini

Parameter lanjutan

NamaJenisDeskripsi
descriptionStringdeskripsi acara
locationStringlokasi acara
guestsStringdaftar alamat email yang dipisahkan koma yang harus ditambahkan sebagai tamu
sendInvitesBooleanapakah akan mengirimkan email undangan (default: false)

Pulang pergi

CalendarEvent — peristiwa yang dibuat

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

createEventFromDescription(description)

Membuat peristiwa dari deskripsi bentuk bebas.

Deskripsi harus menggunakan format yang sama dengan fitur "Quick Add" UI.

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

Parameter

NamaJenisDeskripsi
descriptionStringdeskripsi acara dalam bentuk bebas

Pulang pergi

CalendarEvent — peristiwa yang dibuat

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

createEventSeries(title, startTime, endTime, recurrence)

Membuat rangkaian acara baru.

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

Parameter

NamaJenisDeskripsi
titleStringjudul acara dalam seri
startTimeDatetanggal dan waktu mulai acara pertama dalam rangkaian
endTimeDatetanggal dan waktu saat acara pertama dalam rangkaian berakhir
recurrenceEventRecurrencesetelan pengulangan rangkaian acara

Pulang pergi

CalendarEventSeries — rangkaian acara yang dibuat

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

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

Membuat rangkaian acara baru.

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

Parameter

NamaJenisDeskripsi
titleStringjudul acara dalam seri
startTimeDatetanggal dan waktu mulai acara pertama dalam rangkaian
endTimeDatetanggal dan waktu saat acara pertama dalam rangkaian berakhir
recurrenceEventRecurrencesetelan pengulangan rangkaian acara
optionsObjectobjek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah ini

Parameter lanjutan

NamaJenisDeskripsi
descriptionStringdeskripsi acara dalam rangkaian
locationStringlokasi acara dalam rangkaian
guestsStringdaftar alamat email yang dipisahkan koma yang harus ditambahkan sebagai tamu acara dalam rangkaian
sendInvitesBooleanapakah akan mengirimkan email undangan (default: false)

Pulang pergi

CalendarEventSeries — rangkaian acara yang dibuat

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

deleteCalendar()

Menghapus kalender secara permanen. Pengguna hanya dapat menghapus kalender yang mereka miliki.

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

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

Menampilkan

Error — jika kalender ini diimpor.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

getColor()

Mendapatkan warna kalender.

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

// Gets the color of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getColor() instead.
const calendarColor = calendar.getColor();
console.log(calendarColor);

Pulang pergi

String — String warna heksadesimal ("#rrggbb").

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

getDescription()

Mendapatkan deskripsi kalender.

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

// Sets the description of the calendar to 'Test description.'
calendar.setDescription('Test description');

// Gets the description of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getDescription() instead.
const description = calendar.getDescription();
console.log(description);

Pulang pergi

String — Deskripsi kalender ini.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

getEventById(iCalId)

Mendapatkan peristiwa dengan ID yang diberikan. Jika seri termasuk dalam kalender selain kalender default kalender, metode ini harus dipanggil dari kalender tersebut. Hanya menelepon CalendarApp.getEventById(iCalId) mengembalikan acara dalam kalender default.

Beberapa acara mungkin memiliki ID yang sama jika merupakan bagian dari rangkaian acara. Dalam hal ini, hanya menampilkan peristiwa pertama dari deret tersebut.

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

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

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

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

Parameter

NamaJenisDeskripsi
iCalIdStringID peristiwa.

Pulang pergi

CalendarEvent — Peristiwa dengan ID yang diberikan, atau null jika peristiwa tidak ada atau pengguna tidak dapat mengaksesnya.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

getEventSeriesById(iCalId)

Mendapatkan rangkaian acara dengan ID yang diberikan. Jika ID yang diberikan adalah untuk satu CalendarEvent, maka CalendarEventSeries ditampilkan dengan satu peristiwa dalam rangkaian. Perhatikan bahwa jika rangkaian acara merupakan milik kalender selain kalender default, metode ini harus dipanggil dari Calendar tersebut; memanggil CalendarApp.getEventSeriesById(iCalId) secara langsung hanya menampilkan rangkaian acara yang ada dalam kalender default.

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

// Creates an event series for a daily team meeting from 1 PM to 2 PM.
// The series adds the daily event from January 1, 2023 through December 31, 2023.
const eventSeries = calendar.createEventSeries('Team meeting',
  new Date('Jan 1, 2023 13:00:00'),
  new Date('Jan 1, 2023 14:00:00'),
  CalendarApp.newRecurrence().addDailyRule().until(new Date('Jan 1, 2024')));

// Gets the ID of the event series.
const iCalId = eventSeries.getId();

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

Parameter

NamaJenisDeskripsi
iCalIdStringID rangkaian acara.

Pulang pergi

CalendarEventSeries — Deret dengan ID yang diberikan, atau null jika seri tidak ada atau pengguna tidak dapat mengaksesnya.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

getEvents(startTime, endTime)

Mendapatkan semua peristiwa yang terjadi dalam rentang waktu tertentu.

Metode ini menampilkan peristiwa yang dimulai selama rentang waktu tertentu, berakhir selama waktu tersebut rentang waktu, atau mencakup rentang waktu. Jika tidak ada zona waktu yang ditentukan, nilai waktu akan ditafsirkan dalam konteks zona waktu skrip, yang mungkin berbeda dari zona waktu kalender.

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

Parameter

NamaJenisDeskripsi
startTimeDateawal rentang waktu
endTimeDateakhir rentang waktu, tidak termasuk

Pulang pergi

CalendarEvent[] — peristiwa yang terjadi dalam rentang waktu

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

getEvents(startTime, endTime, options)

Mendapatkan semua peristiwa yang terjadi dalam rentang waktu tertentu dan memenuhi kriteria yang ditentukan.

Metode ini menampilkan peristiwa yang dimulai selama rentang waktu tertentu, berakhir selama waktu tersebut rentang waktu, atau mencakup rentang waktu. Jika tidak ada zona waktu yang ditentukan, nilai waktu akan ditafsirkan dalam konteks zona waktu skrip, yang mungkin berbeda dari zona waktu kalender.

Perlu diketahui bahwa memfilter pada author, search, atau statusFilters memerlukan setelah menerapkan start dan max. Artinya, jumlah peristiwa yang ditampilkan mungkin kurang dari max, meskipun peristiwa tambahan memenuhi kriteria.

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

Parameter

NamaJenisDeskripsi
startTimeDateawal rentang waktu
endTimeDateakhir rentang waktu, tidak termasuk
optionsObjectobjek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah ini

Parameter lanjutan

NamaJenisDeskripsi
startIntegerindeks peristiwa pertama untuk
maxIntegerjumlah maksimum peristiwa yang akan ditampilkan
authorStringalamat email yang digunakan untuk memfilter hasil oleh pembuat acara
searchStringkueri penelusuran teks lengkap yang digunakan untuk memfilter hasil
statusFilters[]GuestStatusarray status yang digunakan untuk memfilter hasil

Pulang pergi

CalendarEvent[] — peristiwa yang terjadi dalam rentang waktu dan cocok dengan kriteria

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

getEventsForDay(date)

Mendapatkan semua peristiwa yang terjadi pada hari tertentu.

Metode ini akan menampilkan peristiwa jika dimulai pada hari yang ditentukan, berakhir pada siang hari, atau mencakup hari itu.

Perhatikan bahwa hanya bagian tanggal dari objek Date yang digunakan, dan bagian waktu akan diabaikan. Tanggal akan ditafsirkan sebagai tengah malam pada hari itu hingga tengah malam hari berikutnya dalam waktu kalender zona waktu.

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

Parameter

NamaJenisDeskripsi
dateDatetanggal pengambilan peristiwa (hanya hari yang digunakan; waktu diabaikan)

Pulang pergi

CalendarEvent[] — peristiwa yang terjadi pada tanggal tertentu

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

getEventsForDay(date, options)

Mendapatkan semua peristiwa yang terjadi pada hari tertentu dan memenuhi kriteria yang ditentukan.

Metode ini akan menampilkan peristiwa jika dimulai pada hari yang ditentukan, berakhir pada siang hari, atau mencakup hari itu.

Perhatikan bahwa hanya bagian tanggal dari objek Date yang digunakan, dan bagian waktu akan diabaikan. Tanggal akan ditafsirkan sebagai tengah malam pada hari itu hingga tengah malam hari berikutnya dalam waktu kalender zona waktu.

Perlu diketahui bahwa memfilter pada author, search, atau statusFilters memerlukan setelah menerapkan start dan max. Artinya, jumlah peristiwa yang ditampilkan mungkin kurang dari max, meskipun peristiwa tambahan memenuhi kriteria.

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

Parameter

NamaJenisDeskripsi
dateDatetanggal pengambilan peristiwa (hanya hari yang digunakan; waktu diabaikan)
optionsObjectopsi pemfilteran lanjutan

Parameter lanjutan

NamaJenisDeskripsi
startIntegerindeks peristiwa pertama untuk
maxIntegerjumlah maksimum peristiwa yang akan ditampilkan
authorStringalamat email yang digunakan untuk memfilter hasil oleh pembuat acara
searchStringkueri penelusuran teks lengkap yang digunakan untuk memfilter hasil
statusFilters[]GuestStatusarray status yang digunakan untuk memfilter hasil

Pulang pergi

CalendarEvent[] — peristiwa yang terjadi pada tanggal tertentu dan cocok dengan kriteria

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

getId()

Mendapatkan ID kalender. ID untuk kalender default pengguna adalah alamat emailnya.

// Opens the calendar by its ID.
// To get the user's default calendar, use CalendarApp.getDefaultCalendar().
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

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

Pulang pergi

String — ID kalender.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

getName()

Mendapatkan nama kalender.

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

// Gets the name of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getName() instead.
const calendarName = calendar.getName();
console.log(calendarName);

Pulang pergi

String — Nama kalender ini.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

getTimeZone()

Mendapatkan zona waktu kalender.

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

// Gets the time zone of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getTimeZone() instead.
const timeZone = calendar.getTimeZone();
console.log(timeZone);

Pulang pergi

String — Zona waktu, ditentukan dalam "panjang" (misalnya, "America/New_York", seperti yang tercantum oleh Joda.org).

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

isHidden()

Menentukan apakah kalender disembunyikan di antarmuka pengguna.

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

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

Pulang pergi

Booleantrue jika kalender disembunyikan di antarmuka pengguna; false jika tidak.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

isMyPrimaryCalendar()

Menentukan apakah kalender adalah kalender utama untuk pengguna yang efektif.

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

// Determines whether the calendar is the default calendar for
// the effective user and logs it to the console.
// For the default calendar, you can use CalendarApp.isMyPrimaryCalendar() instead.
const isMyPrimaryCalendar = calendar.isMyPrimaryCalendar();
console.log(isMyPrimaryCalendar);

Pulang pergi

Booleantrue jika kalender adalah kalender default untuk pengguna yang efektif; false jika tidak.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

isOwnedByMe()

Menentukan apakah kalender tersebut milik Anda.

// Gets a calendar by its ID. To get the user's default calendar, use
// CalendarApp.getDefault() instead.
// TODO(developer): Replace the ID with the calendar ID that you want to use.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Determines whether the calendar is owned by you and logs it.
console.log(calendar.isOwnedByMe());

Pulang pergi

Booleantrue jika kalender dimiliki oleh Anda; false jika tidak.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

isSelected()

Menentukan apakah acara kalender ditampilkan di antarmuka pengguna.

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

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

Pulang pergi

Booleantrue jika acara kalender ditampilkan di antarmuka pengguna; false jika tidak

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

setColor(color)

Menetapkan warna kalender.

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

// Sets the color of the calendar to pink using the Calendar Color enum.
// For the default calendar, you can use CalendarApp.setColor() instead.
calendar.setColor(CalendarApp.Color.PINK);

Parameter

NamaJenisDeskripsi
colorStringCalendarApp.Color atau string warna heksadesimal ("#rrggbb").

Pulang pergi

Calendar — Kalender ini untuk rantai.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

setDescription(description)

Menetapkan deskripsi kalender.

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

// Sets the description of the calendar.
// TODO(developer): Update the string with the description that you want to use.
calendar.setDescription('Updated calendar description.')

Parameter

NamaJenisDeskripsi
descriptionStringdeskripsi kalender ini

Pulang pergi

Calendar — kalender ini untuk rantai

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

setHidden(hidden)

Menetapkan apakah kalender terlihat di antarmuka pengguna.

Parameter

NamaJenisDeskripsi
hiddenBooleantrue untuk menyembunyikan kalender di antarmuka pengguna; false untuk menampilkannya

Pulang pergi

Calendar — kalender ini untuk rantai

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

setName(name)

Menetapkan nama kalender.

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

// Sets the name of the calendar.
// TODO(developer): Update the string with the name that you want to use.
calendar.setName('Example calendar name');

Parameter

NamaJenisDeskripsi
nameStringnama baru

Pulang pergi

Calendar — kalender ini untuk rantai

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

setSelected(selected)

Menetapkan apakah acara kalender ditampilkan di antarmuka pengguna.

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

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

Parameter

NamaJenisDeskripsi
selectedBooleantrue untuk menampilkan acara kalender di antarmuka pengguna; false untuk menyembunyikannya

Pulang pergi

Calendar — kalender ini untuk rantai

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

setTimeZone(timeZone)

Menetapkan zona waktu kalender.

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

// Sets the time zone of the calendar to America/New York (US/Eastern) time.
calendar.setTimeZone('America/New_York');

Parameter

NamaJenisDeskripsi
timeZoneStringZona waktu, ditentukan dalam "panjang" (seperti "America/New_York", seperti dicantumkan oleh Joda.org).

Pulang pergi

Calendar — Kalender ini untuk rantai.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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

unsubscribeFromCalendar()

Menghentikan langganan pengguna dari kalender. Pengguna tidak dapat berhenti berlangganan dari kalender yang tercantum di bagian Daftar Kalender saya. Mereka dapat berhenti berlangganan dari kalender yang tercantum di bagian Lainnya kalender.

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

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

Menampilkan

Error — jika kalender ini adalah kalender yang dimiliki

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:

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