- HTTP isteği
- Yol parametreleri
- İstek gövdesi
- Yanıt metni
- Yetkilendirme Kapsamları
- IndexItemOptions
- Deneyin.
Item
EKL, meta veri ve içeriği günceller. Varsa Item
öğesini ekler. Bu yöntem kısmi güncellemeleri desteklemez. Değer sağlanmamış alanlar Cloud Search dizininden temizlenir.
Bu API'nin yürütülebilmesi için bir yönetici veya hizmet hesabı gerekir. Kullanılan hizmet hesabı, ilgili veri kaynağında beyaz listeye eklenmiş olan hesaptır.
HTTP isteği
POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:index
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Yol parametreleri
Parametreler | |
---|---|
item.name |
Öğenin adı. Biçim: datasources/{sourceId}/items/{itemId} Bu alanının doldurulması zorunludur. En çok 1536 karakter kullanılabilir. |
İstek içeriği
İstek gövdesi, aşağıdaki yapıya sahip verileri içerir:
JSON gösterimi |
---|
{ "item": { "name": string, "acl": { "inheritAclFrom": string, "aclInheritanceType": enum ( |
Alanlar | |
---|---|
item.acl |
Bu öğe için erişim kontrol listesi. |
item.metadata |
Meta veri bilgileri. |
item.structuredData |
Veri kaynağının şemasında kayıtlı nesne tanımına uyması gereken öğenin yapılandırılmış verileri. |
item.content |
Dizine eklenecek ve metin aranabilir hale getirilecek öğe içeriği. |
item.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. |
item.status |
Öğenin durumu. Yalnızca çıkış alanı. |
item.queue |
Bu öğenin ait olduğu sıraya ekleyin. En çok 100 karakter kullanılabilir. |
item.payload |
Bu öğe için ek durum bağlayıcısı depolayabilir. Maksimum uzunluk 10.000 bayttır. base64 kodlu bir dize. |
item.itemType |
Bu öğenin türü. |
connectorName |
Bu çağrıyı yapan bağlayıcının adı. Biçim: datasources/{sourceId}/connectors/{ID} |
mode |
Zorunlu. Bu istek için RequestMode. |
debugOptions |
Sık karşılaşılan hata ayıklama seçenekleri. |
indexItemOptions |
|
Yanıt gövdesi
Başarılıysa yanıt metni, Operation
öğesinin bir örneğini içerir.
Yetkilendirme Kapsamları
Aşağıdaki OAuth kapsamlarından birini gerektirir:
https://www.googleapis.com/auth/cloud_search.indexing
https://www.googleapis.com/auth/cloud_search
Daha fazla bilgi için Yetkilendirme kılavuzunu inceleyin.
IndexItemOptions
JSON gösterimi |
---|
{ "allowUnknownGsuitePrincipals": boolean } |
Alanlar | |
---|---|
allowUnknownGsuitePrincipals |
Dizin isteğinin, mevcut olmayan veya silinmiş Google Workspace ana hesaplarına izin verip vermeyeceğini belirtir. |