- Resource: Öğe
- ItemAcl
- ItemAcl.AclInheritanceType
- Müdür
- ItemMetadata
- Etkileşim
- 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
- Yöntemler
Kaynak: Öğe
Arama dizinindeki dosya, klasör veya veritabanı kaydı gibi bir öğe olan tek bir nesneyi temsil eder.
JSON gösterimi |
---|
{ "name": string, "acl": { object ( |
Alanlar | |
---|---|
name |
Öğenin adı. Biçim: datasources/{sourceId}/items/{itemId} Bu alanının doldurulması zorunludur. En çok 1536 karakter kullanılabilir. |
acl |
Bu öğe için erişim kontrol listesi. |
metadata |
Meta veri bilgileri. |
structuredData |
Veri kaynağının şemasında kayıtlı nesne tanımına uyması gereken öğenin yapılandırılmış verileri. |
content |
Dizine eklenecek ve metin aranabilir hale getirilecek öğe içeriği. |
version |
Zorunlu. Dizine ekleme sistemi, veri kaynağındaki sürümü bir bayt dizesi olarak depolar ve dizindeki Öğe sürümünü, sözlükteki sıralamayı kullanarak sıraya alınan Öğenin sürümüyle karşılaştırır. Cloud Search Dizine Ekleme, sıraya alınmış ve hâlihazırda dizine eklenmiş öğenin sürümünden daha düşük veya bu sürüme eşit olan bir sürüm değerine sahip öğeleri dizine eklemez ya da silmez. Bu alan için maksimum uzunluk 1.024 bayttır. Öğe sürümünün silme işlemini nasıl etkilediği hakkında bilgi edinmek için Manuel silme işleminden sonra düzeltmeleri işleme başlıklı makaleyi inceleyin. base64 kodlu bir dize. |
status |
Öğenin durumu. Yalnızca çıkış alanı. |
queue |
Bu öğenin ait olduğu sıraya ekleyin. En çok 100 karakter kullanılabilir. |
payload |
Bu öğe için ek durum bağlayıcısı depolayabilir. Maksimum uzunluk 10.000 bayttır. base64 kodlu bir dize. |
itemType |
Bu öğenin türü. |
ItemAcl
Öğenin erişim kontrol listesi bilgileri. Daha fazla bilgi için Eşleme EKL'lerini inceleyin.
JSON gösterimi |
---|
{ "inheritAclFrom": string, "aclInheritanceType": enum ( |
Alanlar | |
---|---|
inheritAclFrom |
Erişim İzni Listesi'ni (EKL) devralacak öğenin adı. Not: EKL devralma yalnızca alt öğelere erişim izinleri sağlar ve yapısal ilişkileri tanımlamaz veya büyük öğe gruplarını silmek için kullanışlı yollar sunmaz. Dizinden bir EKL üst öğesi silindiğinde, yalnızca |
aclInheritanceType |
Bir öğe, EKL'sini bir üst öğeden devraldığında uygulanacak erişim kurallarının türünü ayarlar. Bu, her zaman |
readers[] |
Arama sonuçlarında öğeyi görmesine izin verilen ana hesapların listesi. İzinleri başka bir öğeden devralıyorsanız veya öğenin görünür olması amaçlanmamışsa (ör. |
deniedReaders[] |
Arama sonuçlarında öğeye erişimi açık bir şekilde reddedilen ana hesapların listesi. Ana hesaplara erişim varsayılan olarak reddedilmiş olsa da istisnaları işlemek ve izin verilen okuyucuları geçersiz kılmak için reddedilen okuyucuları kullanın. Maksimum öğe sayısı 100'dür. |
owners[] |
İsteğe bağlı. Öğenin sahiplerinin listesi. Bu alanın doküman erişim izinleriyle bir ilgisi yoktur. Bununla birlikte, sorgulayan kullanıcının sahip olduğu öğeleri sıralamada küçük bir artışla güçlendirir. Maksimum öğe sayısı 5'tir. |
ItemAcl.AclInheritanceType
EKL devralma türleri.
Sıralamalar | |
---|---|
NOT_APPLICABLE |
Bu öğe bir EKL devralmadığında varsayılan değer. inheritAclFrom boş olduğunda NOT_APPLICABLE öğesini kullanın. EKL devralması olmayan bir öğenin kendi readers ve deniedReaders alanları tarafından sağlanan EKL'leri olabilir. |
CHILD_OVERRIDE |
Yetkilendirme çakışması sırasında alt öğenin EKL'si, okuma erişimini belirler. |
PARENT_OVERRIDE |
Yetkilendirme çakışması sırasında, inheritAclFrom alanında belirtilen üst öğenin EKL'si okuma erişimini belirler. |
BOTH_PERMIT |
Erişim izni, yalnızca bu öğe ve inheritAclFrom alanında belirtilen üst öğenin okuma erişimine izin vermesi durumunda verilir. |
Ana hesap
Bir kullanıcı, grup veya alana atıfta bulunma.
JSON gösterimi |
---|
{ // Union field |
Alanlar | |
---|---|
Birleştirme alanı
|
|
gsuitePrincipal |
Bu ana hesap bir Google Workspace kullanıcısı, grubu veya alandır. |
userResourceName |
Bu ana hesap, harici bir kimlik kullanarak tanımlanan kullanıcıdır. Ad alanında, kullanıcı kaynağı adı şu biçimde belirtilmelidir: Identitysources/{sourceId}/users/{ID} |
groupResourceName |
Bu ana hesap, harici bir kimlik kullanılarak tanımlanan gruptur. Ad alanında, grup kaynağı adı şu biçimde belirtilmelidir: Identitysources/{sourceId}/groups/{ID} |
ItemMetadata
Öğe için kullanılabilir meta veri alanları.
JSON gösterimi |
---|
{ "title": string, "sourceRepositoryUrl": string, "containerName": string, "objectType": string, "createTime": string, "updateTime": string, "interactions": [ { object ( |
Alanlar | |
---|---|
title |
Öğenin başlığı. Belirtilmişse bu, query.search sonucunun görüntülenen başlığı olur. En çok 2048 karakter kullanılabilir. |
sourceRepositoryUrl |
Verileri sunan kaynak deponun bağlantısı. Arama sonuçları bu bağlantıyı başlığa uygular. Boşluk veya özel karakterler, Cloud Seach sonuç bağlantılarının bir yönlendirme bildirimini tetiklemesine neden olabilir; Bunu önlemek için URL'yi kodlayın. En çok 2048 karakter kullanılabilir. |
containerName |
Bu öğenin kapsayıcısının adı. Kapsayıcı öğesinin silinmesi, bu öğenin otomatik olarak silinmesine neden olur. Not: EKL'ler bir kapsayıcı öğesinden devralınmaz. Bir öğeye EKL devralma ayarı sağlamak için |
objectType |
Öğenin türü. Bu, veri kaynağı için kayıtlı şemadaki bir nesne tanımının adına karşılık gelmelidir. Örneğin, veri kaynağına ait şema "document" adında bir nesne tanımı içeriyorsa bu türdeki nesnelere yönelik öğe dizine ekleme istekleri, itemType'ı "document" (doküman) olarak ayarlamalıdır. En çok 256 karakter kullanılabilir. |
createTime |
Öğenin kaynak depoda oluşturulduğu zaman. RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: |
updateTime |
Öğenin kaynak depoda en son değiştirildiği zaman. RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: |
interactions[] |
Öğeyle ilgili etkileşimlerin listesi. Etkileşimler, query.search kalitesini iyileştirmek için kullanılır ancak son kullanıcılara gösterilmez. Maksimum öğe sayısı 1.000'dir. |
contentLanguage |
Öğenin BCP-47 dil kodu (ör. "en-US") veya "sr-Latn" girin. Daha fazla bilgi için http://www.unicode.org/reports/tr35/#Unicode_locale_identifier sayfasına bakın. En çok 32 karakter kullanılabilir. |
mimeType |
Kaynak depodaki |
searchQualityMetadata |
Öğenin ek arama kalitesi meta verileri |
keywords[] |
Öğeyle eşleşmesi gereken ek anahtar kelimeler veya kelime öbekleri. Kullanıcı tarafından oluşturulan içerik için dahili olarak kullanılır. Maksimum öğe sayısı 100'dür. En çok 8.192 karakter kullanılabilir. |
hash |
API çağrısı tarafından sağlanan karma oluşturma değeri. Bu değer, değiştirilme durumunu hesaplamak için |
contextAttributes[] |
Öğeyle ilişkilendirilmiş bir adlandırılmış özellik grubu. Bu değer, istekteki bağlama göre öğenin sıralamasını etkilemek için kullanılabilir. Maksimum öğe sayısı 10'dur. |
Etkileşim
Bir kullanıcı ile öğe arasındaki etkileşimi temsil eder.
JSON gösterimi |
---|
{ "type": enum ( |
Alanlar | |
---|---|
type |
|
principal |
Öğe üzerinde işlem yapan kullanıcı. |
interactionTime |
Kullanıcının öğe üzerinde işlem yaptığı zaman. Tek bir kullanıcı için aynı türde birden fazla işlem varsa yalnızca en son işlem kaydedilir. RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: |
Interaction.InteractionType
Kullanıcının öğe üzerinde gerçekleştirdiği etkinliğin türü.
Sıralamalar | |
---|---|
UNSPECIFIED |
Geçersiz değer. |
VIEW |
Bu etkileşim, kullanıcının öğeyi görüntülediğini gösterir. |
EDIT |
Bu etkileşim, kullanıcının öğeyi düzenlediğini gösterir. |
SearchQualityMetadata
Öğenin ek arama kalitesi meta verileri.
JSON gösterimi |
---|
{ "quality": number } |
Alanlar | |
---|---|
quality |
Arama kalitesini etkilemek için kullanılan, öğenin kalitesinin bir göstergesi. değer 0,0 (en düşük kalite) ile 1.0 (en yüksek kalite) arasında olmalıdır. Varsayılan değer 0,0'dır. |
ContextAttribute
İstekteki bağlama göre öğenin sıralamasını etkilemek için kullanılabilecek, bir öğeyle ilişkili adlandırılmış özellik.
JSON gösterimi |
---|
{ "name": string, "values": [ string ] } |
Alanlar | |
---|---|
name |
Özelliğin adı. Boş olmamalıdır. En çok 32 karakter kullanılabilir. Ad bir harfle başlamalıdır ve yalnızca harf (A-Z, a-z) veya rakam (0-9) içerebilir. Ad, eşleştirilmeden önce normalleştirilir (küçük harfle). |
values[] |
Özelliğin metin değerleri. Maksimum öğe sayısı 10'dur. Dizideki bir öğenin maksimum uzunluğu 32 karakterdir. Değer, eşleştirilmeden önce normalleştirilir (küçük harfle). |
ItemStructuredData
Öğe için kullanılabilir yapılandırılmış veri alanları.
JSON gösterimi |
---|
{
"object": {
object ( |
Alanlar | |
---|---|
object |
Veri kaynağına ait şemada kayıtlı nesne tanımına uyması gereken yapılandırılmış veri nesnesi. |
hash |
API çağrısı tarafından sağlanan karma oluşturma değeri. Bu değer, değiştirilme durumunu hesaplamak için |
StructuredDataObject
Adlandırılmış özelliklerden oluşan yapılandırılmış veri nesnesi.
JSON gösterimi |
---|
{
"properties": [
{
object ( |
Alanlar | |
---|---|
properties[] |
Nesnenin özellikleri. Maksimum öğe sayısı 1.000'dir. |
NamedProperty
Yapılandırılmış veriler için yazılan ad-değer çifti. Değerin türü, objectType
nesne tanımındaki name
özelliğinin kayıtlı türüyle aynı olmalıdır.
JSON gösterimi |
---|
{ "name": string, // Union field |
Alanlar | |
---|---|
name |
Tesisin adı. Bu ad, şemada nesne tanımı için kaydedilen özelliğin adına karşılık gelmelidir. Bu tesis için izin verilen maksimum uzunluk 256 karakterdir. |
Birleştirme alanı value . Adlandırılmış özelliğin değerleri. Bir özelliğin yalnızca bir türden değerler alabileceğini unutmayın. value şunlardan yalnızca biri olabilir: |
|
integerValues |
|
doubleValues |
|
timestampValues |
|
booleanValue |
|
objectValues |
|
enumValues |
|
dateValues |
|
textValues |
|
htmlValues |
|
NamedProperty.IntegerValues
Tam sayı değerlerinin listesi.
JSON gösterimi |
---|
{ "values": [ string ] } |
Alanlar | |
---|---|
values[] |
|
NamedProperty.DoubleValues
Çift değerlerin listesi.
JSON gösterimi |
---|
{ "values": [ number ] } |
Alanlar | |
---|---|
values[] |
|
NamedProperty.TimestampValues
Zaman damgası değerlerinin listesi.
JSON gösterimi |
---|
{ "values": [ string ] } |
Alanlar | |
---|---|
values[] |
RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: |
NamedProperty.ObjectValues
Nesne değerlerinin listesi.
JSON gösterimi |
---|
{
"values": [
{
object ( |
Alanlar | |
---|---|
values[] |
|
NamedProperty.EnumValues
Sıralama değerlerinin listesi.
JSON gösterimi |
---|
{ "values": [ string ] } |
Alanlar | |
---|---|
values[] |
Dize değerleri için izin verilen maksimum uzunluk 32 karakterdir. |
NamedProperty.DateValues
Tarih değerlerinin listesi.
JSON gösterimi |
---|
{
"values": [
{
object ( |
Alanlar | |
---|---|
values[] |
|
NamedProperty.TextValues
Metin değerleri listesi.
JSON gösterimi |
---|
{ "values": [ string ] } |
Alanlar | |
---|---|
values[] |
Metin değerleri için izin verilen maksimum uzunluk 2048 karakterdir. |
NamedProperty.HtmlValues
HTML değerlerinin listesi.
JSON gösterimi |
---|
{ "values": [ string ] } |
Alanlar | |
---|---|
values[] |
HTML değerleri için izin verilen maksimum uzunluk 2048 karakterdir. |
ItemContent
Cloud Search tarafından dizine eklenecek ve sunulacak bir öğenin içeriği. inlineContent
olarak yalnızca UTF-8 olarak kodlanmış dizelere izin verilir. İçerik ikili değil de yüklendiyse UTF-8 olarak kodlanmış olmalıdır.
JSON gösterimi |
---|
{ "contentFormat": enum ( |
Alanlar | |
---|---|
contentFormat |
|
hash |
İçerik için API istemcisi tarafından hesaplanan ve sağlanan karma oluşturma bilgileri. Değiştirilme durumunu hesaplamak için items.push yöntemiyle kullanılabilir. En çok 2048 karakter kullanılabilir. |
Birleştirme alanı
|
|
inlineContent |
Güncelleme yönteminde satır içi olarak sağlanan içerik. Maksimum uzunluk 102.400 bayttır (100 KiB). base64 kodlu bir dize. |
contentDataRef |
Yazma yöntemiyle daha önce yüklenmiş bir içeriğin referans kimliğini yükleyin. |
ItemContent.ContentFormat
İçeriğin biçimi. Biçim RAW ise içerik mimeType
tarafından belirtilen biçimde olmalıdır.
Sıralamalar | |
---|---|
UNSPECIFIED |
Geçersiz değer. |
HTML |
contentFormat HTML'dir. |
TEXT |
contentFormat serbest metindir. |
RAW |
contentFormat, işlenmemiş baytlardır. |
UploadItemRef
Yükleme oturumu referansını temsil eder. Bu referans upload method
üzerinden oluşturuldu. Bu referans, oluşturulduktan sonraki 30 gün boyunca geçerlidir. Öğe içeriğinin güncellenmesi, contentDataRef
aracılığıyla yüklenen bu içerikle ilgili olabilir.
JSON gösterimi |
---|
{ "name": string } |
Alanlar | |
---|---|
name |
İçerik referansının adı. En çok 2048 karakter kullanılabilir. |
ItemStatus
Bu öğe, öğenin durumunu ve varsa hataları içerir.
JSON gösterimi |
---|
{ "code": enum ( |
Alanlar | |
---|---|
code |
Durum kodu. |
processingErrors[] |
Öğenin ERROR (HATA) durumunda olması ihtimaline ilişkin hata ayrıntıları. |
repositoryErrors[] |
Bağlayıcı tarafından bildirilen depo hatası. |
ProcessingError
JSON gösterimi |
---|
{ "code": enum ( |
Alanlar | |
---|---|
code |
Hatanın türünü gösteren hata kodu. |
errorMessage |
Hatanın açıklaması. |
fieldViolations[] |
Öğe alanlarının geçersiz olması durumunda bu alanda doğrulama hatalarıyla ilgili ayrıntılar yer alır. |
ProcessingErrorCode
Öğelerin Cloud Search sunucusu tarafından işlenmesi sırasında karşılaşılan hatayı gösteren kodlar. Tek bir öğe birden fazla işleme hatası içerebilir.
Sıralamalar | |
---|---|
PROCESSING_ERROR_CODE_UNSPECIFIED |
Yalnızca değer girin. Bu değeri Öğeler bölümünde kullanın. |
MALFORMED_REQUEST |
Öğenin EKL, meta veri veya içeriği hatalı ya da geçersiz durumda. Alan ihlalleri, sorunun nerede olduğuyla ilgili daha fazla ayrıntı içerir. |
UNSUPPORTED_CONTENT_FORMAT |
Sayı biçimi desteklenmiyor. |
INDIRECT_BROKEN_ACL |
Bozuk EKL'ye sahip başka öğeler devralındığı veya eşlenmemiş alt öğeleri olan gruplara sahip olduğu için eksik EKL bilgilerine sahip öğeler. |
ACL_CYCLE |
EKL devralma grafiği bir döngü oluşturdu. |
FieldViolation
JSON gösterimi |
---|
{ "field": string, "description": string } |
Alanlar | |
---|---|
field |
İhlal içeren alan yolu. |
description |
Hatanın açıklaması. |
RepositoryError
Bağlayıcı, kaynak depoyla iletişim kurarken hata oluşur.
JSON gösterimi |
---|
{
"type": enum ( |
Alanlar | |
---|---|
type |
Hatanın türü. |
httpStatusCode |
Hata kodları. HTTP durum kodlarının tanımıyla eşleşir. |
errorMessage |
Hatayı açıklayan mesaj. Mesajın izin verilen maksimum uzunluğu 8.192 karakterdir. |
RepositoryError.Type
Bilgi deposuyla ilgili iletişim sorunlarına yönelik hata kodlarının listesi.
Sıralamalar | |
---|---|
UNKNOWN |
Bilinmeyen hata. |
NETWORK_ERROR |
Bilinmeyen veya erişilemez ana makine. |
DNS_ERROR |
DNS sunucusunun yanıt vermemesi gibi bir DNS sorunu. |
CONNECTION_ERROR |
Kod deposu sunucusuna bağlanılamıyor. |
AUTHENTICATION_ERROR |
Yanlış kimlik bilgileri nedeniyle kimlik doğrulama başarısız oldu. |
AUTHORIZATION_ERROR |
Hizmet hesabının kod deposu için yetkisi yok. |
SERVER_ERROR |
Depo sunucusu hatası. |
QUOTA_EXCEEDED |
Kota aşıldı. |
SERVICE_UNAVAILABLE |
Sunucu geçici olarak kullanılamıyor. |
CLIENT_ERROR |
Bağlayıcıdan depo sunucusuna gönderilen geçersiz bir istek gibi istemciyle ilgili hata. |
Item.ItemType
Sıralamalar | |
---|---|
UNSPECIFIED |
|
CONTENT_ITEM |
Yalnızca bilgi sunmak amacıyla dizine eklenen öğe. Bu öğelere containerName veya inheritAclFrom alanlarında referans verilemez. |
CONTAINER_ITEM |
Dizine eklenen ve amacı başka öğeleri EKL'ler ile sağlamak ve/veya başka öğeler içeren bir öğe. |
VIRTUAL_CONTAINER_ITEM |
Dizine eklenmeyen ancak CONTAINER_ITEM ile aynı amaca sahip olan bir öğe. |
Yöntemler |
|
---|---|
|
Belirtilen kaynak adı için Item resource öğesini siler. |
|
Sıradaki tüm öğeleri siler. |
|
Öğe adına göre Item resource değerini alır. |
|
Item EKL, meta veri ve içeriği günceller. |
|
Item resources öğesinin tümünü veya bir alt kümesini listeler. |
|
Dizine ekleme sırasındaki ayrılmamış öğeler için anketler yapar ve bir grubu ayrılmış olarak işaretler. İlk zaman damgası en yüksek önceliğe (ItemStatus ) sahip öğelerle başlar. |
|
Bir öğeyi daha sonra yoklama ve güncelleme amacıyla bir sıraya aktarır. |
|
Sıradaki tüm öğelerin rezervasyonunu kaldırarak öğelerin sorgulanmaya uygun olmasını sağlar. |
|
Öğe içeriği yüklemek için bir yükleme oturumu oluşturur. |