Method: indexing.datasources.items.index

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

string

Öğ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 (ItemAcl.AclInheritanceType),
      "readers": [
        {
          object (Principal)
        }
      ],
      "deniedReaders": [
        {
          object (Principal)
        }
      ],
      "owners": [
        {
          object (Principal)
        }
      ]
    },
    "metadata": {
      "title": string,
      "sourceRepositoryUrl": string,
      "containerName": string,
      "objectType": string,
      "createTime": string,
      "updateTime": string,
      "interactions": [
        {
          object (Interaction)
        }
      ],
      "contentLanguage": string,
      "mimeType": string,
      "searchQualityMetadata": {
        object (SearchQualityMetadata)
      },
      "keywords": [
        string
      ],
      "hash": string,
      "contextAttributes": [
        {
          object (ContextAttribute)
        }
      ]
    },
    "structuredData": {
      "object": {
        object (StructuredDataObject)
      },
      "hash": string
    },
    "content": {
      "contentFormat": enum (ItemContent.ContentFormat),
      "hash": string,

      // Union field content can be only one of the following:
      "inlineContent": string,
      "contentDataRef": {
        object (UploadItemRef)
      }
      // End of list of possible types for union field content.
    },
    "version": string,
    "status": {
      "code": enum (ItemStatus.Code),
      "processingErrors": [
        {
          object (ProcessingError)
        }
      ],
      "repositoryErrors": [
        {
          object (RepositoryError)
        }
      ]
    },
    "queue": string,
    "payload": string,
    "itemType": enum (Item.ItemType)
  },
  "connectorName": string,
  "mode": enum (RequestMode.Mode),
  "debugOptions": {
    object (DebugOptions)
  },
  "indexItemOptions": {
    object (IndexItemOptions)
  }
}
Alanlar
item.acl

object (ItemAcl)

Bu öğe için erişim kontrol listesi.

item.metadata

object (ItemMetadata)

Meta veri bilgileri.

item.structuredData

object (ItemStructuredData)

Veri kaynağının şemasında kayıtlı nesne tanımına uyması gereken öğenin yapılandırılmış verileri.

item.content

object (ItemContent)

Dizine eklenecek ve metin aranabilir hale getirilecek öğe içeriği.

item.version

string (bytes format)

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

object (ItemStatus)

Öğenin durumu. Yalnızca çıkış alanı.

item.queue

string

Bu öğenin ait olduğu sıraya ekleyin. En çok 100 karakter kullanılabilir.

item.payload

string (bytes format)

Bu öğe için ek durum bağlayıcısı depolayabilir. Maksimum uzunluk 10.000 bayttır.

base64 kodlu bir dize.

item.itemType

enum (Item.ItemType)

Bu öğenin türü.

connectorName

string

Bu çağrıyı yapan bağlayıcının adı.

Biçim: datasources/{sourceId}/connectors/{ID}

mode

enum (RequestMode.Mode)

Zorunlu. Bu istek için RequestMode.

debugOptions

object (DebugOptions)

Sık karşılaşılan hata ayıklama seçenekleri.

indexItemOptions

object (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

boolean

Dizin isteğinin, mevcut olmayan veya silinmiş Google Workspace ana hesaplarına izin verip vermeyeceğini belirtir.