Properti yang diperluas

Kolom Referensi peristiwa mencakup data paling umum yang terkait dengan peristiwa, seperti lokasi, waktu mulai, dll., tetapi aplikasi mungkin ingin menyimpan metadata tambahan yang khusus untuk kasus penggunaannya. Calendar API memberikan kemampuan untuk menetapkan pasangan nilai kunci tersembunyi dengan peristiwa, yang disebut properti yang diperluas. Properti yang diperluas memudahkan penyimpanan data khusus aplikasi untuk peristiwa tanpa harus menggunakan database eksternal.

Visibilitas

Ada dua jenis properti yang diperluas yang tersedia: pribadi dan bersama. Properti bersama dapat dilihat dan diedit oleh semua tamu acara, sedangkan properti pribadi ditetapkan di "salinan" lokal satu tamu acara. Lebih konkritnya, properti pribadi khusus untuk calendarId dan eventId yang digunakan dalam permintaan, sedangkan properti bersama akan ditampilkan terlepas dari calendarId yang digunakan dalam permintaan.

Menambahkan & memperbarui properti

Properti yang diperluas ditetapkan pada resource Peristiwa, dan seperti kolom lainnya, dapat ditetapkan dalam permintaan insert, update, dan patch. Menggunakan permintaan patch adalah metode yang lebih disukai, karena memungkinkan Anda memanipulasi beberapa properti tanpa mengubah properti lainnya. Menambahkan properti baru dengan kunci yang sama akan menimpa properti yang ada dengan kunci yang sama. Contoh berikut menunjukkan setelan properti pribadi:

PATCH https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId

{
  "extendedProperties": {
    "private": {
      "petsAllowed": "yes"
    }
  }
}

Menghapus properti

Setiap properti yang tidak disertakan dalam permintaan pembaruan akan dihapus, tetapi pendekatan yang lebih baik adalah membuat permintaan patch untuk menetapkan nilai ke null. Contoh berikut menunjukkan penghapusan properti pribadi:

PATCH https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId

{
  "extendedProperties": {
    "private": {
      "petsAllowed": null
    }
  }
}

Properti Penelusuran

Anda dapat menelusuri peristiwa berdasarkan nilai pada properti yang diperluas menggunakan permintaan Events.list. Tetapkan kolom privateExtendedProperty atau sharedExtendedProperty ke batasan dalam format propertyName=value, yang masing-masing menelusuri properti pribadi dan bersama. Contoh berikut menampilkan peristiwa dengan properti pribadi petsAllowed=yes:

GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events
    ?privateExtendedProperty=petsAllowed%3Dyes

Anda dapat mengulangi kolom ini beberapa kali dan batasan digabungkan dengan OR, sehingga peristiwa hanya perlu cocok dengan salah satu batasan yang akan ditampilkan. Contoh berikut menemukan peristiwa dengan properti pribadi petsAllowed=yes atau isOutside=yes:

GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events
    ?privateExtendedProperty=petsAllowed%3Dyes
    &privateExtendedProperty=isOutside%3Dyes

Perhatikan bahwa batasan pada properti pribadi dan bersama digabungkan dengan AND, sehingga peristiwa harus cocok dengan kedua kumpulan batasan agar dapat ditampilkan. Contoh berikut menemukan peristiwa dengan properti pribadi petsAllowed=yes dan properti publik createdBy=myApp:

GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events
    ?privateExtendedProperty=petsAllowed%3Dyes
    &sharedExtendedProperty=createdBy%3DmyApp

Batas

1. Ukuran maksimum kunci properti adalah 44 karakter, dan properti dengan kunci yang lebih panjang akan dihapus secara otomatis.
2. Ukuran maksimum nilai properti adalah 1.024 karakter, dan properti dengan nilai yang lebih panjang akan dipotong secara otomatis.
3. Peristiwa dapat memiliki hingga 300 properti dengan total ukuran hingga 32 KB (ukuran kunci + ukuran nilai). 300 properti ini mencakup properti bersama dan pribadi, di semua "salinan" peristiwa.