REST Resource: indexing.datasources.items

Resource: Item

Mewakili objek tunggal yang merupakan item di indeks penelusuran, seperti file, folder, atau catatan database.

Representasi JSON
{
  "name": string,
  "acl": {
    object (ItemAcl)
  },
  "metadata": {
    object (ItemMetadata)
  },
  "structuredData": {
    object (ItemStructuredData)
  },
  "content": {
    object (ItemContent)
  },
  "version": string,
  "status": {
    object (ItemStatus)
  },
  "queue": string,
  "payload": string,
  "itemType": enum (Item.ItemType)
}
Kolom
name

string

Nama Item. Format: datasources/{sourceId}/items/{itemId}

Bidang ini harus diisi. Panjang maksimum adalah 1.536 karakter.

acl

object (ItemAcl)

Daftar kontrol akses untuk item ini.

metadata

object (ItemMetadata)

Informasi metadata.

structuredData

object (ItemStructuredData)

Data terstruktur untuk item yang harus sesuai dengan definisi objek terdaftar dalam skema untuk sumber data.

content

object (ItemContent)

Konten item yang akan diindeks dan membuat teks dapat ditelusuri.

version

string (bytes format)

Diperlukan. Sistem pengindeksan menyimpan versi dari sumber data sebagai string byte dan membandingkan versi Item dalam indeks dengan versi Item dalam antrean menggunakan pengurutan leksikal.

Pengindeksan Cloud Search tidak akan mengindeks atau menghapus item antrean dengan nilai versi yang kurang dari atau sama dengan versi item yang saat ini diindeks. Panjang maksimum untuk kolom ini adalah 1024 byte.

Untuk mengetahui informasi tentang pengaruh versi item terhadap proses penghapusan, lihat Menangani revisi setelah penghapusan manual.

String berenkode base64.

status

object (ItemStatus)

Status item. Kolom khusus output.

queue

string

Antrean untuk item ini. Panjang maksimum adalah 100 karakter.

payload

string (bytes format)

Konektor status tambahan dapat menyimpan item ini. Panjang maksimum adalah 10.000 byte.

String berenkode base64.

itemType

enum (Item.ItemType)

Jenis untuk item ini.

ItemItem

Informasi daftar kontrol akses untuk item. Untuk mengetahui informasi selengkapnya, lihat ACL Peta.

Representasi JSON
{
  "inheritAclFrom": string,
  "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
  "readers": [
    {
      object (Principal)
    }
  ],
  "deniedReaders": [
    {
      object (Principal)
    }
  ],
  "owners": [
    {
      object (Principal)
    }
  ]
}
Kolom
inheritAclFrom

string

Nama item yang diwarisi dari Daftar Izin Akses (ACL). Catatan: Pewarisan ACL hanya memberikan izin akses ke item turunan dan tidak menentukan hubungan struktural, juga tidak menyediakan cara yang mudah untuk menghapus kumpulan item yang besar. Menghapus induk ACL dari indeks hanya mengubah izin akses item turunan yang mereferensikan induk dalam kolom inheritAclFrom. Item tersebut masih ada dalam indeks, tetapi mungkin tidak terlihat dalam hasil penelusuran. Sebaliknya, penghapusan item penampung juga menghapus semua item yang mereferensikan penampung melalui kolom containerName. Panjang maksimum untuk kolom ini adalah 1536 karakter.

aclInheritanceType

enum (ItemAcl.AclInheritanceType)

Menetapkan jenis aturan akses yang akan diterapkan saat item mewarisi ACL-nya dari induk. Ini harus selalu ditetapkan bersama-sama dengan kolom inheritAclFrom. Selain itu, saat kolom inheritAclFrom ditetapkan, kolom ini harus ditetapkan ke AclInheritanceType yang valid.

readers[]

object (Principal)

