- Referensi: Item
- ItemAcl
- ItemAcl.AclInheritanceType
- Kepala sekolah
- ItemMetadata
- Interaksi
- Interaction.InteractionType
- SearchQualityMetadata
- ContextAttribute
- ItemStructuredData
- StructuredDataObject
- NamedProperty
- NamedProperty.IntegerValues
- NamedProperty.DoubleValues
- NamedProperty.TimestampValues
- NamedProperty.ObjectValues
- NamedProperty.EnumValues
- NamedProperty.DateValues
- NamedProperty.TextValues
- NamedProperty.HtmlValues
- ItemContent
- ItemContent.ContentFormat
- UploadItemRef
- ItemStatus
- ProcessingError
- ProcessingErrorCode
- FieldViolation
- RepositoryError
- RepositoryError.Type
- Item.ItemType
- Metode
Resource: Item
Mewakili satu objek yang merupakan item dalam indeks penelusuran, seperti file, folder, atau catatan database.
Representasi JSON |
---|
{ "name": string, "acl": { object ( |
Kolom | |
---|---|
name |
Nama item. Format: datasources/{sourceId}/items/{itemId} Bidang ini harus diisi. Panjang maksimum adalah 1.536 karakter. |
acl |
Daftar kontrol akses untuk item ini. |
metadata |
Informasi metadata. |
structuredData |
Data terstruktur untuk item yang harus sesuai dengan definisi objek terdaftar dalam skema untuk sumber data. |
content |
Konten item yang akan diindeks dan teksnya dapat ditelusuri. |
version |
Wajib diisi. Sistem pengindeksan menyimpan versi dari sumber data sebagai string byte dan membandingkan versi Item dalam indeks dengan versi Item dalam antrean menggunakan pengurutan leksikal. Cloud Search Indexing tidak akan mengindeks atau menghapus item dalam antrean dengan nilai versi yang kurang dari atau sama dengan versi item yang saat ini diindeks. Panjang maksimum kolom ini adalah 1.024 byte. Untuk informasi tentang pengaruh versi item terhadap proses penghapusan, lihat Menangani revisi setelah penghapusan manual. String berenkode base64. |
status |
Status item. Kolom hanya output. |
queue |
Antrean untuk item ini. Panjang maksimum adalah 100 karakter. |
payload |
Konektor status tambahan dapat disimpan untuk item ini. Panjang maksimum adalah 10.000 byte. String berenkode base64. |
itemType |
Jenis untuk item ini. |
ItemAcl
Informasi daftar kontrol akses untuk item. Untuk informasi selengkapnya, lihat ACL Peta.
Representasi JSON |
---|
{ "inheritAclFrom": string, "aclInheritanceType": enum ( |
Kolom | |
---|---|
inheritAclFrom |
Nama item yang akan mewarisi Daftar Izin Akses (ACL). Catatan: Pewarisan ACL hanya memberikan izin akses ke item turunan dan tidak menentukan hubungan struktural, juga tidak memberikan cara mudah untuk menghapus kelompok item dalam jumlah besar. Menghapus induk ACL dari indeks hanya akan mengubah izin akses item turunan yang mereferensikan induk di kolom |
aclInheritanceType |
Menetapkan jenis aturan akses yang akan diterapkan saat item mewarisi ACL-nya dari induk. Kolom ini harus selalu ditetapkan bersama dengan kolom |
readers[] |
Daftar akun utama yang diizinkan untuk melihat item di hasil penelusuran. Opsional jika mewarisi izin dari item lain atau jika item tidak dimaksudkan untuk terlihat, seperti |
deniedReaders[] |
Daftar akun utama yang secara eksplisit ditolak aksesnya ke item di hasil penelusuran. Meskipun akun utama tidak diberi akses secara default, gunakan pembaca yang ditolak untuk menangani pengecualian dan mengganti daftar yang diizinkan pembaca. Jumlah elemen maksimum adalah 100. |
owners[] |
Opsional. Daftar pemilik item. Kolom ini tidak berpengaruh pada izin akses dokumen. Namun, hal ini menawarkan sedikit menaikkan peringkat item di mana pengguna yang mengajukan kueri adalah pemilik. Jumlah elemen maksimum adalah 5. |
ItemAcl.AclInheritanceType
Jenis pewarisan ACL.
Enum | |
---|---|
NOT_APPLICABLE |
Nilai default saat item ini tidak mewarisi ACL. Gunakan NOT_APPLICABLE saat inheritAclFrom kosong. Item tanpa pewarisan ACL masih dapat memiliki ACL yang disediakan oleh kolom readers dan deniedReaders -nya sendiri. |
CHILD_OVERRIDE |
Selama konflik otorisasi, ACL item turunan menentukan akses bacanya. |
PARENT_OVERRIDE |
Selama konflik otorisasi, ACL item induk yang ditentukan di kolom inheritAclFrom menentukan akses baca. |
BOTH_PERMIT |
Akses hanya diberikan jika item ini dan item induk yang ditentukan di kolom inheritAclFrom mengizinkan akses baca. |
Akun utama
Referensi ke pengguna, grup, atau domain.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union
|
|
gsuitePrincipal |
Akun utama ini adalah pengguna, grup, atau domain Google Workspace. |
userResourceName |
Akun utama ini adalah pengguna yang diidentifikasi menggunakan identitas eksternal. Kolom nama harus menentukan nama resource pengguna dengan format ini: identitysources/{sourceId}/users/{ID} |
groupResourceName |
Akun utama ini adalah grup yang diidentifikasi menggunakan identitas eksternal. Kolom nama harus menentukan nama resource grup dengan format ini: identitysources/{sourceId}/groups/{ID} |
ItemMetadata
Kolom metadata yang tersedia untuk item.
Representasi JSON |
---|
{ "title": string, "sourceRepositoryUrl": string, "containerName": string, "objectType": string, "createTime": string, "updateTime": string, "interactions": [ { object ( |
Kolom | |
---|---|
title |
Judul item. Jika diberikan, kolom ini akan menjadi judul yang ditampilkan dari hasil query.search. Panjang maksimum adalah 2.048 karakter. |
sourceRepositoryUrl |
Link ke repositori sumber yang menayangkan data. Hasil penelusuran menerapkan link ini ke judul. Spasi kosong atau karakter khusus dapat menyebabkan link hasil Cloud Seach memicu pemberitahuan pengalihan; Untuk menghindarinya, enkode URL tersebut. Panjang maksimum adalah 2.048 karakter. |
containerName |
Nama penampung untuk item ini. Penghapusan item penampung akan menyebabkan penghapusan otomatis item ini. Catatan: ACL tidak diwarisi dari item container. Untuk memberikan pewarisan ACL untuk item, gunakan kolom |
objectType |
Jenis item. Nama ini harus sesuai dengan nama definisi objek dalam skema yang terdaftar untuk sumber data. Misalnya, jika skema untuk sumber data berisi definisi objek dengan nama 'document', permintaan pengindeksan item untuk objek dari jenis tersebut harus menetapkan objectType ke 'document'. Panjang maksimum adalah 256 karakter. |
createTime |
Waktu saat item dibuat di repositori sumber. Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: |
updateTime |
Waktu saat item terakhir diubah di repositori sumber. Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: |
interactions[] |
Daftar interaksi untuk item. Interaksi digunakan untuk meningkatkan kualitas query.search, tetapi tidak ditampilkan kepada pengguna akhir. Jumlah elemen maksimum adalah 1.000. |
contentLanguage |
Kode bahasa BCP-47 untuk item, seperti "en-US" atau "sr-Latn". Untuk informasi selengkapnya, lihat http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Panjang maksimum adalah 32 karakter. |
mimeType |
Jenis mime asli |
searchQualityMetadata |
Metadata kualitas penelusuran tambahan untuk item |
keywords[] |
Kata kunci atau frasa tambahan yang harus cocok dengan item. Digunakan secara internal untuk konten buatan pengguna. Jumlah elemen maksimum adalah 100. Panjang maksimum adalah 8.192 karakter. |
hash |
Nilai hashing yang diberikan oleh pemanggil API. Ini dapat digunakan dengan metode |
contextAttributes[] |
Sekumpulan atribut bernama yang terkait dengan item. Hal ini dapat digunakan untuk memengaruhi peringkat item berdasarkan konteks dalam permintaan. Jumlah elemen maksimum adalah 10. |
Interaksi
Menampilkan interaksi antara pengguna dan item.
Representasi JSON |
---|
{ "type": enum ( |
Kolom | |
---|---|
type |
|
principal |
Pengguna yang menindaklanjuti item. |
interactionTime |
Waktu saat pengguna menindaklanjuti item. Jika ada beberapa tindakan dari jenis yang sama untuk satu pengguna, hanya tindakan terbaru yang akan dicatat. Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: |
Interaction.InteractionType
Jenis aktivitas yang dilakukan pengguna pada item.
Enum | |
---|---|
UNSPECIFIED |
Nilai tidak valid. |
VIEW |
Interaksi ini menunjukkan bahwa pengguna melihat item. |
EDIT |
Interaksi ini menunjukkan bahwa pengguna mengedit item. |
SearchQualityMetadata
Metadata kualitas penelusuran tambahan untuk item.
Representasi JSON |
---|
{ "quality": number } |
Kolom | |
---|---|
quality |
Indikasi kualitas item, yang digunakan untuk memengaruhi kualitas penelusuran. nilai harus antara 0,0 (kualitas terendah) dan 1,0 (kualitas tertinggi). Nilai defaultnya adalah 0.0. |
ContextAttribute
Atribut bernama yang terkait dengan item yang dapat digunakan untuk memengaruhi peringkat item berdasarkan konteks dalam permintaan.
Representasi JSON |
---|
{ "name": string, "values": [ string ] } |
Kolom | |
---|---|
name |
Nama atribut. Wajib diisi. Panjang maksimum adalah 32 karakter. Nama harus diawali dengan huruf dan hanya berisi huruf (A-Z, a-z) atau angka (0-9). Nama akan dinormalkan (huruf kecil) sebelum dicocokkan. |
values[] |
Nilai teks atribut. Jumlah elemen maksimum adalah 10. Panjang maksimum elemen dalam array adalah 32 karakter. Nilai akan dinormalkan (huruf kecil) sebelum dicocokkan. |
ItemStructuredData
Kolom data terstruktur yang tersedia untuk item.
Representasi JSON |
---|
{
"object": {
object ( |
Kolom | |
---|---|
object |
Objek data terstruktur yang harus sesuai dengan definisi objek terdaftar dalam skema untuk sumber data. |
hash |
Nilai hashing yang diberikan oleh pemanggil API. Ini dapat digunakan dengan metode |
StructuredDataObject
Objek data terstruktur yang terdiri dari properti bernama.
Representasi JSON |
---|
{
"properties": [
{
object ( |
Kolom | |
---|---|
properties[] |
Properti untuk objek. Jumlah elemen maksimum adalah 1.000. |
NamedProperty
Pasangan nama-nilai yang diketik untuk data terstruktur. Jenis nilai harus sama dengan jenis yang terdaftar untuk properti name
dalam definisi objek objectType
.
Representasi JSON |
---|
{ "name": string, // Union field |
Kolom | |
---|---|
name |
Nama properti. Nama ini harus sesuai dengan nama properti yang didaftarkan untuk definisi objek dalam skema. Panjang maksimum yang diizinkan untuk properti ini adalah 256 karakter. |
Kolom union value . Nilai properti bernama. Perhatikan bahwa properti hanya dapat memiliki nilai dari satu jenis. value hanya dapat berupa salah satu dari berikut: |
|
integerValues |
|
doubleValues |
|
timestampValues |
|
booleanValue |
|
objectValues |
|
enumValues |
|
dateValues |
|
textValues |
|
htmlValues |
|
NamedProperty.IntegerValues
Daftar nilai bilangan bulat.
Representasi JSON |
---|
{ "values": [ string ] } |
Kolom | |
---|---|
values[] |
|
NamedProperty.DoubleValues
Daftar nilai ganda.
Representasi JSON |
---|
{ "values": [ number ] } |
Kolom | |
---|---|
values[] |
|
NamedProperty.TimestampValues
Daftar nilai stempel waktu.
Representasi JSON |
---|
{ "values": [ string ] } |
Kolom | |
---|---|
values[] |
Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: |
NamedProperty.ObjectValues
Daftar nilai objek.
Representasi JSON |
---|
{
"values": [
{
object ( |
Kolom | |
---|---|
values[] |
|
NamedProperty.EnumValues
Daftar nilai enum.
Representasi JSON |
---|
{ "values": [ string ] } |
Kolom | |
---|---|
values[] |
Panjang maksimum yang diizinkan untuk nilai string adalah 32 karakter. |
NamedProperty.DateValues
Daftar nilai tanggal.
Representasi JSON |
---|
{
"values": [
{
object ( |
Kolom | |
---|---|
values[] |
|
NamedProperty.TextValues
Daftar nilai teks.
Representasi JSON |
---|
{ "values": [ string ] } |
Kolom | |
---|---|
values[] |
Panjang maksimum yang diizinkan untuk nilai teks adalah 2.048 karakter. |
NamedProperty.HtmlValues
Daftar nilai HTML.
Representasi JSON |
---|
{ "values": [ string ] } |
Kolom | |
---|---|
values[] |
Panjang maksimum yang diizinkan untuk nilai HTML adalah 2.048 karakter. |
ItemContent
Konten item yang akan diindeks dan ditampilkan oleh Cloud Search. Hanya string berenkode UTF-8 yang diizinkan sebagai inlineContent
. Jika konten diupload dan bukan biner, konten harus berenkode UTF-8.
Representasi JSON |
---|
{ "contentFormat": enum ( |
Kolom | |
---|---|
contentFormat |
|
hash |
Info hashing yang dihitung dan diberikan oleh klien API untuk konten. Dapat digunakan dengan metode items.push untuk menghitung status yang diubah. Panjang maksimum adalah 2.048 karakter. |
Kolom union
|
|
inlineContent |
Konten yang disediakan sebagai inline dalam metode update. Panjang maksimum adalah 102.400 byte (100 KiB). String berenkode base64. |
contentDataRef |
Upload ID referensi konten yang diupload sebelumnya melalui metode tulis. |
ItemContent.ContentFormat
Format konten. Jika formatnya RAW, konten harus dalam format yang ditentukan oleh mimeType
.
Enum | |
---|---|
UNSPECIFIED |
Nilai tidak valid. |
HTML |
contentFormat adalah HTML. |
TEXT |
contentFormat adalah teks bebas. |
RAW |
contentFormat adalah byte mentah. |
UploadItemRef
Merepresentasikan referensi sesi upload. Referensi ini dibuat melalui upload method
. Referensi ini berlaku selama 30 hari setelah dibuat. Pembaruan konten item dapat merujuk pada konten yang diupload ini melalui contentDataRef
.
Representasi JSON |
---|
{ "name": string } |
Kolom | |
---|---|
name |
Nama referensi konten. Panjang maksimum adalah 2.048 karakter. |
ItemStatus
Ini berisi status item dan error.
Representasi JSON |
---|
{ "code": enum ( |
Kolom | |
---|---|
code |
Kode status. |
processingErrors[] |
Detail error jika item dalam status ERROR. |
repositoryErrors[] |
Error repositori dilaporkan oleh konektor. |
ProcessingError
Representasi JSON |
---|
{ "code": enum ( |
Kolom | |
---|---|
code |
Kode error yang menunjukkan sifat error. |
errorMessage |
Deskripsi error. |
fieldViolations[] |
Jika kolom item tidak valid, kolom ini berisi detail tentang error validasi. |
ProcessingErrorCode
Kode untuk menunjukkan error yang dialami selama pemrosesan item oleh server Cloud Search. Satu item dapat berisi beberapa error pemrosesan.
Enum | |
---|---|
PROCESSING_ERROR_CODE_UNSPECIFIED |
Nilai saja. Gunakan nilai ini dalam Items. |
MALFORMED_REQUEST |
ACL, metadata, atau konten item salah format atau tidak valid. Pelanggaran Kolom berisi detail selengkapnya tentang lokasi masalah. |
UNSUPPORTED_CONTENT_FORMAT |
Format jumlah tidak didukung. |
INDIRECT_BROKEN_ACL |
Item dengan informasi ACL yang tidak lengkap karena mewarisi item lain dengan ACL yang rusak atau memiliki grup dengan turunan yang tidak dipetakan. |
ACL_CYCLE |
Grafik pewarisan ACL membentuk siklus. |
FieldViolation
Representasi JSON |
---|
{ "field": string, "description": string } |
Kolom | |
---|---|
field |
Jalur kolom dengan pelanggaran. |
description |
Deskripsi error. |
RepositoryError
Error saat konektor berkomunikasi dengan repositori sumber.
Representasi JSON |
---|
{
"type": enum ( |
Kolom | |
---|---|
type |
Jenis error. |
httpStatusCode |
Kode error. Cocok dengan definisi kode status HTTP. |
errorMessage |
Pesan yang menjelaskan error. Panjang pesan maksimum yang diizinkan adalah 8.192 karakter. |
RepositoryError.Type
Daftar kode error untuk masalah komunikasi dengan repositori.
Enum | |
---|---|
UNKNOWN |
Error tidak diketahui. |
NETWORK_ERROR |
Host tidak dikenal atau tidak dapat dijangkau. |
DNS_ERROR |
Masalah DNS, misalnya server DNS tidak merespons. |
CONNECTION_ERROR |
Tidak dapat terhubung ke server repositori. |
AUTHENTICATION_ERROR |
Autentikasi gagal karena kredensial salah. |
AUTHORIZATION_ERROR |
Akun layanan tidak diizinkan untuk repositori. |
SERVER_ERROR |
Error server repositori. |
QUOTA_EXCEEDED |
Kuota terlampaui. |
SERVICE_UNAVAILABLE |
Server tidak tersedia untuk sementara. |
CLIENT_ERROR |
Error terkait klien, seperti permintaan tidak valid dari konektor ke server repositori. |
Item.ItemType
Enum | |
---|---|
UNSPECIFIED |
|
CONTENT_ITEM |
Item yang diindeks hanya untuk menyajikan informasi. Item ini tidak dapat dirujuk dalam kolom containerName atau inheritAclFrom . |
CONTAINER_ITEM |
Item yang diindeks dan tujuannya adalah menyediakan item lain dengan ACL dan/atau berisi item lain. |
VIRTUAL_CONTAINER_ITEM |
Item yang tidak diindeks, tetapi memiliki tujuan yang sama seperti CONTAINER_ITEM. |
Metode |
|
---|---|
|
Menghapus Item resource untuk nama resource yang ditentukan. |
|
Menghapus semua item dalam antrean. |
|
Mendapatkan Item resource berdasarkan nama item. |
|
Memperbarui ACL Item , metadata, dan konten. |
|
Mencantumkan semua atau subset dari Item resources . |
|
Melakukan polling untuk item yang belum direservasi dari antrean pengindeksan dan menandai set sebagai dicadangkan, dimulai dari item yang memiliki stempel waktu terlama dari prioritas tertinggi ItemStatus . |
|
Mendorong item ke antrean untuk polling dan update berikutnya. |
|
Membatalkan reservasi semua item dari antrean, sehingga semua item memenuhi syarat untuk diseleksi. |
|
Membuat sesi upload untuk mengupload konten item. |