- HTTP isteği
- Yol parametreleri
- İstek metni
- Yanıt metni
- Yetkilendirme Kapsamları
- IndexItemOptions
- Deneyin.
Item
EKL, meta verileri ve içeriğini günceller. Item
yoksa ekler. Bu yöntem kısmi güncellemeleri desteklemez. Değer belirtilmemiş alanlar Cloud Search dizininde temizlenir.
Bu API'nin yürütülebilmesi için yönetici veya hizmet hesabı gerekir. Kullanılan hizmet hesabı, ilgili veri kaynağında beyaz listeye eklenen 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: veri kaynakları/{kaynakKimliği}/öğeler/{öğeKimliği} Bu alanının doldurulması zorunludur. Maksimum uzunluk 1536 karakterdir. |
İstek içeriği
İstek gövdesi, aşağıdaki yapıyla birlikte veriler 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ındaki kayıtlı nesne tanımına uyması gereken öğe için yapılandırılmış veriler. |
item.content |
Dizine eklenecek ve metin aranabilir hale getirilecek öğe içeriği. |
item.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. |
item.status |
Öğenin durumu. Yalnızca çıkış alanı. |
item.queue |
Bu öğenin ait olduğu sıra. 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 olarak kodlanmış bir dize. |
item.itemType |
Bu öğenin türü. |
connectorName |
Bu çağrıyı yapan bağlayıcının adı. Biçim: veri kaynakları/{kaynakKimliği}/bağlayıcılar/{Kimlik} |
mode |
Zorunlu. Bu istek için İstek Modu. |
debugOptions |
Yaygın 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ılavuzuna göz atın.
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. |