Daftar akun utama yang diizinkan untuk melihat item dalam hasil penelusuran. Opsional jika mewarisi izin dari item lain atau jika item tidak dimaksudkan untuk terlihat, seperti virtual containers. Jumlah elemen maksimum adalah 1.000.

deniedReaders[]

object (Principal)

Daftar akun utama yang secara eksplisit menolak akses ke item dalam hasil penelusuran. Meskipun akun utama ditolak secara default, gunakan pembaca yang ditolak untuk menangani pengecualian dan mengganti daftar yang diizinkan oleh pembaca. Jumlah elemen maksimum adalah 100.

owners[]

object (Principal)

Opsional. Daftar pemilik untuk item. Kolom ini tidak ada hubungannya dengan izin akses dokumen. Namun, teknik ini menawarkan sedikit peringkat untuk meningkatkan item dengan pemilik kueri sebagai pemilik. Jumlah elemen maksimum adalah 5.

ItemAcl.AclInheritanceType

Jenis pewarisan ACL.

Enumerasi
NOT_APPLICABLE Nilai default saat item ini tidak mewarisi ACL. Gunakan NOT_APPLICABLE jika inheritAclFrom kosong. Item tanpa warisan 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 diberikan hanya 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 principal can be only one of the following:
  "gsuitePrincipal": {
    object (GSuitePrincipal)
  },
  "userResourceName": string,
  "groupResourceName": string
  // End of list of possible types for union field principal.
}
Kolom

Kolom union principal.

principal hanya dapat berupa salah satu dari berikut:

gsuitePrincipal

object (GSuitePrincipal)

Utama ini adalah pengguna, grup, atau domain Google Workspace.

userResourceName

string

Utama ini adalah pengguna yang diidentifikasi menggunakan identitas eksternal. Kolom nama harus menentukan nama resource pengguna dengan format ini: identitysources/{sourceId}/users/{ID}

groupResourceName

string

Utama ini adalah grup yang diidentifikasi menggunakan identitas eksternal. Kolom nama harus menentukan nama resource grup dengan format ini: identitysources/{sourceId}/groups/{ID}

Metadata Item

Kolom metadata yang tersedia untuk item.

Representasi JSON
{
  "title": string,
  "sourceRepositoryUrl": string,
  "containerName": string,
  "objectType": string,
  "createTime": string,
  "updateTime": string,
  "interactions": [
    {
      object (Interaction)
    }
  ],
  "contentLanguage": string,
  "mimeType": string,
  "searchQualityMetadata": {
    object (SearchQualityMetadata)
  },
  "keywords": [
    string
  ],
  "hash": string,
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}
Kolom
title

string

Judul item. Jika diberikan, ini akan menjadi judul yang ditampilkan dari hasil query.search. Panjang maksimum adalah 2.048 karakter.

sourceRepositoryUrl

string

Link ke repositori sumber yang menayangkan data. Hasil penelusuran menerapkan link ini ke judul. Karakter spasi kosong atau karakter khusus dapat menyebabkan link hasil Cloud Seach memicu notifikasi pengalihan. Untuk menghindari hal ini, enkode URL. Panjang maksimum adalah 2.048 karakter.

containerName

string

Nama penampung untuk item ini. Penghapusan item penampung menyebabkan penghapusan otomatis item ini. Catatan: ACL tidak diwarisi dari item container. Untuk menyediakan warisan ACL untuk suatu item, gunakan kolom inheritAclFrom. Panjang maksimum adalah 1.536 karakter.

objectType

string

Jenis item. 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

string (Timestamp format)

Waktu saat item dibuat di repositori sumber.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Waktu saat item terakhir diubah di repositori sumber.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

interactions[]

object (Interaction)

Daftar interaksi untuk item tersebut. Interaksi digunakan untuk meningkatkan kualitas kueri.penelusuran, tetapi tidak ditampilkan kepada pengguna akhir. Jumlah elemen maksimum adalah 1.000.

contentLanguage

