Halaman ini diterjemahkan oleh Cloud Translation API.

Jenis peristiwa

Halaman ini menjelaskan properti eventType, dan spesifikasi jenis peristiwa yang tersedia di Google Calendar API.

Google Kalender memungkinkan pengguna membuat acara umum, serta acara yang didesain untuk kasus penggunaan tertentu dan dengan properti kustom.

Jenis peristiwa dapat ditemukan di tempat berikut di API:

Semua peristiwa ditampilkan dengan eventType.
eventType harus ditetapkan saat membuat atau memperbarui fasilitas acara. Jika tidak disetel, Jenis 'default' akan digunakan.
eventTypes dapat ditentukan dalam Peristiwa:daftar {i>call to list<i} dari jenis peristiwa tertentu. Jika tidak ada jenis yang ditentukan, semua jenis peristiwa akan dikembalikan.
eventTypes dapat ditentukan di Peristiwa:watch panggilan untuk berlangganan pembaruan tentang peristiwa jenis tertentu. Jika tidak ada jenis yang yang ditentukan, permintaan akan menghasilkan langganan ke semua jenis peristiwa.

Peristiwa default

Acara dengan jenis peristiwa default dibuat dan digunakan sebagai salah satu jenis peristiwa utama Google Calendar API. Model tersebut mendukung berbagai properti yang dapat digunakan untuk menyesuaikan peristiwa lebih lanjut.

Lihat Buat peristiwa untuk mulai digunakan Acara Google Kalender.

Ulang tahun

Ulang tahun adalah acara spesial sepanjang hari dengan pengulangan tahunan. Tombol tersebut memiliki spesifikasi berikut:

eventType ditetapkan ke 'birthday'.
start dan Kolom end harus menentukan acara sepanjang hari yang berlangsung tepat satu hari.
Nilai kolom visibility harus 'private'.
Nilai kolom transparency harus 'transparent'.
Perlu melakukan pengulangan tahunan, yang berarti bahwa Kolom recurrence harus 'RRULE:FREQ=YEARLY'. Acara ulang tahun yang jatuh pada tanggal 29 Februari harus memiliki aturan pengulangan berikut: 'RRULE:FREQ=YEARLY;BYMONTH=2;BYMONTHDAY=-1'.
Dapat memiliki colorId, summary dan reminders.
Tidak mendukung properti peristiwa lainnya.

Acara dari Gmail

Acara yang dibuat secara otomatis dari Gmail memiliki jenis peristiwa 'fromGmail'.

Google Calendar API tidak mengizinkan pembuatan jenis acara ini menggunakan insert.

API memungkinkan pembaruan colorId, reminders, visibility, transparency, status, private dan shared properti yang diperluas menggunakan pembaruan dan metode patch.

API ini mendukung get dan daftar metode untuk membaca peristiwa dari Gmail Anda. eventTypes dapat berupa disetel ke 'fromGmail' untuk hanya mencantumkan acara yang dibuat dari Gmail. Jika tidak ada jenis yang tertentu, acara dari Gmail akan dicantumkan bersama semua jenis acara lainnya.

API ini mendukung metode watch untuk berlangganan untuk menerima perubahan acara dari Gmail di Google Kalender. Jika tidak ada jenis yang yang ditentukan, semua jenis peristiwa, termasuk 'fromGmail', akan menjadi langganan.

Acara dari Gmail dapat dihapus menggunakan delete dari API Google Kalender.

Mengubah penyelenggara acara dari Gmail menggunakan pindahkan atau Metode update tidak didukung.

Waktu fokus, tidak di kantor, dan lokasi kerja

Google Calendar API dapat digunakan untuk membuat dan mengelola acara yang menampilkan status pengguna Google Kalender.

Fitur ini hanya tersedia di kalender utama, dan untuk beberapa pengguna Google Kalender. Lihat Mengelola waktu fokus, tidak di kantor, dan bekerja peristiwa lokasi untuk mempelajari lebih lanjut.

Jelajahi jenis acara di Google Apps Script

Google Apps Script adalah cloud berbasis JavaScript bahasa skrip yang memungkinkan Anda membangun aplikasi bisnis yang terintegrasi dengan Gemini untuk Google Workspace. Skrip dikembangkan dalam editor kode berbasis browser, dan file tersebut disimpan dan dijalankan di server Google. Lihat juga Google Apps Script panduan memulai untuk mulai menggunakan Apps Script untuk mengirim permintaan ke Google Calendar API.

