- Kaynak: Öğe
- ItemAcl
- ItemAcl.AclInheritanceType
- Ana hesap
- 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 dosya, klasör veya veritabanı kaydı gibi tek bir nesneyi temsil eder.
JSON gösterimi |
---|
{ "name": string, "acl": { object ( |
Alanlar | |
---|---|
name |
Öğenin adı. Biçim: veri kaynakları/{kaynakKimliği}/öğeler/{öğeKimliği} Bu alanının doldurulması zorunludur. Maksimum uzunluk 1536 karakterdir. |
acl |
Bu öğe için erişim kontrol listesi. |
metadata |
Meta veri bilgileri. |
structuredData |
Veri kaynağının şemasındaki kayıtlı nesne tanımına uyması gereken öğe için yapılandırılmış veriler. |
content |
Dizine eklenecek ve metin aranabilir hale getirilecek öğe içeriği. |
version |
Zorunlu. Dizine ekleme sistemi, veri kaynağından gelen sürümü bayt dizesi olarak depolar ve dizindeki Öğe sürümünü, sözlüksel 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 sürüm değeri dizine eklenmiş öğenin sürümünden küçük veya bu sürüme eşit olan hiçbir öğeyi dizine eklemez veya silmez. Bu alan için maksimum uzunluk 1024 bayttır. Öğe sürümünün silme sürecini nasıl etkilediği hakkında bilgi için Manuel silme işleminden sonra düzeltmeleri işleme başlıklı makaleye bakın. Base64 olarak kodlanmış bir dize. |
status |
Öğenin durumu. Yalnızca çıkış alanı. |
queue |
Bu öğenin ait olduğu sıra. 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 olarak kodlanmış bir dize. |
itemType |
Bu öğenin türü. |
ItemAcl
Öğenin kontrol listesi bilgilerine erişim. Daha fazla bilgi için EKL'leri eşleme başlıklı makaleyi inceleyin.
JSON gösterimi |
---|
{ "inheritAclFrom": string, "aclInheritanceType": enum ( |
Alanlar | |
---|---|
inheritAclFrom |
Erişim İzni Listesi'nin (EKL) devralınacağı öğenin adı. Not: EKL devralma yalnızca alt öğeler için erişim izinleri sağlar ve yapısal ilişkileri tanımlamaz veya büyük öğe gruplarını silmek için kullanışlı yöntemler sağlamaz. Dizinden bir EKL üst öğesi silindiğinde yalnızca |
aclInheritanceType |
Bir öğe EKL'sini bir üst öğeden devraldığında uygulanacak erişim kuralı türünü ayarlar. Bu değer her zaman |
readers[] |
Öğeyi arama sonuçlarında 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ça reddedilen ana hesapların listesi. Ana hesapların erişimi varsayılan olarak reddedilmiş olsa da istisnaları işlemek ve izin verilen okuyucular 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 bir ilgisi yoktur. Ancak sorgulanan kullanıcının sahip olduğu öğelerin sıralamasında küçük bir artış sağlar. 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 değerini kullanın. EKL devralması olmayan bir öğe, kendi readers ve deniedReaders alanları tarafından sağlanan EKL'lere sahip olabilir. |
CHILD_OVERRIDE |
Yetkilendirme çakışması sırasında, alt öğenin EKL 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 öğe okuma erişimine izin veriyorsa verilir. |
Ana hesap
Bir kullanıcıya, gruba veya alana referans.
JSON gösterimi |
---|
{ // Union field |
Alanlar | |
---|---|
|
|
gsuitePrincipal |
Bu ana hesap bir Google Workspace kullanıcısı, grubu veya alanı. |
userResourceName |
Bu ana hesap, harici bir kimlik kullanılarak tanımlanan bir kullanıcıdır. Ad alanı, kullanıcı kaynağı adını şu biçimde belirtmelidir: Identitysources/{sourceId}/users/{ID} |
groupResourceName |
Bu ana hesap, harici bir kimlik kullanılarak tanımlanan bir gruptur. Ad alanı, grup kaynağı adını şu biçimde belirtmelidir: 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ığı. Verilirse, query.search sonucunun görüntülenen başlığı bu olur. Maksimum uzunluk 2048 karakterdir. |
sourceRepositoryUrl |
Verileri sunan kaynak depoya bağlantı oluşturun. 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. Maksimum uzunluk 2048 karakterdir. |
containerName |
Bu öğe için kapsayıcının adı. Kapsayıcı öğenin silinmesi, öğenin otomatik olarak silinmesine neden olur. Not: EKL'ler bir kapsayıcı öğesinden devralınmaz. Bir öğe için EKL devralma işlemini sağlamak için |
objectType |
Öğenin türü. Bu ad, şemadaki veri kaynağı için kaydedilen bir nesne tanımının adına karşılık gelmelidir. Örneğin, veri kaynağının şeması "document" adlı bir nesne tanımı içeriyorsa bu türdeki nesneler için öğe dizine ekleme istekleri,objectType'ı "document" olarak ayarlamalıdır. Maksimum uzunluk 256 karakterdir. |
createTime |
Öğenin kaynak depoda oluşturulduğu zaman. Nanosaniye çözünürlüğe ve en fazla dokuz kesir basamağına sahip, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: |
updateTime |
Öğenin kaynak depoda en son değiştirildiği zaman. Nanosaniye çözünürlüğe ve en fazla dokuz kesir basamağına sahip, 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 kodudur (ör. "en-US" veya "sr-Latn"). Daha fazla bilgi için http://www.unicode.org/reports/tr35/#Unicode_locale_identifier sayfasına bakın. Maksimum uzunluk 32 karakterdir. |
mimeType |
Kaynak kod deposundaki orijinal |
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ğrısını tarafından sağlanan karma oluşturma değeri. Bu, değiştirilmiş durumu hesaplamak için |
contextAttributes[] |
Öğeyle ilişkilendirilmiş bir adlandırılmış özellikler grubu. Bu özellik, istekteki bağlama göre öğenin sıralamasını etkilemek için kullanılabilir. Maksimum öğe sayısı 10'dur. |
Etkileşim
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 gerçekleştirdiği 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üğe ve en fazla dokuz kesir basamağına sahip, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Ö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 belirtir. |
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 kalitesine ilişkin bir gösterge. 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 olan 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ş olmamalı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ş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ğının şemasındaki kayıtlı nesne tanımına uyması gereken yapılandırılmış veri nesnesi. |
hash |
API çağrısını tarafından sağlanan karma oluşturma değeri. Bu, değiştirilmiş durumu hesaplamak için |
StructuredDataObject
Adlandırılmış özelliklerden oluşan yapılandırılmış bir 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 bir 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 |
Mülkün adı. Bu ad, şemada nesne tanımı için kaydedilen özelliğin adına karşılık gelmelidir. Bu mülk için izin verilen maksimum uzunluk 256 karakterdir. |
value alanı. Adlandırılan özelliğin değerleri. Bir özelliğin yalnızca tek bir türdeki değerleri barındırabileceğini unutmayın. value şunlardan yalnızca biri olabilir: |
|
integerValues |
|
doubleValues |
|
timestampValues |
|
booleanValue |
|
objectValues |
|
enumValues |
|
dateValues |
|
textValues |
|
htmlValues |
|
NamedProperty.IntegerValues
Tam sayı değerleri 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üğe ve en fazla dokuz kesir basamağına sahip, 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 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
Dizine eklenecek ve Cloud Search tarafından gösterilecek bir öğenin içeriği. Yalnızca UTF-8 olarak kodlanmış dizelere inlineContent
olarak izin verilir. İçerik yüklüyse (ikili dosya değil) 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ş durumun hesaplanması için items.push yöntemiyle kullanılabilir. Maksimum uzunluk 2048 karakterdir. |
|
|
inlineContent |
Güncelleme yönteminde satır içi olarak sağlanan içerik. Maksimum uzunluk 102.400 bayttır (100 KiB). Base64 olarak kodlanmış 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'dir. |
TEXT |
contentFormat serbest metindir. |
RAW |
contentFormat ham baytlardır. |
UploadItemRef
Yükleme oturumu referansını temsil eder. Bu referans upload method
aracılığıyla oluşturuldu. Bu referans, oluşturulduktan sonraki 30 gün boyunca geçerlidir. Öğe içeriğini güncelleme işlemi, contentDataRef
aracılığıyla yüklenen bu içerikle ilgili olabilir.
JSON gösterimi |
---|
{ "name": string } |
Alanlar | |
---|---|
name |
İçerik referansının adı. Maksimum uzunluk 2048 karakterdir. |
ItemStatus
Bu sütun, öğenin durumunu ve hataları içerir.
JSON gösterimi |
---|
{ "code": enum ( |
Alanlar | |
---|---|
code |
Durum kodu. |
processingErrors[] |
Öğenin HATA durumunda olmasıyla ilgili hata ayrıntıları. |
repositoryErrors[] |
Bağlayıcı tarafından kod deposu hatası bildirildi. |
ProcessingError
JSON gösterimi |
---|
{ "code": enum ( |
Alanlar | |
---|---|
code |
Hatanın yapısını belirten hata kodu. |
errorMessage |
Hatanın açıklaması. |
fieldViolations[] |
Öğe alanlarının geçersiz olması durumunda, bu alan doğrulama hatalarıyla ilgili ayrıntıları içerir. |
ProcessingErrorCode
Öğelerin Cloud Search sunucusu tarafından işlenmesi sırasında 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 bölümünde kullanın. |
MALFORMED_REQUEST |
Öğenin EKL, meta verileri veya içeriği hatalı biçimlendirilmiş ya da geçersiz durumda. Alanlar ihlalleri, sorunun nerede olduğuyla ilgili daha fazla ayrıntı içerir. |
UNSUPPORTED_CONTENT_FORMAT |
Countent biçimi desteklenmiyor. |
INDIRECT_BROKEN_ACL |
Bozuk EKL ile başka öğelerin devralınması veya eşlenmemiş alt öğeleri olan grupların bulunması nedeniyle EKL bilgileri eksik olan öğ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 kod deposuyla iletişim kurarken karşılaşılan hatalar.
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 ileti. Mesaj için izin verilen maksimum uzunluk 8.192 karakterdir. |
RepositoryError.Type
Depoyla iletişim sorunlarına ilişkin hata kodlarının listesi.
Sıralamalar | |
---|---|
UNKNOWN |
Bilinmeyen hata. |
NETWORK_ERROR |
Bilinmeyen veya erişilemez ana makine. |
DNS_ERROR |
DNS sorunu (ör. DNS sunucusu yanıt vermiyor). |
CONNECTION_ERROR |
Depo sunucusuna bağlanılamıyor. |
AUTHENTICATION_ERROR |
Hatalı kimlik bilgileri nedeniyle kimlik doğrulama başarısız oldu. |
AUTHORIZATION_ERROR |
Hizmet hesabı, depo için yetkilendirilmemiş. |
SERVER_ERROR |
Kod deposu sunucusu hatası. |
QUOTA_EXCEEDED |
Kota aşıldı. |
SERVICE_UNAVAILABLE |
Sunucu geçici olarak kullanılamıyor. |
CLIENT_ERROR |
Bağlayıcıdan depo sunucusuna geçersiz bir istek gibi istemciyle ilgili bir hata. |
Item.ItemType
Sıralamalar | |
---|---|
UNSPECIFIED |
|
CONTENT_ITEM |
Yalnızca bilgi sunma amacıyla dizine eklenen öğe. Bu öğelere containerName veya inheritAclFrom alanlarında başvuruda bulunulamaz. |
CONTAINER_ITEM |
Dizine eklenen ve amacı EKL'ler ile başka öğeler sağlamak ve/veya başka öğeler içeren bir öğedir. |
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. |
|
Sıradaki tüm öğeleri siler. |
|
Öğe adına göre Item resource değerini alır. |
|
Item EKL, meta verileri ve içeriğini günceller. |
|
Item resources öğesinin tümünü veya bir alt kümesini listeler. |
|
Dizine ekleme sırasındaki ayrılmamış öğelere yönelik anketler ve en yüksek önceliğe sahip ItemStatus zaman damgasına sahip öğelerden başlayarak, bir grubu ayrılmış olarak işaretler. |
|
Bir öğeyi daha sonra yoklama ve güncelleme için sıraya aktarır. |
|
Sıradaki tüm öğelerin rezervasyonunu iptal ederek tüm öğeleri anket için uygun hale getirir. |
|
Öğe içeriğini yüklemek için yükleme oturumu oluşturur. |