Method: indexing.datasources.items.index

Memperbarui ACL, metadata, dan konten Item. Tindakan ini akan menyisipkan Item jika tidak ada. Metode ini tidak mendukung pembaruan sebagian. Kolom tanpa nilai yang diberikan akan dihapus di indeks Cloud Search.

API ini memerlukan admin atau akun layanan untuk dieksekusi. Akun layanan yang digunakan adalah akun yang diizinkan di sumber data yang sesuai.

Permintaan HTTP

POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:index

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
item.name

string

Nama Item. Format: datasources/{sourceId}/items/{itemId}

Bidang ini harus diisi. Panjang maksimumnya adalah 1.536 karakter.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "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)
  }
}
Kolom
item.acl

object (ItemAcl)

Daftar kontrol akses untuk item ini.
item.metadata

object (ItemMetadata)

Informasi metadata.
item.structuredData

object (ItemStructuredData)

Data terstruktur untuk item yang harus sesuai dengan definisi objek terdaftar dalam skema untuk sumber data.
item.content

object (ItemContent)

Konten item yang akan diindeks dan teksnya dapat ditelusuri.
item.version

string (bytes format)

Wajib. Sistem pengindeksan menyimpan versi dari sumber data sebagai string byte dan membandingkan versi Item dalam indeks dengan versi Item yang diantrekan menggunakan pengurutan leksikografis.

Pengindeksan Cloud Search tidak akan mengindeks atau menghapus item dalam antrean dengan nilai versi yang kurang dari atau sama dengan versi item yang saat ini diindeks. Panjang maksimum kolom ini adalah 1024 byte.

Untuk informasi tentang pengaruh versi item terhadap proses penghapusan, lihat Menangani revisi setelah penghapusan manual.

String berenkode base64.
item.status

object (ItemStatus)

Status item. Kolom khusus output.
item.queue

string

Antrean yang berisi item ini. Panjang maksimumnya adalah 100 karakter.
item.payload

string (bytes format)

Konektor status tambahan dapat menyimpan untuk item ini. Panjang maksimum adalah 10.000 byte.

String berenkode base64.
item.itemType

enum (Item.ItemType)

Jenis untuk item ini.
connectorName

string

Nama konektor yang melakukan panggilan ini.

Format: datasources/{sourceId}/connectors/{ID}
mode

enum (RequestMode.Mode)

Wajib. RequestMode untuk permintaan ini.
debugOptions

object (DebugOptions)

Opsi debug umum.
indexItemOptions

object (IndexItemOptions)

Isi respons

Jika berhasil, isi respons memuat instance Operation.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud_search.indexing
  • https://www.googleapis.com/auth/cloud_search

Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.

IndexItemOptions

Representasi JSON 
{
  "allowUnknownGsuitePrincipals": boolean
}
Kolom
allowUnknownGsuitePrincipals

boolean

Menentukan apakah permintaan indeks harus mengizinkan akun utama Google Workspace yang tidak ada atau dihapus.