Method: indexing.datasources.items.index

Cập nhật ACL, siêu dữ liệu và nội dung Item. Phương thức này sẽ chèn Item nếu không có. Phương thức này không hỗ trợ cập nhật một phần. Những trường không có giá trị được cung cấp sẽ bị xoá khỏi chỉ mục Cloud Search.

API này yêu cầu tài khoản quản trị hoặc tài khoản dịch vụ để thực thi. Tài khoản dịch vụ được sử dụng là tài khoản được đưa vào danh sách trắng trong nguồn dữ liệu tương ứng.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
item.name

string

Tên của Mặt hàng. Định dạng: datasources/{sourceId}/items/{itemId}

Đây là trường bắt buộc. Độ dài tối đa là 1536 ký tự.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng 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)
  }
}
Trường
item.acl

object (ItemAcl)

Danh sách kiểm soát quyền truy cập cho mục này.

item.metadata

object (ItemMetadata)

Thông tin siêu dữ liệu.

item.structuredData

object (ItemStructuredData)

Dữ liệu có cấu trúc cho mặt hàng phải tuân thủ định nghĩa đối tượng đã đăng ký trong giản đồ cho nguồn dữ liệu.

item.content

object (ItemContent)

Nội dung của mặt hàng cần được lập chỉ mục và có thể tìm kiếm bằng văn bản.

item.version

string (bytes format)

Bắt buộc. Hệ thống lập chỉ mục lưu trữ phiên bản từ nguồn dữ liệu dưới dạng chuỗi byte và so sánh phiên bản Mặt hàng trong chỉ mục với phiên bản của Mặt hàng trong hàng đợi bằng cách sử dụng thứ tự từ vựng.

Tính năng Lập chỉ mục của Cloud Search sẽ không lập chỉ mục hoặc xoá bất kỳ mục nào trong hàng đợi có giá trị phiên bản nhỏ hơn hoặc bằng phiên bản của mục hiện được lập chỉ mục. Độ dài tối đa cho trường này là 1024 byte.

Để biết thông tin về mức độ ảnh hưởng của phiên bản mặt hàng đến quy trình xoá, hãy tham khảo bài viết Xử lý bản sửa đổi sau khi xoá thủ công.

Chuỗi được mã hoá base64.

item.status

object (ItemStatus)

Trạng thái của mặt hàng. Trường chỉ có đầu ra.

item.queue

string

Hàng đợi chứa mục này. Độ dài tối đa là 100 ký tự.

item.payload

string (bytes format)

Trình kết nối trạng thái bổ sung có thể lưu trữ cho mục này. Độ dài tối đa là 10.000 byte.

Chuỗi được mã hoá base64.

item.itemType

enum (Item.ItemType)

Loại của mục này.

connectorName

string

Tên của trình kết nối thực hiện lệnh gọi này.

Định dạng: datasources/{sourceId}/connectors/{ID}

mode

enum (RequestMode.Mode)

Bắt buộc. RequestMode cho yêu cầu này.

debugOptions

object (DebugOptions)

Các tuỳ chọn gỡ lỗi phổ biến.

indexItemOptions

object (IndexItemOptions)

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của Operation.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.

IndexItemOptions

Biểu diễn dưới dạng JSON
{
  "allowUnknownGsuitePrincipals": boolean
}
Trường
allowUnknownGsuitePrincipals

boolean

Chỉ định xem yêu cầu lập chỉ mục có cho phép các thực thể chính trong Google Workspace không tồn tại hoặc đã bị xoá hay không.