- Kaynak: Öğ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 dizininde öğe olan tek bir nesneyi (ör. dosya, klasör veya veritabanı kaydı) 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. Maksimum uzunluk 1.536 karakterdir. |
acl |
Bu öğenin erişim kontrol listesi. |
metadata |
Meta veri bilgileri. |
structuredData |
Öğenin, veri kaynağının şemasında kayıtlı bir nesne tanımına uygun olması gereken yapılandırılmış verileri. |
content |
Dizine eklenecek ve metin olarak aranabilir hale getirilecek öğe içeriği. |
version |
Zorunlu. Dizine ekleme sistemi, veri kaynağındaki sürümü bir bayt dizesi olarak depolar ve dizinindeki öğe sürümünü, söz dizimi sıralamasını kullanarak sıraya eklenen öğenin sürümüyle karşılaştırır. Cloud Search dizine ekleme, sürüm değeri şu anda dizine eklenen öğenin sürümünden küçük veya bu sürüme eşit olan ve sıraya eklenen öğeleri dizine eklemez veya silmez. Bu alanın maksimum uzunluğu 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ıra. Maksimum uzunluk 100 karakterdir. |
payload |
Ek durum bağlayıcısı bu öğe için depolama alanı sağlayabilir. 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 Harita ACL'leri başlıklı makaleyi inceleyin.
JSON gösterimi |
---|
{ "inheritAclFrom": string, "aclInheritanceType": enum ( |
Alanlar | |
---|---|
inheritAclFrom |
Erişim İzni Listesi'ni (EKL) devralacak öğenin adı. Not: ACL devralma işlemi yalnızca alt öğelere erişim izinleri sağlar ve yapısal ilişkileri tanımlamaz ya da büyük öğe gruplarını silme konusunda uygun yöntemler sunmaz. Bir ACL üst öğesinin dizinden silinmesi yalnızca |
aclInheritanceType |
Bir öğe EKL'sini üst öğesinden devraldığında uygulanacak erişim kurallarının türünü belirler. Bu, her zaman |
readers[] |
Öğeyi arama sonuçlarında görmelerine izin verilen yöneticilerin listesi. Başka bir öğeden izin devralınıyorsa veya öğenin görünür olması amaçlanmıyorsa (ör. |
deniedReaders[] |
Arama sonuçlarındaki öğeye erişimi açıkça reddedilenlerin listesi. Varsayılan olarak ana hesapların erişimi reddedilir. İstisnaları işlemek ve izin verilen okuyucu listesini 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 hiçbir ilgisi yoktur. Ancak sorgu yapan kullanıcının sahip olduğu öğeler için sıralamada küçük bir artış sağlar. Maksimum öğe sayısı 5'tir. |
ItemAcl.AclInheritanceType
ACL devralma türleri.
Sıralamalar | |
---|---|
NOT_APPLICABLE |
Bu öğe bir ACL devralmadığında varsayılan değerdir. inheritAclFrom boş olduğunda NOT_APPLICABLE değerini kullanın. EKL devralma özelliği 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 ACL'si okuma erişimini belirler. |
PARENT_OVERRIDE |
Yetkilendirme anlaşmazlığı sırasında, inheritAclFrom alanında belirtilen üst öğenin ACL'si okuma erişimini belirler. |
BOTH_PERMIT |
Erişim yalnızca bu öğe ve inheritAclFrom alanında belirtilen üst öğe her ikisi de salt okuma erişimine izin veriyorsa verilir. |
Ana hesap
Bir kullanıcıya, gruba veya alana referans.
JSON gösterimi |
---|
{ // Union field |
Alanlar | |
---|---|
Birlik alanı
|
|
gsuitePrincipal |
Bu asıl kişi bir Google Workspace kullanıcısı, grubu veya alanıdır. |
userResourceName |
Bu asıl kişi, harici kimlik kullanılarak tanımlanan bir kullanıcıdır. Ad alanı, kullanıcı kaynağı adını şu biçimle belirtmelidir: identitysources/{sourceId}/users/{ID} |
groupResourceName |
Bu asıl kişi, harici kimlik kullanılarak tanımlanan bir gruptur. Ad alanı, grup kaynak adını şu biçimde belirtmelidir: identitysources/{sourceId}/groups/{ID} |
ItemMetadata
Öğe için kullanılabilen 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ığı. Belirtilen takdirde, query.search sonucunun gösterilen başlığı olur. Maksimum uzunluk 2.048 karakterdir. |
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 Search sonuç bağlantılarının yönlendirme bildirimi tetiklemesine neden olabilir. Bunu önlemek için URL'yi kodlayın. Maksimum uzunluk 2.048 karakterdir. |
containerName |
Bu öğenin kapsayıcısının adı. Kapsayıcı öğenin silinmesi, bu öğenin otomatik olarak silinmesine neden olur. Not: ACL'ler kapsayıcı öğesinden devralınmaz. Bir öğe için ACL devralınmasını sağlamak üzere |
objectType |
Öğenin türü. Bu, veri kaynağı için kayıtlı şemada bir nesne tanımının adına karşılık gelmelidir. Örneğin, veri kaynağının şemasında "document" adlı bir nesne tanımı varsa bu tür nesneler için öğe dizine ekleme istekleri objectType değerini "document" olarak ayarlamalıdır. Maksimum uzunluk 256 karakterdir. |
createTime |
Öğenin kaynak depoda oluşturulduğu zaman. Nanosaniye çözünürlüğüne sahip ve en fazla dokuz kesirli basamak içeren RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: |
updateTime |
Öğenin kaynak depoda en son değiştirildiği zaman. Nanosaniye çözünürlüğüne sahip ve en fazla dokuz kesirli basamak içeren RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Ö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 ("en-US" veya "sr-Latn" gibi). Daha fazla bilgi için http://www.unicode.org/reports/tr35/#Unicode_locale_identifier adresini ziyaret edin. Maksimum uzunluk 32 karakterdir. |
mimeType |
Kaynak depoda |
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. Maksimum uzunluk 8.192 karakterdir. |
hash |
API çağıran tarafından sağlanan karma oluşturma değeri. Bu yöntem, değiştirilmiş durumu hesaplamak için |
contextAttributes[] |
Öğeyle ilişkili bir dizi adlandırılmış özellik. Bu, 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 öğeyle ilgili 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. Nanosaniye çözünürlüğüne sahip ve en fazla dokuz kesirli basamak içeren RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: |
Interaction.InteractionType
Kullanıcının öğede gerçekleştirdiği etkinlik 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 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
Bir öğeyle ilişkili ve istekteki bağlama göre öğenin sıralamasını etkilemek için kullanılabilen adlandırılmış özellik.
JSON gösterimi |
---|
{ "name": string, "values": [ string ] } |
Alanlar | |
---|---|
name |
Özelliğin adı. Boş bırakılmamalıdır. Maksimum uzunluk 32 karakterdir. Ad bir harfle başlamalıdır ve yalnızca harf (A-Z, a-z) veya rakam (0-9) içerebilir. Ad, eşleşmeden önce normalleştirilir (küçük harflerle yazılır). |
values[] |
Özelliğin metin değerleri. Maksimum öğe sayısı 10'dur. Dizideki bir öğenin maksimum uzunluğu 32 karakterdir. Değer, eşleşmeden önce normalleştirilir (küçük harflerle yazılır). |
ItemStructuredData
Öğe için kullanılabilen yapılandırılmış veri alanları.
JSON gösterimi |
---|
{
"object": {
object ( |
Alanlar | |
---|---|
object |
Veri kaynağının şemasında kayıtlı bir nesne tanımına uygun olması gereken yapılandırılmış veri nesnesi. |
hash |
API çağıran tarafından sağlanan karma oluşturma değeri. Bu yöntem, değiştirilmiş durumu hesaplamak için |
StructuredDataObject
Adlandırılmış özelliklerden oluşan bir 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ılmış bir ad-değer çifti. Değerin türü, objectType
nesnesi tanımında name
mülkü için kayıtlı türle aynı olmalıdır.
JSON gösterimi |
---|
{ "name": string, // Union field |
Alanlar | |
---|---|
name |
Tesisin adı. Bu ad, şemada nesne tanımı için kaydedilen mülkün adıyla eşleşmelidir. Bu özellik için izin verilen maksimum uzunluk 256 karakterdir. |
Birlik alanı value . Adlandırılmış mülkün değerleri. Bir mülkün yalnızca bir türde değer içerebileceğini unutmayın. value yalnızca aşağıdakilerden 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[] |
Nanosaniye çözünürlüğüne sahip ve en fazla dokuz kesirli basamak içeren RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: |
NamedProperty.ObjectValues
Nesne değerlerinin listesi.
JSON gösterimi |
---|
{
"values": [
{
object ( |
Alanlar | |
---|---|
values[] |
|
NamedProperty.EnumValues
Enum 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ğerlerinin listesi.
JSON gösterimi |
---|
{ "values": [ string ] } |
Alanlar | |
---|---|
values[] |
Metin değerleri için izin verilen maksimum uzunluk 2.048 karakterdir. |
NamedProperty.HtmlValues
HTML değerlerinin listesi.
JSON gösterimi |
---|
{ "values": [ string ] } |
Alanlar | |
---|---|
values[] |
HTML değerleri için izin verilen maksimum uzunluk 2.048 karakterdir. |
ItemContent
Cloud Search tarafından dizine eklenecek ve gösterilecek bir öğenin içeriği. inlineContent
olarak yalnızca UTF-8 olarak kodlanmış dizelere izin verilir. Yüklenen içerikler ikili değilse 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ştirilmiş durumu hesaplamak için items.push yöntemiyle kullanılabilir. Maksimum uzunluk 2.048 karakterdir. |
Birlik alanı
|
|
inlineContent |
Güncelleme yöntemi içinde satır içi olarak sağlanan içerik. Maksimum uzunluk 10.2400 bayttır (100 KiB). Base64 kodlu bir dize. |
contentDataRef |
Daha önce yüklenen bir içeriğin referans kimliğini yazma yöntemiyle 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 olmalıdır. |
TEXT |
contentFormat serbest metindir. |
RAW |
contentFormat ham bayttır. |
UploadItemRef
Yükleme oturumu referansını temsil eder. Bu referans upload method
üzerinden oluşturulmuştur. Bu referans, oluşturulduktan sonraki 30 gün boyunca geçerlidir. Öğe içeriğinin güncellenmesi, contentDataRef
aracılığıyla bu yüklenen içeriğe referans verebilir.
JSON gösterimi |
---|
{ "name": string } |
Alanlar | |
---|---|
name |
İçerik referansının adı. Maksimum uzunluk 2.048 karakterdir. |
ItemStatus
Bu, öğenin durumunu ve hataları içerir.
JSON gösterimi |
---|
{ "code": enum ( |
Alanlar | |
---|---|
code |
Durum kodu. |
processingErrors[] |
Öğe ERROR durumundaysa hata ayrıntıları. |
repositoryErrors[] |
Bağlayıcı tarafından bildirilen depo hatası. |
ProcessingError
JSON gösterimi |
---|
{ "code": enum ( |
Alanlar | |
---|---|
code |
Hatanın niteliğini belirten hata kodu. |
errorMessage |
Hatanın açıklaması. |
fieldViolations[] |
Öğe alanları geçersizse bu alan, doğrulama hatalarıyla ilgili ayrıntıları içerir. |
ProcessingErrorCode
Cloud Search sunucusu tarafından öğeler işlenirken karşılaşılan hatayı belirten 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'de kullanın. |
MALFORMED_REQUEST |
Öğenin ACL'si, meta verileri veya içeriği hatalı biçimlendirilmiş veya geçersiz durumda. FieldViolations, sorunun nerede olduğuyla ilgili daha fazla ayrıntı içerir. |
UNSUPPORTED_CONTENT_FORMAT |
İçerik biçimi desteklenmiyor. |
INDIRECT_BROKEN_ACL |
Bozuk ACL'ye sahip diğer öğeleri devraldığı veya haritalandırılmamış alt öğeleri olan gruplar içerdiği için eksik ACL bilgilerine sahip öğeler. |
ACL_CYCLE |
ACL devralma grafiği bir döngü oluşturdu. |
FieldViolation
JSON gösterimi |
---|
{ "field": string, "description": string } |
Alanlar | |
---|---|
field |
İhlal içeren alanın yolu. |
description |
Hatanın açıklaması. |
RepositoryError
Bağlayıcı kaynak depoyla iletişim kurarken oluşan hatalar.
JSON gösterimi |
---|
{
"type": enum ( |
Alanlar | |
---|---|
type |
Hatanın türü. |
httpStatusCode |
Hata kodları. HTTP durum kodlarının tanımı ile eşleşiyor. |
errorMessage |
Hatayı açıklayan mesaj. Mesajın izin verilen maksimum uzunluğu 8.192 karakterdir. |
RepositoryError.Type
Depoyla ilgili iletişim sorunlarının hata kodları listesi.
Sıralamalar | |
---|---|
UNKNOWN |
Bilinmeyen hata. |
NETWORK_ERROR |
Bilinmeyen veya erişilemeyen ana makine. |
DNS_ERROR |
DNS sunucusu yanıt vermiyor gibi DNS sorunları. |
CONNECTION_ERROR |
Depolama alanı sunucusuna bağlanılamıyor. |
AUTHENTICATION_ERROR |
Hatalı kimlik bilgileri nedeniyle kimlik doğrulama başarısız oldu. |
AUTHORIZATION_ERROR |
Hizmet hesabının depo 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ğlantı aracısından depolama alanı sunucusuna gönderilen geçersiz istek gibi istemciyle ilgili hata. |
Item.ItemType
Sıralamalar | |
---|---|
UNSPECIFIED |
|
CONTENT_ITEM |
Yalnızca bilgi sunma amacıyla dizine eklenen öğe. Bu öğeler containerName veya inheritAclFrom alanlarında referans olarak kullanılamaz. |
CONTAINER_ITEM |
Dizine eklenen ve amacı diğer öğelere ACL'ler sağlamak ve/veya diğer öğeleri içermek olan bir öğe. |
VIRTUAL_CONTAINER_ITEM |
Dizine eklenmeyen ancak CONTAINER_ITEM ile aynı amaca sahip bir öğe. |
Yöntemler |
|
---|---|
|
Belirtilen kaynak adı için Item resource öğesini siler. |
|
Bir sıradaki tüm öğeleri siler. |
|
Öğe adına göre Item resource değerini alır. |
|
Item ACL'sini, meta verilerini ve içeriğini günceller. |
|
Item resources öğesinin tamamını veya bir alt kümesini listeler. |
|
Dizine ekleme kuyruğundaki ayrılmamış öğeleri sorar ve en yüksek önceliğe sahip ItemStatus öğesinden başlayarak bir grubu ayrılmış olarak işaretler. |
|
Daha sonra sorgulanması ve güncellenmesi için bir öğeyi bir sıraya gönderir. |
|
Bir sıradaki tüm öğelerin rezervasyonunu kaldırarak bunların tümünü ankete uygun hale getirir. |
|
Öğe içeriğini yüklemek için bir yükleme oturumu oluşturur. |