- Yêu cầu HTTP
- Thông 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 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 |
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ặ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 |
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 |
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 |
Trạng thái của mặt hàng. 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à 10.000 byte. Chuỗi được mã hoá base64. |
item.itemType |
Loại của mục này. |
connectorName |
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 |
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 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 |
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. |