Mewakili kalender yang dimiliki atau diikuti oleh pengguna.
Metode
| Metode | Jenis nilai yang ditampilkan | Deskripsi singkat |
|---|---|---|
create | Calendar | Membuat acara sepanjang hari baru. |
create | Calendar | Membuat acara sepanjang hari baru yang dapat berlangsung selama beberapa hari. |
create | Calendar | Membuat acara sepanjang hari baru yang dapat berlangsung selama beberapa hari. |
create | Calendar | Membuat acara sepanjang hari baru. |
create | Calendar | Membuat rangkaian acara sepanjang hari baru. |
create | Calendar | Membuat rangkaian acara sepanjang hari baru. |
create | Calendar | Membuat acara baru. |
create | Calendar | Membuat acara baru. |
create | Calendar | Membuat acara dari deskripsi bentuk bebas. |
create | Calendar | Membuat rangkaian acara baru. |
create | Calendar | Membuat rangkaian acara baru. |
delete | void | Menghapus kalender secara permanen. |
get | String | Mendapatkan warna kalender. |
get | String | Mendapatkan deskripsi kalender. |
get | Calendar | Mendapatkan peristiwa dengan ID yang diberikan. |
get | Calendar | Mendapatkan seri acara dengan ID yang diberikan. |
get | Calendar | Mendapatkan semua peristiwa yang terjadi dalam rentang waktu tertentu. |
get | Calendar | Mendapatkan semua peristiwa yang terjadi dalam rentang waktu tertentu dan memenuhi kriteria yang ditentukan. |
get | Calendar | Mendapatkan semua acara yang terjadi pada hari tertentu. |
get | Calendar | Mendapatkan semua peristiwa yang terjadi pada hari tertentu dan memenuhi kriteria yang ditentukan. |
get | String | Mendapatkan ID kalender. |
get | String | Mendapatkan nama kalender. |
get | String | Mendapatkan zona waktu kalender. |
is | Boolean | Menentukan apakah kalender disembunyikan di antarmuka pengguna. |
is | Boolean | Menentukan apakah kalender adalah kalender utama untuk pengguna yang berlaku. |
is | Boolean | Menentukan apakah kalender dimiliki oleh Anda. |
is | Boolean | Menentukan apakah acara kalender ditampilkan di antarmuka pengguna. |
set | Calendar | Menetapkan warna kalender. |
set | Calendar | Menetapkan deskripsi kalender. |
set | Calendar | Menetapkan apakah kalender terlihat di antarmuka pengguna. |
set | Calendar | Menetapkan nama kalender. |
set | Calendar | Menetapkan apakah acara kalender ditampilkan di antarmuka pengguna. |
set | Calendar | Menetapkan zona waktu kalender. |
unsubscribe | void | Menghentikan langganan pengguna dari kalender. |
Dokumentasi mendetail
createAllDayEvent(title, date)
Membuat acara sepanjang hari baru.
// Creates an all-day event for the moon landing and logs the ID. const event = CalendarApp.getDefaultCalendar().createAllDayEvent( 'Apollo 11 Landing', new Date('July 20, 1969'), ); Logger.log(`Event ID: ${event.getId()}`);
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
title | String | Judul acara. |
date | Date | Tanggal acara (hanya hari yang digunakan; waktu diabaikan). |
Pulang pergi
CalendarEvent — 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
createAllDayEvent(title, startDate, endDate)
Membuat acara sepanjang hari baru yang dapat berlangsung selama beberapa hari.
// Creates an all-day event for the Woodstock festival (August 15th to 17th) and // logs the ID. const event = CalendarApp.getDefaultCalendar().createAllDayEvent( 'Woodstock Festival', new Date('August 15, 1969'), new Date('August 18, 1969'), ); Logger.log(`Event ID: ${event.getId()}`);
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
title | String | Judul acara. |
start | Date | Tanggal saat acara dimulai (hanya hari yang digunakan; waktu diabaikan). |
end | Date | Tanggal saat acara berakhir (hanya hari yang digunakan; waktu diabaikan). Tanggal akhir bersifat eksklusif. |
Pulang pergi
CalendarEvent — 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
createAllDayEvent(title, startDate, endDate, options)
Membuat acara sepanjang hari baru yang dapat berlangsung selama beberapa hari.
// Creates an all-day event for the Woodstock festival (August 15th to 17th) and // logs the ID. const 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
| Nama | Jenis | Deskripsi |
|---|---|---|
title | String | Judul acara. |
start | Date | Tanggal saat acara dimulai (hanya hari yang digunakan; waktu diabaikan). |
end | Date | Tanggal saat acara berakhir (hanya hari yang digunakan; waktu diabaikan). Tanggal akhir bersifat eksklusif. |
options | Object | Objek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah. |
Parameter lanjutan
| Nama | Jenis | Deskripsi |
|---|---|---|
description | String | Deskripsi acara. |
location | String | Lokasi acara tersebut. |
guests | String | Daftar alamat email yang dipisahkan koma yang harus ditambahkan sebagai tamu. |
send | Boolean | Apakah akan mengirim email undangan (default: false). |
Pulang pergi
CalendarEvent — 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
createAllDayEvent(title, date, options)
Membuat acara sepanjang hari baru.
// Creates an all-day event for the moon landing and logs the ID. const event = CalendarApp.getDefaultCalendar().createAllDayEvent( 'Apollo 11 Landing', new Date('July 20, 1969'), {location: 'The Moon'}, ); Logger.log(`Event ID: ${event.getId()}`);
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
title | String | Judul acara. |
date | Date | Tanggal acara (hanya hari yang digunakan; waktu diabaikan). |
options | Object | Objek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah. |
Parameter lanjutan
| Nama | Jenis | Deskripsi |
|---|---|---|
description | String | Deskripsi acara. |
location | String | Lokasi acara tersebut. |
guests | String | Daftar alamat email yang dipisahkan koma yang harus ditambahkan sebagai tamu. |
send | Boolean | Apakah akan mengirim email undangan (default: false). |
Pulang pergi
CalendarEvent — 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)
Membuat rangkaian acara sepanjang hari baru.
// Creates an event series for a no-meetings day, taking place every Wednesday // in 2013. const 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
| Nama | Jenis | Deskripsi |
|---|---|---|
title | String | judul acara dalam rangkaian |
start | Date | tanggal acara pertama dalam seri (hanya hari yang digunakan; waktu diabaikan) |
recurrence | Event | setelan 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 sepanjang hari baru.
// Creates an event series for a no-meetings day, taking place every Wednesday // in 2013. const 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
| Nama | Jenis | Deskripsi |
|---|---|---|
title | String | judul acara dalam rangkaian |
start | Date | tanggal acara pertama dalam seri (hanya hari yang digunakan; waktu diabaikan) |
recurrence | Event | setelan pengulangan rangkaian acara |
options | Object | objek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah |
Parameter lanjutan
| Nama | Jenis | Deskripsi |
|---|---|---|
description | String | deskripsi acara dalam rangkaian |
location | String | lokasi acara dalam rangkaian |
guests | String | daftar alamat email yang dipisahkan koma yang harus ditambahkan sebagai tamu ke acara dalam rangkaian |
send | Boolean | apakah akan mengirim 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 acara baru.
Jika tidak ada zona waktu yang ditentukan, nilai waktu ditafsirkan dalam konteks zona waktu skrip, yang mungkin berbeda dengan zona waktu kalender.
// Creates an event for the moon landing and logs the ID. const 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
| Nama | Jenis | Deskripsi |
|---|---|---|
title | String | judul acara |
start | Date | tanggal dan waktu saat acara dimulai |
end | Date | tanggal dan waktu saat acara berakhir |
Pulang pergi
CalendarEvent — 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, options)
Membuat acara baru.
Jika tidak ada zona waktu yang ditentukan, nilai waktu ditafsirkan dalam konteks zona waktu skrip, yang mungkin berbeda dengan zona waktu kalender.
// Creates an event for the moon landing and logs the ID. const 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
| Nama | Jenis | Deskripsi |
|---|---|---|
title | String | judul acara |
start | Date | tanggal dan waktu saat acara dimulai |
end | Date | tanggal dan waktu saat acara berakhir |
options | Object | objek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah |
Parameter lanjutan
| Nama | Jenis | Deskripsi |
|---|---|---|
description | String | deskripsi acara |
location | String | lokasi acara |
guests | String | daftar alamat email yang dipisahkan koma yang harus ditambahkan sebagai tamu |
send | Boolean | apakah akan mengirim email undangan (default: false) |
Pulang pergi
CalendarEvent — 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
createEventFromDescription(description)
Membuat acara dari deskripsi bentuk bebas.
Deskripsi harus menggunakan format yang sama dengan fitur "Tambahkan Cepat" UI.
// Creates a new event and logs its ID. const event = CalendarApp.getDefaultCalendar().createEventFromDescription( 'Lunch with Mary, Friday at 1PM', ); Logger.log(`Event ID: ${event.getId()}`);
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
description | String | deskripsi acara dalam bentuk bebas |
Pulang pergi
CalendarEvent — 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)
Membuat rangkaian acara baru.
// Creates an event series for a team meeting, taking place every Tuesday and // Thursday in 2013. const 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
| Nama | Jenis | Deskripsi |
|---|---|---|
title | String | judul acara dalam rangkaian |
start | Date | tanggal dan waktu saat acara pertama dalam rangkaian dimulai |
end | Date | tanggal dan waktu saat acara pertama dalam rangkaian berakhir |
recurrence | Event | setelan 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. const 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
| Nama | Jenis | Deskripsi |
|---|---|---|
title | String | judul acara dalam rangkaian |
start | Date | tanggal dan waktu saat acara pertama dalam rangkaian dimulai |
end | Date | tanggal dan waktu saat acara pertama dalam rangkaian berakhir |
recurrence | Event | setelan pengulangan rangkaian acara |
options | Object | objek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah |
Parameter lanjutan
| Nama | Jenis | Deskripsi |
|---|---|---|
description | String | deskripsi acara dalam rangkaian |
location | String | lokasi acara dalam rangkaian |
guests | String | daftar alamat email yang dipisahkan koma yang harus ditambahkan sebagai tamu ke acara dalam rangkaian |
send | Boolean | apakah akan mengirim 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 dimilikinya.
// Creates a calendar to delete. const calendar = CalendarApp.createCalendar('Test'); // Deletes the 'Test' calendar permanently. calendar.deleteCalendar();
Menampilkan
Error — jika ini adalah kalender yang 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 rangkaian acara termasuk dalam kalender selain kalender default, metode ini harus dipanggil dari kalender tersebut. Memanggil CalendarApp.getEventById(iCalId) saja
akan menampilkan acara di kalender default.
Beberapa acara dapat memiliki ID yang sama jika merupakan bagian dari seri acara. Dalam hal ini, metode ini hanya menampilkan peristiwa pertama dari rangkaian 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
| Nama | Jenis | Deskripsi |
|---|---|---|
iCalId | String | ID acara. |
Pulang pergi
CalendarEvent — Acara dengan ID yang diberikan, atau null jika acara 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 seri acara dengan ID yang diberikan. Jika ID yang diberikan adalah untuk satu CalendarEvent, maka CalendarEventSeries akan ditampilkan dengan satu peristiwa dalam rangkaian. Perhatikan bahwa jika rangkaian acara adalah milik kalender selain kalender default, metode ini harus dipanggil dari Calendar tersebut; memanggil CalendarApp.getEventSeriesById(iCalId) secara langsung hanya akan menampilkan rangkaian acara yang ada di 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
| Nama | Jenis | Deskripsi |
|---|---|---|
iCalId | String | ID rangkaian acara. |
Pulang pergi
CalendarEventSeries — Deret dengan ID yang diberikan, atau null jika deret 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 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 dengan zona waktu kalender.
// Determines how many events are happening in the next two hours. const now = new Date(); const twoHoursFromNow = new Date(now.getTime() + 2 * 60 * 60 * 1000); const events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow); Logger.log(`Number of events: ${events.length}`);
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
start | Date | awal rentang waktu |
end | Date | akhir rentang waktu, tidak inklusif |
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 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 dengan zona waktu kalender.
Perhatikan bahwa pemfilteran pada author, search, atau statusFilters terjadi setelah menerapkan start dan max. Artinya, jumlah peristiwa yang ditampilkan mungkin kurang dari max, meskipun ada peristiwa tambahan yang memenuhi kriteria.
// Determines how many events are happening in the next two hours that contain // the term "meeting". const now = new Date(); const twoHoursFromNow = new Date(now.getTime() + 2 * 60 * 60 * 1000); const events = CalendarApp.getDefaultCalendar().getEvents( now, twoHoursFromNow, {search: 'meeting'}, ); Logger.log(`Number of events: ${events.length}`);
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
start | Date | awal rentang waktu |
end | Date | akhir rentang waktu, tidak inklusif |
options | Object | objek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah |
Parameter lanjutan
| Nama | Jenis | Deskripsi |
|---|---|---|
start | Integer | indeks acara pertama yang akan ditampilkan |
max | Integer | jumlah maksimum peristiwa yang akan ditampilkan |
author | String | alamat email yang digunakan untuk memfilter hasil menurut kreator acara |
search | String | kueri penelusuran teks lengkap yang digunakan untuk memfilter hasil |
status | Guest | array 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 acara yang terjadi pada hari tertentu.
Metode ini menampilkan peristiwa jika peristiwa dimulai selama hari yang ditentukan, berakhir selama hari tersebut, atau mencakup hari tersebut.
Perhatikan bahwa hanya bagian tanggal dari objek Date yang digunakan, dan bagian waktu diabaikan. Tanggal ditafsirkan sebagai tengah malam pada hari itu hingga tengah malam pada hari berikutnya dalam zona waktu kalender.
// Determines how many events are happening today. const today = new Date(); const events = CalendarApp.getDefaultCalendar().getEventsForDay(today); Logger.log(`Number of events: ${events.length}`);
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
date | Date | tanggal untuk mengambil 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 menampilkan peristiwa jika peristiwa dimulai selama hari yang ditentukan, berakhir selama hari tersebut, atau mencakup hari tersebut.
Perhatikan bahwa hanya bagian tanggal dari objek Date yang digunakan, dan bagian waktu diabaikan. Tanggal ditafsirkan sebagai tengah malam pada hari itu hingga tengah malam pada hari berikutnya dalam zona waktu kalender.
Perhatikan bahwa pemfilteran pada author, search, atau statusFilters terjadi setelah menerapkan start dan max. Artinya, jumlah peristiwa yang ditampilkan mungkin kurang dari max, meskipun ada peristiwa tambahan yang memenuhi kriteria.
// Determines how many events are happening today and contain the term // "meeting". const today = new Date(); const events = CalendarApp.getDefaultCalendar().getEventsForDay(today, { search: 'meeting', }); Logger.log(`Number of events: ${events.length}`);
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
date | Date | tanggal untuk mengambil peristiwa (hanya hari yang digunakan; waktu diabaikan) |
options | Object | opsi pemfilteran lanjutan |
Parameter lanjutan
| Nama | Jenis | Deskripsi |
|---|---|---|
start | Integer | indeks acara pertama yang akan ditampilkan |
max | Integer | jumlah maksimum peristiwa yang akan ditampilkan |
author | String | alamat email yang digunakan untuk memfilter hasil menurut kreator acara |
search | String | kueri penelusuran teks lengkap yang digunakan untuk memfilter hasil |
status | Guest | array 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 format "long" (misalnya, "America/New_York", seperti yang tercantum
di 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
Boolean — true 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 berlaku.
// 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
Boolean — true jika kalender adalah kalender default untuk pengguna yang berlaku; false jika bukan.
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 dimiliki oleh 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
Boolean — true 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
Boolean — true 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
| Nama | Jenis | Deskripsi |
|---|---|---|
color | String | Calendar atau string warna heksadesimal
("#rrggbb"). |
Pulang pergi
Calendar — Kalender ini untuk dirangkaikan.
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
| Nama | Jenis | Deskripsi |
|---|---|---|
description | String | deskripsi kalender ini |
Pulang pergi
Calendar — kalender ini untuk dirangkaikan
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
| Nama | Jenis | Deskripsi |
|---|---|---|
hidden | Boolean | true untuk menyembunyikan kalender di antarmuka pengguna; false untuk menampilkannya |
Pulang pergi
Calendar — kalender ini untuk dirangkaikan
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
| Nama | Jenis | Deskripsi |
|---|---|---|
name | String | nama baru |
Pulang pergi
Calendar — kalender ini untuk dirangkaikan
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
| Nama | Jenis | Deskripsi |
|---|---|---|
selected | Boolean | true untuk menampilkan acara kalender di antarmuka pengguna; false
untuk menyembunyikannya |
Pulang pergi
Calendar — kalender ini untuk dirangkaikan
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
| Nama | Jenis | Deskripsi |
|---|---|---|
time | String | Zona waktu, ditentukan dalam format "panjang" (seperti "America/New_York", seperti yang tercantum di Joda.org). |
Pulang pergi
Calendar — Kalender ini untuk dirangkaikan.
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 daftar Kalender saya. Mereka dapat berhenti berlangganan kalender yang tercantum di bagian Kalender lainnya.
// 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 ini adalah kalender milik Anda
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