Method: indexing.datasources.items.index

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

API này yêu cầu quản trị viên 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ó trong danh sách cho phép 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

Các tham 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)
  }
}
Các 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 về siêu dữ liệu.
item.structuredData

object (ItemStructuredData)

Dữ liệu có cấu trúc cho mục phải phù hợp với định nghĩa đối tượng đã đăng ký trong giản đồ cho nguồn dữ liệu.
item.content

object (ItemContent)

Nội dung mục sẽ được lập chỉ mục và làm cho văn bản có thể tìm kiếm được.
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 của Mục trong chỉ mục với phiên bản của Mục đã xếp hàng đợi theo thứ tự từ vựng.

Tính năng Lập chỉ mục trong 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 thấp 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 của 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ục đến quá trình xoá, hãy tham khảo bài viết Xử lý các 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ỉ xuất.
item.queue

string

Thêm mục này vào danh sách chờ. Độ 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ữ 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 cho mục này.
connectorName

string

Tên của trình kết nối thực hiện cuộc 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
}
Các trường
allowUnknownGsuitePrincipals

boolean

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