string

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

string

Jenis mime asli ItemContent.content di repositori sumber. Panjang maksimum adalah 256 karakter.

searchQualityMetadata

object (SearchQualityMetadata)

Metadata kualitas penelusuran tambahan untuk item

keywords[]

string

Kata kunci atau frasa tambahan yang harus cocok dengan item tersebut. Digunakan secara internal untuk konten buatan pengguna. Jumlah elemen maksimum adalah 100. Panjang maksimum adalah 8192 karakter.

hash

string

Nilai hashing yang diberikan oleh pemanggil API. Ini dapat digunakan dengan metode items.push untuk menghitung status yang diubah. Panjang maksimum adalah 2.048 karakter.

contextAttributes[]

object (ContextAttribute)

Sekumpulan atribut bernama yang terkait dengan item. Ini dapat digunakan untuk memengaruhi peringkat item berdasarkan konteks dalam permintaan. Jumlah elemen maksimum adalah 10.

Interaksi

Mewakili interaksi antara pengguna dan item.

Representasi JSON
{
  "type": enum (Interaction.InteractionType),
  "principal": {
    object (Principal)
  },
  "interactionTime": string
}
Kolom
type

enum (Interaction.InteractionType)

principal

object (Principal)

Pengguna yang bertindak pada item.

interactionTime

string (Timestamp format)

Waktu ketika pengguna bertindak pada item. Jika ada beberapa tindakan dari jenis yang sama untuk satu pengguna, hanya tindakan terbaru yang dicatat.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

Interaction.InteractionType

Jenis aktivitas yang dilakukan pengguna pada item.

Enumerasi
UNSPECIFIED Nilai tidak valid.
VIEW Interaksi ini menunjukkan bahwa pengguna telah melihat item.
EDIT Interaksi ini menunjukkan bahwa pengguna telah mengedit item.

MetadataKualitas Penelusuran

Metadata kualitas penelusuran tambahan untuk item.

Representasi JSON
{
  "quality": number
}
Kolom
quality

number

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.

ContextAtribut

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

string

Nama atribut. Tidak boleh kosong. Panjang maksimum adalah 32 karakter. Nama harus diawali dengan huruf dan hanya boleh berisi huruf (A-Z, a-z) atau angka (0-9). Nama akan dinormalkan (huruf kecil) sebelum dicocokkan.

values[]

string

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 (StructuredDataObject)
  },
  "hash": string
}
Kolom
object

object (StructuredDataObject)

Objek data terstruktur yang harus sesuai dengan definisi objek terdaftar dalam skema untuk sumber data.

hash

string

Nilai hashing yang diberikan oleh pemanggil API. Ini dapat digunakan dengan metode items.push untuk menghitung status yang diubah. Panjang maksimum adalah 2.048 karakter.

ObjekData Terstruktur

Objek data terstruktur yang terdiri dari properti bernama.

Representasi JSON
{
  "properties": [
    {
      object (NamedProperty)
    }
  ]
}
Kolom
properties[]

object (NamedProperty)

Properti untuk objek. Jumlah elemen maksimum adalah 1.000.

Properti Bernama

Pasangan nama-nilai yang diketik untuk data terstruktur. Jenis nilai harus sama dengan jenis terdaftar untuk properti name dalam definisi objek objectType.

Representasi JSON
{
  "name": string,

  // Union field value can be only one of the following:
  "integerValues": {
    object (NamedProperty.IntegerValues)
  },
  "doubleValues": {
    object (NamedProperty.DoubleValues)
  },
  "timestampValues": {
    object (NamedProperty.TimestampValues)
  },
  "booleanValue": boolean,
  "objectValues": {
    object (NamedProperty.ObjectValues)
  },
  "enumValues": {
    object (NamedProperty.EnumValues)
  },
  "dateValues": {
    object (NamedProperty.DateValues)
  },
  "textValues": {
    object (NamedProperty.TextValues)
  },
  "htmlValues": {
    object (NamedProperty.HtmlValues)
  }
  // End of list of possible types for union field value.
}
Kolom
name

