Dokumen ini menyediakan dokumentasi referensi mendetail untuk protokol mentah (XML dan HTTP) untuk Google Sites Data API.
Dokumen ini tidak berisi informasi tentang library klien bahasa pemrograman. Untuk informasi referensi library klien, lihat link dari bagian khusus bahasa pemrograman di panduan developer.
Audiens
Dokumen ini ditujukan bagi programmer yang ingin menulis aplikasi klien yang dapat berinteraksi dengan Google Sites.
Ini adalah dokumen referensi; Anda diasumsikan bahwa Anda memahami konsep yang dijelaskan dalam panduan protokol, dan ide umum di balik protokol Google Data API.
Jenis feed Google Sites
Google Sites Data API menyediakan jenis feed berikut:
Feed aktivitas
Feed Aktivitas adalah feed yang berisi deskripsi semua aktivitas dalam situs.
URI GET feed ini untuk situs dalam domain tertentu adalah:
https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]
domainName dapat berupa "situs", atau domain G Suite.
siteName adalah nama situs seperti yang muncul di URL halaman landing situs: http://sites.google.com/a/domainName/siteName/.
Semua permintaan ke feed ini harus diautentikasi.
Jenis permintaan yang didukung: GET
Feed konten
Feed konten adalah feed yang berisi konten situs saat ini yang dapat diedit.
URI GET feed ini untuk situs dalam domain tertentu adalah:
https://sites.google.com/feeds/content/domainName/siteName/[contentEntryID]
domainName dapat berupa "situs", atau domain G Suite.
siteName adalah nama situs seperti yang muncul di URL halaman landing situs: http://sites.google.com/a/domainName/siteName.
Permintaan ke feed ini mungkin memerlukan autentikasi atau tidak, bergantung pada setelan Situs (dipublikasikan).
Jenis permintaan yang didukung: GET, POST, PUT, DELETE
Selain parameter kueri Data API standar, Sites Data API memungkinkan parameter opsional berikut
mengajukan permintaan GET menggunakan feed Konten:
| Parameter | Deskripsi | Jenis | Catatan |
|---|---|---|---|
ancestor |
Hanya meminta entri yang memiliki ancestor yang ditentukan. | string | Berikan ID entri ancestor yang diinginkan. Misalnya: 0123456789. Menampilkan semua entri yang memiliki ancestor yang ditentukan sebagai induk, induk induk, dan sebagainya. |
include-deleted |
Menentukan apakah akan menyertakan entri yang dihapus. | boolean | Nilai yang mungkin adalah true atau false. Jumlah defaultnya adalah false |
include-draft |
Menentukan apakah akan menyertakan entri draf. | boolean | Nilai yang mungkin adalah true atau false. Jumlah defaultnya adalah false Anda harus menjadi pemilik atau penulis
draf untuk melihatnya. |
kind |
Menentukan jenis entri konten yang akan ditampilkan. Ini mengikuti jenis halaman dalam Google Sites. | daftar string yang dipisahkan koma | Nilai yang mungkin adalah announcement, announcementspage, attachment,
comment, filecabinet, listitem, listpage, webpage, webattachment,
template. |
parent |
Hanya meminta entri yang memiliki induk yang ditentukan. | string | Berikan ID entri induk. Misalnya: 0123456789. |
path |
Meminta konten dalam hierarki halaman tertentu | string | Jalur ke subhalaman dalam Situs untuk mengambil kontennya. Misalnya: path=/path/to/page. |
Feed revisi
Feed revisi adalah feed yang berisi revisi historis konten situs.
URI GET feed ini untuk situs dalam domain tertentu adalah:
https://sites.google.com/feeds/revision/domainName/siteName/contentEntryID/[revisionEntryID]
domainName dapat berupa "situs", atau domain G Suite.
siteName adalah nama situs seperti yang muncul di URL halaman landing situs: http://sites.google.com/a/domainName/siteName.
Semua permintaan ke feed ini harus diautentikasi.
Jenis permintaan yang didukung: GET
Feed situs
Feed situs dapat digunakan untuk mencantumkan Google Sites yang dimiliki pengguna atau yang izin lihatnya dimiliki pengguna. Bisa juga digunakan untuk membuat situs baru, menyalin situs, atau mengubah nama situs yang ada.
URI feed untuk listingan Sites adalah:
https://sites.google.com/feeds/site/domainName/[siteName]
domainName dapat berupa "situs", atau domain G Suite.
Semua permintaan ke feed ini harus diautentikasi.
Jenis permintaan yang didukung: GET, POST, PUT
Feed situs mendukung parameter (opsional) berikut saat mengajukan permintaan GET untuk situs listingan:
| Parameter | Deskripsi | Jenis | Catatan |
|---|---|---|---|
include-all-sites |
Cantumkan semua situs yang setidaknya dapat dilihat oleh pengguna di domain G Suite. | boolean | Parameter ini hanya berlaku saat mencantumkan situs untuk domain G Suite. Kemungkinan nilainya adalah true
atau false. Jumlah defaultnya adalah false |
with-mappings |
Mencakup pemetaan alamat web dalam entri situs. | boolean | Nilai yang mungkin adalah true atau false. Jumlah defaultnya adalah false |
Feed ACL
Feed ACL dapat digunakan untuk mencantumkan dan/atau mengubah izin berbagi (ACL) Situs Google.
URI feed untuk listingan Sites adalah:
https://sites.google.com/feeds/acl/site/domainName/siteName/[aclEntryID]
domainName dapat berupa "situs", atau domain G Suite.
Semua permintaan ke feed ini harus diautentikasi.
Jenis permintaan yang didukung: GET, POST, PUT, DELETE
Referensi parameter kueri Google Sites
Parameter kueri yang didukung dari protokol Google Data API:
max-resultspublished-max(hanya feed konten)published-min(hanya feed konten)start-indexupdated-maxupdated-minq(kueri teks lengkap)
Lihat setiap feed di atas untuk mengetahui daftar parameter khusus feed tersebut.