- Tài nguyên: Mặt hàng
- ItemAcl
- ItemAcl.AclInheritanceType
- Hiệu trưởng
- ItemMetadata
- Lượt tương tác
- Interaction.InteractionType
- SearchQualityMetadata
- ContextAttribute
- ItemStructuredData
- StructuredDataObject (Đối tượng dữ liệu có cấu trúc)
- NamedProperty
- NamedProperty.IntegerValues
- NamedProperty.DoubleValues
- NamedProperty.TimestampValues
- NamedProperty.ObjectValues
- NamedProperty.EnumValues
- NamedProperty.DateValues
- NamedProperty.TextValues
- NamedProperty.HtmlValues
- ItemContent
- ItemContent.ContentFormat
- UploadItemRef
- ItemStatus
- ProcessingError
- ProcessingErrorCode
- FieldViolation
- RepositoryError
- RepositoryError.Type
- Item.ItemType
- Phương thức
Tài nguyên: Mặt hàng
Đại diện cho một đối tượng là mục trong chỉ mục tìm kiếm, chẳng hạn như tệp, thư mục hoặc bản ghi cơ sở dữ liệu.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "acl": { object ( |
Các trường | |
---|---|
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ự. |
acl |
Danh sách kiểm soát quyền truy cập cho mục này. |
metadata |
Thông tin về siêu dữ liệu. |
structuredData |
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. |
content |
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. |
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 đã 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. |
status |
Trạng thái của mặt hàng. Trường chỉ xuất. |
queue |
Thêm mục này vào danh sách chờ. Độ dài tối đa là 100 ký tự. |
payload |
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. |
itemType |
Loại cho mục này. |
ItemAcl
Thông tin về danh sách kiểm soát quyền truy cập cho mục. Để biết thêm thông tin, hãy xem ACL bản đồ.
Biểu diễn dưới dạng JSON |
---|
{ "inheritAclFrom": string, "aclInheritanceType": enum ( |
Các trường | |
---|---|
inheritAclFrom |
Tên của mục kế thừa Danh sách quyền truy cập (ACL). Lưu ý: Tính kế thừa ACL chỉ cung cấp quyền truy cập vào các mục con và không xác định mối quan hệ cấu trúc cũng như không cung cấp các cách thuận tiện để xóa các nhóm mục lớn. Việc xoá danh sách cha mẹ trong Danh sách kiểm soát quyền truy cập (ACL) khỏi chỉ mục chỉ làm thay đổi quyền truy cập của các mục con tham chiếu đến mục mẹ trong trường |
aclInheritanceType |
Đặt loại quy tắc truy cập để áp dụng khi một mục kế thừa Danh sách kiểm soát quyền truy cập (ACL) của mục đó từ tài khoản mẹ. Giá trị này phải luôn được đặt song song với trường |
readers[] |
Danh sách người chính được phép xem mục này trong kết quả tìm kiếm. Không bắt buộc nếu bạn kế thừa quyền từ một mục khác hoặc nếu mục đó không nhằm mục đích hiển thị, chẳng hạn như |
deniedReaders[] |
Danh sách người dùng chính từ chối quyền truy cập một cách rõ ràng vào mục đó trong kết quả tìm kiếm. Mặc dù đối tượng chính bị từ chối quyền truy cập theo mặc định, nhưng hãy sử dụng trình đọc bị từ chối để xử lý các trường hợp ngoại lệ và ghi đè danh sách người đọc được phép. Số lượng phần tử tối đa là 100. |
owners[] |
Không bắt buộc. Danh sách chủ sở hữu của mục. Trường này không liên quan đến quyền truy cập vào tài liệu. Tuy nhiên, việc này giúp tăng thứ hạng một chút cho các mặt hàng mà người dùng truy vấn là chủ sở hữu. Số lượng phần tử tối đa là 5. |
ItemAcl.AclInheritanceType
Các loại kế thừa ACL.
Enum | |
---|---|
NOT_APPLICABLE |
Giá trị mặc định khi mục này không kế thừa ACL. Sử dụng NOT_APPLICABLE khi inheritAclFrom trống. Một mục không có cơ chế kế thừa ACL vẫn có thể có các ACL do các trường readers và deniedReaders của riêng mục đó cung cấp. |
CHILD_OVERRIDE |
Trong xung đột uỷ quyền, Danh sách kiểm soát quyền truy cập (ACL) của mục con sẽ xác định quyền đọc của mục. |
PARENT_OVERRIDE |
Trong xung đột uỷ quyền, Danh sách kiểm soát quyền truy cập (ACL) của mục mẹ được chỉ định trong trường inheritAclFrom sẽ xác định quyền đọc. |
BOTH_PERMIT |
Chỉ được cấp quyền truy cập nếu mục này và mục mẹ được chỉ định trong trường inheritAclFrom đều cho phép quyền đọc. |
Hiệu trưởng
Tham chiếu đến người dùng, nhóm hoặc miền.
Biểu diễn dưới dạng JSON |
---|
{ // Union field |
Các trường | |
---|---|
Trường nhóm
|
|
gsuitePrincipal |
Người dùng chính này là một người dùng, nhóm hoặc miền Google Workspace. |
userResourceName |
Đối tượng chính này là một người dùng được xác định bằng danh tính bên ngoài. Trường tên phải chỉ định tên tài nguyên người dùng theo định dạng sau: Identitysources/{sourceId}/users/{ID} |
groupResourceName |
Đối tượng chính này là một nhóm được xác định bằng danh tính bên ngoài. Trường tên phải chỉ định tên tài nguyên của nhóm theo định dạng sau: Identitysources/{sourceId}/groups/{ID} |
ItemMetadata
Các trường siêu dữ liệu hiện có cho mặt hàng.
Biểu diễn dưới dạng JSON |
---|
{ "title": string, "sourceRepositoryUrl": string, "containerName": string, "objectType": string, "createTime": string, "updateTime": string, "interactions": [ { object ( |
Các trường | |
---|---|
title |
Tiêu đề của mặt hàng. Nếu được cung cấp, đây sẽ là tiêu đề hiển thị của kết quả query.search. Độ dài tối đa là 2048 ký tự. |
sourceRepositoryUrl |
Đường liên kết đến kho lưu trữ nguồn phân phát dữ liệu. Kết quả tìm kiếm sẽ áp dụng đường liên kết này cho tiêu đề. Khoảng trắng hoặc ký tự đặc biệt có thể khiến các đường liên kết trong kết quả của Cloud Seach kích hoạt thông báo chuyển hướng. Để tránh điều này, hãy mã hoá URL. Độ dài tối đa là 2048 ký tự. |
containerName |
Tên của vùng chứa cho mục này. Khi bạn xoá mục trong vùng chứa, mục này sẽ tự động bị xoá. Lưu ý: ACL không được kế thừa từ mục vùng chứa. Để cung cấp tính kế thừa ACL cho một mục, hãy sử dụng trường |
objectType |
Loại mục. Tên này phải tương ứng với tên của định nghĩa đối tượng trong giản đồ đã đăng ký cho nguồn dữ liệu. Ví dụ: nếu giản đồ cho nguồn dữ liệu chứa định nghĩa đối tượng có tên là "document", thì yêu cầu lập chỉ mục mục cho các đối tượng thuộc loại đó sẽ đặt objectType thành "document". Độ dài tối đa là 256 ký tự. |
createTime |
Thời điểm mục được tạo trong kho lưu trữ nguồn. Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: |
updateTime |
Thời gian mục được sửa đổi lần gần đây nhất trong kho lưu trữ nguồn. Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: |
interactions[] |
Danh sách lượt tương tác với mục. Hoạt động tương tác được dùng để cải thiện chất lượng query.search, nhưng không được hiển thị cho người dùng cuối. Số lượng phần tử tối đa là 1.000. |
contentLanguage |
Mã ngôn ngữ BCP-47 của mặt hàng, chẳng hạn như "en-US" hoặc "sr-Latn". Để biết thêm thông tin, hãy xem http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Độ dài tối đa là 32 ký tự. |
mimeType |
Loại MIME ban đầu của |
searchQualityMetadata |
Siêu dữ liệu bổ sung về chất lượng tìm kiếm của mặt hàng |
keywords[] |
Các từ khoá hoặc cụm từ bổ sung phù hợp với mục. Được sử dụng nội bộ cho nội dung do người dùng tạo. Số lượng phần tử tối đa là 100. Độ dài tối đa là 8192 ký tự. |
hash |
Giá trị băm do phương thức gọi API cung cấp. Bạn có thể sử dụng thuộc tính này với phương thức |
contextAttributes[] |
Một tập hợp các thuộc tính đã đặt tên liên kết với mục. Bạn có thể dùng tính năng này để tác động đến thứ hạng của mặt hàng dựa trên ngữ cảnh trong yêu cầu. Số lượng phần tử tối đa là 10. |
Tương tác
Thể hiện sự tương tác giữa người dùng và một mục.
Biểu diễn dưới dạng JSON |
---|
{ "type": enum ( |
Các trường | |
---|---|
type |
|
principal |
Người dùng đã thao tác trên mục. |
interactionTime |
Thời gian người dùng thực hiện thao tác trên mục. Nếu một người dùng có nhiều hành động cùng loại thì chỉ hành động gần đây nhất được ghi lại. Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: |
Interaction.InteractionType
Loại hoạt động mà người dùng đã thực hiện trên mặt hàng.
Enum | |
---|---|
UNSPECIFIED |
Giá trị không hợp lệ. |
VIEW |
Lượt tương tác này cho biết người dùng đã xem mặt hàng đó. |
EDIT |
Lượt tương tác này cho biết người dùng đã chỉnh sửa mục đó. |
SearchQualityMetadata
Siêu dữ liệu bổ sung về chất lượng tìm kiếm của mục.
Biểu diễn dưới dạng JSON |
---|
{ "quality": number } |
Các trường | |
---|---|
quality |
Chỉ báo về chất lượng của mục, dùng để ảnh hưởng đến chất lượng tìm kiếm. Giá trị phải nằm trong khoảng từ 0 (chất lượng thấp nhất) đến 1 (chất lượng cao nhất). Giá trị mặc định là 0.0. |
ContextAttribute
Thuộc tính được đặt tên liên kết với một mặt hàng và có thể dùng để tác động đến thứ hạng của mặt hàng dựa trên ngữ cảnh trong yêu cầu.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "values": [ string ] } |
Các trường | |
---|---|
name |
Tên của thuộc tính. Không được để trống trường này. Độ dài tối đa là 32 ký tự. Tên phải bắt đầu bằng chữ cái và chỉ được chứa chữ cái (A-Z, a-z) hoặc số (0-9). Tên này sẽ được chuẩn hoá (chữ thường) trước khi khớp. |
values[] |
Giá trị văn bản của thuộc tính. Số lượng phần tử tối đa là 10. Độ dài tối đa của một phần tử trong mảng là 32 ký tự. Giá trị này sẽ được chuẩn hoá (chữ thường) trước khi được so khớp. |
ItemStructuredData
Các trường dữ liệu có cấu trúc hiện có cho mục.
Biểu diễn dưới dạng JSON |
---|
{
"object": {
object ( |
Các trường | |
---|---|
object |
Đối tượng dữ liệu có cấu trúc phải tuân thủ định nghĩa về đối tượng đã đăng ký trong giản đồ cho nguồn dữ liệu. |
hash |
Giá trị băm do phương thức gọi API cung cấp. Bạn có thể sử dụng thuộc tính này với phương thức |
StructuredDataObject
Một đối tượng dữ liệu có cấu trúc bao gồm các thuộc tính được đặt tên.
Biểu diễn dưới dạng JSON |
---|
{
"properties": [
{
object ( |
Các trường | |
---|---|
properties[] |
Các thuộc tính của đối tượng. Số lượng phần tử tối đa là 1.000. |
NamedProperty
Một cặp tên-giá trị đã nhập cho dữ liệu có cấu trúc. Loại giá trị phải giống với loại đã đăng ký cho thuộc tính name
trong định nghĩa đối tượng của objectType
.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, // Union field |
Các trường | |
---|---|
name |
Tên của thuộc tính. Tên này phải tương ứng với tên của thuộc tính đã được đăng ký làm định nghĩa đối tượng trong giản đồ. Độ dài tối đa cho phép đối với tài sản này là 256 ký tự. |
Trường nhóm value . (Các) giá trị của thuộc tính được đặt tên. Xin lưu ý rằng một thuộc tính chỉ có thể chứa các giá trị thuộc một loại. value chỉ có thể là một trong những trạng thái sau đây: |
|
integerValues |
|
doubleValues |
|
timestampValues |
|
booleanValue |
|
objectValues |
|
enumValues |
|
dateValues |
|
textValues |
|
htmlValues |
|
NamedProperty.IntegerValues
Danh sách giá trị số nguyên.
Biểu diễn dưới dạng JSON |
---|
{ "values": [ string ] } |
Các trường | |
---|---|
values[] |
|
NamedProperty.DoubleValues
Danh sách giá trị kép.
Biểu diễn dưới dạng JSON |
---|
{ "values": [ number ] } |
Các trường | |
---|---|
values[] |
|
NamedProperty.TimestampValues
Danh sách giá trị dấu thời gian.
Biểu diễn dưới dạng JSON |
---|
{ "values": [ string ] } |
Các trường | |
---|---|
values[] |
Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: |
NamedProperty.ObjectValues
Danh sách giá trị của đối tượng.
Biểu diễn dưới dạng JSON |
---|
{
"values": [
{
object ( |
Các trường | |
---|---|
values[] |
|
NamedProperty.EnumValues
Danh sách giá trị enum.
Biểu diễn dưới dạng JSON |
---|
{ "values": [ string ] } |
Các trường | |
---|---|
values[] |
Độ dài tối đa cho phép đối với các giá trị chuỗi là 32 ký tự. |
NamedProperty.DateValues
Danh sách giá trị ngày.
Biểu diễn dưới dạng JSON |
---|
{
"values": [
{
object ( |
Các trường | |
---|---|
values[] |
|
NamedProperty.TextValues
Danh sách giá trị văn bản.
Biểu diễn dưới dạng JSON |
---|
{ "values": [ string ] } |
Các trường | |
---|---|
values[] |
Các giá trị văn bản được phép có độ dài tối đa là 2.048 ký tự. |
NamedProperty.HtmlValues
Danh sách giá trị html.
Biểu diễn dưới dạng JSON |
---|
{ "values": [ string ] } |
Các trường | |
---|---|
values[] |
Độ dài tối đa cho phép đối với giá trị html là 2048 ký tự. |
ItemContent
Nội dung của một mục sẽ được lập chỉ mục và hiển thị trên Cloud Search. Bạn chỉ được sử dụng các chuỗi được mã hoá UTF-8 dưới dạng inlineContent
. Nếu nội dung được tải lên mà không phải là tệp nhị phân, thì nội dung đó phải được mã hoá UTF-8.
Biểu diễn dưới dạng JSON |
---|
{ "contentFormat": enum ( |
Các trường | |
---|---|
contentFormat |
|
hash |
Thông tin băm do ứng dụng API tính toán và cung cấp cho nội dung. Có thể sử dụng với phương thức items.push để tính toán trạng thái đã sửa đổi. Độ dài tối đa là 2048 ký tự. |
Trường nhóm
|
|
inlineContent |
Nội dung được cung cấp cùng dòng trong phương thức cập nhật. Độ dài tối đa là 102400 byte (100 KiB). Chuỗi được mã hoá base64. |
contentDataRef |
Tải mã tham chiếu của một nội dung đã tải lên trước đó bằng phương thức ghi. |
ItemContent.ContentFormat
Định dạng của nội dung. Nếu định dạng là RAW, nội dung phải ở định dạng do mimeType
chỉ định.
Enum | |
---|---|
UNSPECIFIED |
Giá trị không hợp lệ. |
HTML |
contentFormat là HTML. |
TEXT |
contentFormat là văn bản tự do. |
RAW |
contentFormat là các byte thô. |
UploadItemRef
Đại diện cho tham chiếu phiên tải lên. Tệp đối chiếu này được tạo thông qua upload method
. Tệp đối chiếu này có hiệu lực trong 30 ngày kể từ ngày tạo. Việc cập nhật nội dung của mặt hàng có thể liên quan đến nội dung đã tải lên này thông qua contentDataRef
.
Biểu diễn dưới dạng JSON |
---|
{ "name": string } |
Các trường | |
---|---|
name |
Tên của tham chiếu nội dung. Độ dài tối đa là 2048 ký tự. |
ItemStatus
Cột này chứa trạng thái của mục và mọi lỗi.
Biểu diễn dưới dạng JSON |
---|
{ "code": enum ( |
Các trường | |
---|---|
code |
Mã trạng thái. |
processingErrors[] |
Chi tiết lỗi trong trường hợp mục ở trạng thái ERROR. |
repositoryErrors[] |
Lỗi kho lưu trữ do trình kết nối báo cáo. |
ProcessingError
Biểu diễn dưới dạng JSON |
---|
{ "code": enum ( |
Các trường | |
---|---|
code |
Mã lỗi cho biết bản chất của lỗi. |
errorMessage |
Nội dung mô tả lỗi. |
fieldViolations[] |
Trong trường hợp các trường của mặt hàng không hợp lệ, trường này sẽ chứa thông tin chi tiết về lỗi xác thực. |
ProcessingErrorCode
Mã cho biết lỗi gặp phải trong quá trình máy chủ Cloud Search xử lý các mục. Một mặt hàng có thể có nhiều lỗi xử lý.
Enum | |
---|---|
PROCESSING_ERROR_CODE_UNSPECIFIED |
Giá trị chỉ nhập. Sử dụng giá trị này trong Mục. |
MALFORMED_REQUEST |
ACL, siêu dữ liệu hoặc nội dung của mục không đúng định dạng hoặc ở trạng thái không hợp lệ. Trường vi phạm chứa thêm thông tin chi tiết về nơi xảy ra vấn đề. |
UNSUPPORTED_CONTENT_FORMAT |
Định dạng tổng số không được hỗ trợ. |
INDIRECT_BROKEN_ACL |
Các mục có thông tin ACL chưa hoàn chỉnh do kế thừa các mục khác với ACL bị hỏng hoặc có các nhóm có các mục con chưa được ánh xạ. |
ACL_CYCLE |
Biểu đồ kế thừa ACL đã tạo ra một chu kỳ. |
FieldViolation
Biểu diễn dưới dạng JSON |
---|
{ "field": string, "description": string } |
Các trường | |
---|---|
field |
Đường dẫn của trường có lỗi vi phạm. |
description |
Nội dung mô tả lỗi. |
RepositoryError
Lỗi khi trình kết nối đang giao tiếp với kho lưu trữ nguồn.
Biểu diễn dưới dạng JSON |
---|
{
"type": enum ( |
Các trường | |
---|---|
type |
Loại lỗi. |
httpStatusCode |
Mã lỗi. Khớp với định nghĩa của mã trạng thái HTTP. |
errorMessage |
Thông báo mô tả lỗi. Tin nhắn có độ dài tối đa cho phép là 8192 ký tự. |
RepositoryError.Type
Danh sách mã lỗi cho các bài tập giao tiếp với kho lưu trữ.
Enum | |
---|---|
UNKNOWN |
Lỗi không xác định. |
NETWORK_ERROR |
Máy chủ không xác định hoặc không thể truy cập. |
DNS_ERROR |
Sự cố DNS, chẳng hạn như máy chủ DNS không phản hồi. |
CONNECTION_ERROR |
Không thể kết nối với máy chủ kho lưu trữ. |
AUTHENTICATION_ERROR |
Không xác thực được do thông tin xác thực không chính xác. |
AUTHORIZATION_ERROR |
Tài khoản dịch vụ không được uỷ quyền cho kho lưu trữ. |
SERVER_ERROR |
Lỗi máy chủ kho lưu trữ. |
QUOTA_EXCEEDED |
Đã vượt quá dung lượng quy định. |
SERVICE_UNAVAILABLE |
Máy chủ tạm thời không hoạt động. |
CLIENT_ERROR |
Lỗi liên quan đến ứng dụng khách, chẳng hạn như yêu cầu không hợp lệ từ trình kết nối đến máy chủ lưu trữ. |
Item.ItemType
Enum | |
---|---|
UNSPECIFIED |
|
CONTENT_ITEM |
Một mục được lập chỉ mục chỉ nhằm mục đích cung cấp thông tin. Bạn không thể tham chiếu những mục này trong trường containerName hoặc inheritAclFrom . |
CONTAINER_ITEM |
Một mục được lập chỉ mục và có mục đích cung cấp các mục khác bằng ACL và/hoặc chứa các mục khác. |
VIRTUAL_CONTAINER_ITEM |
Một mục không được lập chỉ mục nhưng có cùng mục đích với CONTAINER_ITEM. |
Phương thức |
|
---|---|
|
Xoá Item resource cho tên tài nguyên đã chỉ định. |
|
Xoá tất cả các mục trong hàng đợi. |
|
Lấy Item resource theo tên mặt hàng. |
|
Cập nhật ACL, siêu dữ liệu và nội dung của Item . |
|
Liệt kê tất cả hoặc một tập hợp con của Item resources . |
|
Thăm dò các mục chưa được đặt trước từ hàng đợi lập chỉ mục và đánh dấu một nhóm là đặt trước, bắt đầu bằng các mục có dấu thời gian cũ nhất từ ItemStatus có mức độ ưu tiên cao nhất. |
|
Đẩy một mục vào hàng đợi để thăm dò và cập nhật sau. |
|
Hủy giữ lại tất cả các mục trong hàng đợi, giúp tất cả các mục này đủ điều kiện được thăm dò ý kiến. |
|
Tạo một phiên tải lên để tải nội dung của mặt hàng lên. |