string

Nama properti. Nama ini harus sesuai dengan nama properti yang terdaftar untuk definisi objek dalam skema. Panjang maksimum yang diizinkan untuk properti ini adalah 256 karakter.

Kolom union value. Nilai properti yang diberi nama. Perhatikan bahwa properti hanya dapat menyimpan nilai dari satu jenis. value hanya dapat berupa salah satu dari berikut:
integerValues

object (NamedProperty.IntegerValues)

doubleValues

object (NamedProperty.DoubleValues)

timestampValues

object (NamedProperty.TimestampValues)

booleanValue

boolean

objectValues

object (NamedProperty.ObjectValues)

enumValues

object (NamedProperty.EnumValues)

dateValues

object (NamedProperty.DateValues)

textValues

object (NamedProperty.TextValues)

htmlValues

object (NamedProperty.HtmlValues)

NamedProperty.IntegerValues

Daftar nilai bilangan bulat.

Representasi JSON
{
  "values": [
    string
  ]
}
Kolom
values[]

string (int64 format)

PropertiBernama.DoubleValues

Daftar nilai ganda.

Representasi JSON
{
  "values": [
    number
  ]
}
Kolom
values[]

number

NamedProperty.TimestampValues

Daftar nilai stempel waktu.

Representasi JSON
{
  "values": [
    string
  ]
}
Kolom
values[]

string (Timestamp format)

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

NamedProperty.ObjectValues

Daftar nilai objek.

Representasi JSON
{
  "values": [
    {
      object (StructuredDataObject)
    }
  ]
}
Kolom
values[]

object (StructuredDataObject)

NamedProperty.EnumValues

Daftar nilai enum.

Representasi JSON
{
  "values": [
    string
  ]
}
Kolom
values[]

string

Panjang maksimum yang diizinkan untuk nilai string adalah 32 karakter.

NamedProperty.DateValues

Daftar nilai tanggal.

Representasi JSON
{
  "values": [
    {
      object (Date)
    }
  ]
}
Kolom
values[]

object (Date)

NamedProperty.TextValues

Daftar nilai teks.

Representasi JSON
{
  "values": [
    string
  ]
}
Kolom
values[]

string

Panjang maksimum yang diizinkan untuk nilai teks adalah 2048 karakter.

NamedProperty.HtmlValues

Daftar nilai html.

Representasi JSON
{
  "values": [
    string
  ]
}
Kolom
values[]

string

Panjang maksimum yang diizinkan untuk nilai html adalah 2048 karakter.

KontenItem

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 tersebut harus berenkode UTF-8.

Representasi JSON
{
  "contentFormat": enum (ItemContent.ContentFormat),
  "hash": string,

  // Union field content can be only one of the following:
  "inlineContent": string,
  "contentDataRef": {
    object (UploadItemRef)
  }
  // End of list of possible types for union field content.
}
Kolom
contentFormat

enum (ItemContent.ContentFormat)

hash

string

Info hashing dihitung dan diberikan oleh klien API untuk konten. Dapat digunakan dengan metode items.push untuk menghitung status yang dimodifikasi. Panjang maksimum adalah 2.048 karakter.

Kolom union content.

content hanya dapat berupa salah satu dari berikut:

inlineContent

string (bytes format)

Konten yang disediakan inline dalam metode update. Panjang maksimum adalah 102.400 byte (100 KiB).

String berenkode base64.

contentDataRef

object (UploadItemRef)

Upload ID referensi konten yang diupload sebelumnya melalui metode penulisan.

ItemContent.ContentFormat

Format konten. Jika formatnya RAW, konten harus dalam format yang ditentukan oleh mimeType.

Enumerasi
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

string

Nama referensi konten. Panjang maksimum adalah 2.048 karakter.