Petunjuk berikut menjelaskan cara membaca dan mengelola peristiwa menggunakan Google Calendar API sebagai layanan lanjutan dalam Skrip Google Apps. Untuk mengetahui daftar lengkap referensi dan metode Google Calendar API, baca dokumentasi referensi.

Membuat dan menyiapkan skrip

Buat skrip dengan membuka script.google.com/create.
Pada panel kiri di samping Layanan, klik Tambahkan layanan .
Pilih Google Calendar API dan klik Tambahkan.
Setelah diaktifkan, API akan muncul di panel kiri. Metode dan kelas di API dapat dicantumkan menggunakan kata kunci Kalender di editor.

(Opsional) Mengupdate project Google Cloud

Setiap project Google Apps Script memiliki project Google Cloud yang terkait. Nama dapat menggunakan project default yang otomatis digunakan Google Apps Script buat. Jika ingin menggunakan project Google Cloud kustom, lihat Beralih ke project Cloud standar yang berbeda. Setelah menyiapkan project Google Cloud, pilih Editor di sisi kiri untuk kembali ke editor kode.

Menambahkan kode ke skrip

Contoh kode berikut menunjukkan cara membuat daftar, membaca, dan membuat peristiwa dengan nilai eventType yang berbeda.

Tempel kode berikut ke dalam editor kode.

const CALENDAR_ID = 'CALENDAR_ID' || 'primary';

/** Lists default events. */
function listDefaultEvents() {
  listEvents('default');
}

/** Lists events from Gmail. */
function listEventsFromGmail() {
  listEvents('fromGmail');
}

/**
  * Lists events with the given event type. If no type is specified, lists all events.
  * See https://developers.google.com/calendar/api/v3/reference/events/list
  */
function listEvents(eventType = undefined) {
  // Query parameters for the list request.
  const optionalArgs = {
    eventTypes: eventType ? [eventType] : undefined,
    singleEvents: true,
    timeMax: '2024-07-30T00:00:00+01:00',
    timeMin: '2024-07-29T00:00:00+01:00',
  }
  try {
    var response = Calendar.Events.list(CALENDAR_ID, optionalArgs);
    response.items.forEach(event => console.log(event));
  } catch (exception) {
    console.log(exception.message);
  }
}

/**
  * Reads the event with the given eventId.
  * See https://developers.google.com/calendar/api/v3/reference/events/get
  */
function readEvent() {
  try {
    var response = Calendar.Events.get(CALENDAR_ID, 'EVENT_ID');
    console.log(response);
  } catch (exception) {
    console.log(exception.message);
  }
}

/** Creates a default event. */
function createDefaultEvent() {
  const event = {
    start: { dateTime: '2024-07-30T10:30:00+01:00'},
    end: { dateTime: '2024-07-30T12:30:00+01:00'},
    description: 'Created from Apps Script.',
    eventType: 'default',
    summary: 'Sample event',
  }
  createEvent(event);
}

/**
  * Creates a Calendar event.
  * See https://developers.google.com/calendar/api/v3/reference/events/insert
  */
function createEvent(event) {

  try {
    var response = Calendar.Events.insert(event, CALENDAR_ID);
    console.log(response);
  } catch (exception) {
    console.log(exception.message);
  }
}

Ganti kode berikut:

CALENDAR_ID: Alamat email kalender ke mengambil dan membuat peristiwa. Konstanta ini awalnya ditetapkan ke 'primary', yang merupakan kata kunci untuk mengakses kalender utama yang sudah login. Mengubah nilai ini memungkinkan Anda membaca acara di kalender pengguna lain yang dapat Anda akses.
EVENT_ID: ID peristiwa. Anda dapat memanggil Events:list untuk mengambil ID peristiwa.

Menjalankan contoh kode

Di atas editor kode, pilih fungsi yang akan dijalankan dari menu {i>drop-down<i}, lalu klik Run.
Pada eksekusi pertama, Anda akan diminta untuk mengizinkan akses. Tinjau dan izinkan Apps Script untuk mengakses kalender Anda.
Anda dapat memeriksa hasil eksekusi skrip di Execution Log yang muncul di bagian bawah jendela.