- Yêu cầu HTTP
- Tham số đường dẫn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi cấp phép
- IndexItemOptions
- Hãy làm thử!
Cập nhật Danh sách kiểm soát quyền truy cập (ACL), siêu dữ liệu và nội dung của Item
. Thao tác này sẽ chèn Item
nếu chưa có. Phương thức này không hỗ trợ 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 của Cloud Search.
Để thực thi API này, bạn cần có tài khoản quản trị viên hoặc tài khoản dịch vụ. Tài khoản dịch vụ được sử dụng là tài khoản được đưa vào 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
Tham số | |
---|---|
item.name |
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 ( |
Trường | |
---|---|
item.acl |
Danh sách kiểm soát quyền truy cập cho mục này. |
item.metadata |
Thông tin siêu dữ liệu. |
item.structuredData |
Dữ liệu có cấu trúc cho mục phải tuân thủ định nghĩa đối tượng đã đăng ký trong giản đồ cho nguồn dữ liệu. |
item.content |
Nội dung của mục sẽ được lập chỉ mục và giúp người dùng có thể tìm kiếm được văn bản. |
item.version |
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 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 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 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 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á theo cách thủ công. Chuỗi được mã hoá base64. |
item.status |
Trạng thái của mục. Trường chỉ có đầu ra. |
item.queue |
Hàng đợi chứa mục này. Độ dài tối đa là 100 ký tự. |
item.payload |
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à 10000 byte. Chuỗi được mã hoá base64. |
item.itemType |
Loại cho mục này. |
connectorName |
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 |
Bắt buộc. RequestMode cho yêu cầu này. |
debugOptions |
Các tuỳ chọn gỡ lỗi phổ biến. |
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 cấp phép
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 |
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. |