StatusItem

File ini berisi status item dan semua error.

Representasi JSON
{
  "code": enum (ItemStatus.Code),
  "processingErrors": [
    {
      object (ProcessingError)
    }
  ],
  "repositoryErrors": [
    {
      object (RepositoryError)
    }
  ]
}
Kolom
code

enum (ItemStatus.Code)

Kode status.

processingErrors[]

object (ProcessingError)

Detail error jika item dalam status ERROR.

repositoryErrors[]

object (RepositoryError)

Error repositori yang dilaporkan oleh konektor.

Kesalahan Pemrosesan

Representasi JSON
{
  "code": enum (ProcessingErrorCode),
  "errorMessage": string,
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}
Kolom
code

enum (ProcessingErrorCode)

Kode error yang menunjukkan sifat error.

errorMessage

string

Deskripsi error.

fieldViolations[]

object (FieldViolation)

Jika kolom item tidak valid, kolom ini akan berisi detail tentang error validasi.

Kode Pemrosesan Sedang Diproses

Kode untuk menunjukkan error yang dialami selama pemrosesan item oleh server Cloud Search. Satu item mungkin berisi beberapa error pemrosesan.

Enumerasi
PROCESSING_ERROR_CODE_UNSPECIFIED Nilai masukan saja. Gunakan nilai ini di Item.
MALFORMED_REQUEST ACL, metadata, atau konten item dalam format yang salah atau tidak valid. FieldViolations berisi detail lebih lanjut mengenai lokasi masalah.
UNSUPPORTED_CONTENT_FORMAT Format hitungan 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.

Pelanggaran Lapangan

Representasi JSON
{
  "field": string,
  "description": string
}
Kolom
field

string

Jalur kolom dengan pelanggaran.

description

string

Deskripsi error.

Error Repositori

Error saat konektor berkomunikasi ke repositori sumber.

Representasi JSON
{
  "type": enum (RepositoryError.Type),
  "httpStatusCode": integer,
  "errorMessage": string
}
Kolom
type

enum (RepositoryError.Type)

Jenis error.

httpStatusCode

integer

Kode error. Sesuai dengan definisi kode status HTTP.

errorMessage

string

Pesan yang menjelaskan error. Panjang maksimum yang diizinkan untuk pesan adalah 8192 karakter.

RepositoryError.Type

Daftar kode error untuk masalah komunikasi dengan repositori.

Enumerasi
UNKNOWN Error tidak diketahui.
NETWORK_ERROR Host tidak diketahui atau tidak dapat dijangkau.
DNS_ERROR Masalah DNS, seperti 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 sementara tidak tersedia.
CLIENT_ERROR Error terkait klien, seperti permintaan yang tidak valid dari konektor ke server repositori.

Item.JenisJenis

Enumerasi
UNSPECIFIED
CONTENT_ITEM Item yang diindeks hanya untuk menyajikan informasi. Item ini tidak dapat dirujuk di kolom containerName atau inheritAclFrom.
CONTAINER_ITEM Item yang diindeks dan tujuannya untuk 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

delete

Menghapus Item resource untuk nama resource yang ditentukan.

deleteQueueItems

Menghapus semua item dalam antrean.

get

Mendapatkan Item resource berdasarkan nama item.

index

Mengupdate ACL, metadata, dan konten Item.

list

Mencantumkan semua atau subkumpulan Item resources.

poll

Polling untuk item yang tidak dipesan dari antrean pengindeksan dan menandai kumpulan sebagai dipesan, dimulai dengan item yang memiliki stempel waktu terlama dari prioritas tertinggi ItemStatus.

push

Mengirim item ke antrean untuk polling dan pembaruan berikutnya.

unreserve

Memesan semua item dari antrean, sehingga semuanya memenuhi syarat untuk disurvei.

upload

Membuat sesi upload untuk mengupload konten item.