Method: indexing.datasources.items.index

Item ACL'sini, meta verilerini ve içeriğini günceller. Mevcut değilse Item eklenir. Bu yöntem kısmi güncellemeleri desteklemez. Değer sağlanmayan alanlar Cloud Search dizininden silinir.

Bu API'nin çalıştırılması için bir 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

string

Öğenin adı. Biçim: datasources/{sourceId}/items/{itemId}

Bu alanının doldurulması zorunludur. Maksimum uzunluk 1.536 karakterdir.

İstek içeriği

İstek metni aşağıdaki yapıyla birlikte 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 öğenin erişim kontrol listesi.

item.metadata

object (ItemMetadata)

Meta veri bilgileri.

item.structuredData

object (ItemStructuredData)

Öğenin, veri kaynağının şemasında kayıtlı bir nesne tanımına uygun olması gereken yapılandırılmış verileri.

item.content

object (ItemContent)

Dizine eklenecek ve metin olarak 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 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.

item.status

object (ItemStatus)

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

item.queue

string

Bu öğenin ait olduğu sıra. Maksimum uzunluk 100 karakterdir.

item.payload

string (bytes format)

Ek durum bağlayıcısı bu öğe için depolama alanı sağlayabilir. 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 kullanı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ılavuzuna bakın.

IndexItemOptions

JSON gösterimi
{
  "allowUnknownGsuitePrincipals": boolean
}
Alanlar
allowUnknownGsuitePrincipals

boolean

Dizin isteği için var olmayan veya silinmiş Google Workspace kimliklerine izin verilip verilmeyeceğini belirtir.