- Tài nguyên: Mục
- ItemAcl
- ItemAcl.AclInheritanceType
- Chính
- ItemMetadata
- Hoạt động tương tác
- Interaction.InteractionType
- SearchQualityMetadata
- ContextAttribute
- ItemStructuredData
- StructuredDataObject
- 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ục
Biểu thị một đối tượng duy nhất là một 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 ( |
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 siêu dữ liệu. |
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. |
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. |
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ụ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 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. |
status |
Trạng thái của mặt hàng. Trường chỉ có đầu ra. |
queue |
Hàng đợi chứa mục này. Độ 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ữ cho mục này. Độ dài tối đa là 10.000 byte. Chuỗi được mã hoá base64. |
itemType |
Loại của 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 bài viết Liên kết ACL.
Biểu diễn dưới dạng JSON |
---|
{ "inheritAclFrom": string, "aclInheritanceType": enum ( |
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 năng kế thừa ACL chỉ 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ách thức thuận tiện để xoá các nhóm mục lớn. Việc xoá một ACL mẹ khỏi chỉ mục chỉ 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 ACL từ mục mẹ. Bạn phải luôn đặt giá trị này cùng với trường |
readers[] |
Danh sách các nguyên tắc được phép xem mục trong kết quả tìm kiếm. Không bắt buộc nếu kế thừa quyền từ một mục khác hoặc nếu mục không được hiển thị, chẳng hạn như |
deniedReaders[] |
Danh sách các nguyên tắc chủ chốt bị từ chối quyền truy cập vào mục trong kết quả tìm kiếm một cách rõ ràng. Mặc dù theo mặc định, các đối tượng chính bị từ chối quyền truy cập, 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 trình đọ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ặt hàng. Trường này không ảnh hưởng đến quyền truy cập vào tài liệu. Tuy nhiên, tính năng này sẽ giúp tăng thứ hạng một chút cho những mục 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ó tính năng kế thừa ACL vẫn có thể có ACL do các trường readers và deniedReaders của chính mục đó cung cấp. |
CHILD_OVERRIDE |
Trong trường hợp xung đột uỷ quyền, ACL của mục con sẽ xác định quyền đọc của mục đó. |
PARENT_OVERRIDE |
Trong trường hợp xung đột uỷ quyền, ACL của mục mẹ được chỉ định trong trường inheritAclFrom sẽ xác định quyền đọc. |
BOTH_PERMIT |
Quyền truy cập chỉ được cấp nếu cả mục này và mục mẹ được chỉ định trong trường inheritAclFrom đều cho phép quyền đọc. |
Chính
Tham chiếu đến một người dùng, nhóm hoặc miền.
Biểu diễn dưới dạng JSON |
---|
{ // Union field |
Trường | |
---|---|
Trường hợp hợp nhất
|
|
gsuitePrincipal |
Chủ thể này là một người dùng, nhóm hoặc miền Google Workspace. |
userResourceName |
Chủ thể 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 |
Nguyên tắc 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 nhóm theo định dạng sau: identitysources/{sourceId}/groups/{ID} |
ItemMetadata
Các trường siêu dữ liệu có sẵn cho mục.
Biểu diễn dưới dạng JSON |
---|
{ "title": string, "sourceRepositoryUrl": string, "containerName": string, "objectType": string, "createTime": string, "updateTime": string, "interactions": [ { object ( |
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 |
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 đến kết quả trên Tìm kiếm trên đám mây 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. Việc xoá mục vùng chứa sẽ dẫn đến việc tự động xoá mục này. Lưu ý: ACL không được kế thừa từ mục vùng chứa. Để cung cấp tính năng kế thừa ACL cho một mục, hãy sử dụng trường |
objectType |
Loại mặt hàng. 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à "tài liệu", thì các yêu cầu lập chỉ mục mặt hàng cho đối tượng thuộc loại đó phải đặt objectType thành "tài liệu". Độ dài tối đa là 256 ký tự. |
createTime |
Thời gian tạo mục trong kho lưu trữ nguồn. Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, có độ phân giải nano giây và tối đa 9 chữ số thập phân. Ví dụ: |
updateTime |
Thời gian sửa đổi gần đây nhất của mục trong kho lưu trữ nguồn. Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, có độ phân giải nano giây và tối đa 9 chữ số thập phân. Ví dụ: |
interactions[] |
Danh sách lượt tương tác với mặt hàng. Hoạt động tương tác được dùng để cải thiện chất lượng query.search nhưng không hiển thị cho người dùng cuối. Số lượng phần tử tối đa là 1000. |
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 gốc 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[] |
Từ khoá hoặc cụm từ bổ sung phải khớp với mặt hàng. 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 phương thức này với phương thức |
contextAttributes[] |
Một tập hợp các thuộc tính được đặt tên liên kết với mục. Bạn có thể sử dụng thông tin này để ảnh hưởng đến thứ hạng của mục 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
Biểu thị một lượt tương tác giữa người dùng và một mặt hàng.
Biểu diễn dưới dạng JSON |
---|
{ "type": enum ( |
Trường | |
---|---|
type |
|
principal |
Người dùng đã thực hiện hành động đối với mặt hàng. |
interactionTime |
Thời điểm người dùng thực hiện hành động đối với mặt hàng. Nếu một người dùng thực hiện nhiều hành động cùng loại, thì hệ thống chỉ ghi lại hành động gần đây nhất. Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, có độ phân giải nano giây và tối đa 9 chữ số thập phân. 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 |
Hành động tương tác này cho biết người dùng đã chỉnh sửa mặt hàng. |
SearchQualityMetadata
Siêu dữ liệu bổ sung về chất lượng tìm kiếm của mặt hàng.
Biểu diễn dưới dạng JSON |
---|
{ "quality": number } |
Trường | |
---|---|
quality |
Chỉ báo về chất lượng của mặt hàng, 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,0 (chất lượng thấp nhất) đến 1,0 (chất lượng cao nhất). Giá trị mặc định là 0.0. |
ContextAttribute
Một thuộc tính được đặt tên liên kết với một mục có thể được dùng để ảnh hưởng đến thứ hạng của mục đó 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 ] } |
Trường | |
---|---|
name |
Tên thuộc tính. Không được để trống. Độ dài tối đa là 32 ký tự. Tên phải bắt đầu bằng một chữ cái và chỉ có thể chứa chữ cái (A-Z, a-z) hoặc chữ số (0-9). Tên sẽ được chuẩn hoá (viết thường) trước khi so 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ị sẽ được chuẩn hoá (được viết thường) trước khi so khớp. |
ItemStructuredData
Các trường dữ liệu có cấu trúc có sẵn cho mục.
Biểu diễn dưới dạng JSON |
---|
{
"object": {
object ( |
Trường | |
---|---|
object |
Đối tượng dữ liệu có cấu trúc phải tuân thủ định nghĩa đố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 phương thức này với phương thức |
StructuredDataObject
Đố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 ( |
Trường | |
---|---|
properties[] |
Các thuộc tính của đối tượng. Số lượng phần tử tối đa là 1000. |
NamedProperty
Cặp tên-giá trị đã nhập cho dữ liệu có cấu trúc. Loại của 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 |
Trường | |
---|---|
name |
Tên của cơ sở lưu trú. Tên này phải tương ứng với tên của thuộc tính đã được đăng ký để xác định đối tượng trong giản đồ. Độ dài tối đa được phép cho thuộc tính này là 256 ký tự. |
Trường hợp hợp nhất 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 loại sau: |
|
integerValues |
|
doubleValues |
|
timestampValues |
|
booleanValue |
|
objectValues |
|
enumValues |
|
dateValues |
|
textValues |
|
htmlValues |
|
NamedProperty.IntegerValues
Danh sách các giá trị số nguyên.
Biểu diễn dưới dạng JSON |
---|
{ "values": [ string ] } |
Trường | |
---|---|
values[] |
|
NamedProperty.DoubleValues
Danh sách các giá trị double.
Biểu diễn dưới dạng JSON |
---|
{ "values": [ number ] } |
Trường | |
---|---|
values[] |
|
NamedProperty.TimestampValues
Danh sách các giá trị dấu thời gian.
Biểu diễn dưới dạng JSON |
---|
{ "values": [ string ] } |
Trường | |
---|---|
values[] |
Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, có độ phân giải nano giây và tối đa 9 chữ số thập phân. Ví dụ: |
NamedProperty.ObjectValues
Danh sách các giá trị đối tượng.
Biểu diễn dưới dạng JSON |
---|
{
"values": [
{
object ( |
Trường | |
---|---|
values[] |
|
NamedProperty.EnumValues
Danh sách các giá trị enum.
Biểu diễn dưới dạng JSON |
---|
{ "values": [ string ] } |
Trường | |
---|---|
values[] |
Độ dài tối đa được phép cho giá trị chuỗi là 32 ký tự. |
NamedProperty.DateValues
Danh sách các giá trị ngày.
Biểu diễn dưới dạng JSON |
---|
{
"values": [
{
object ( |
Trường | |
---|---|
values[] |
|
NamedProperty.TextValues
Danh sách các giá trị văn bản.
Biểu diễn dưới dạng JSON |
---|
{ "values": [ string ] } |
Trường | |
---|---|
values[] |
Độ dài tối đa được phép cho các giá trị văn bản là 2048 ký tự. |
NamedProperty.HtmlValues
Danh sách các giá trị html.
Biểu diễn dưới dạng JSON |
---|
{ "values": [ string ] } |
Trường | |
---|---|
values[] |
Độ dài tối đa được phép cho các 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. Chỉ cho phép chuỗi được mã hoá UTF-8 dưới dạng inlineContent
. Nếu nội dung được tải lên và không phải là tệp nhị phân, thì nội dung đó phải được mã hoá theo UTF-8.
Biểu diễn dưới dạng JSON |
---|
{ "contentFormat": enum ( |
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ể dùng với phương thức items.push để tính trạng thái đã sửa đổi. Độ dài tối đa là 2048 ký tự. |
Trường hợp hợp nhất
|
|
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ã nhận dạng tham chiếu của nội dung đã tải lên trước đó lên thông qua 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 tuỳ ý. |
RAW |
contentFormat là byte thô. |
UploadItemRef
Biểu thị tham chiếu phiên tải lên. Tham chiếu này được tạo thông qua upload method
. Thông tin tham khảo 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 mặt hàng có thể tham chiếu đế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 } |
Trường | |
---|---|
name |
Tên của nội dung tham chiếu. Độ dài tối đa là 2048 ký tự. |
ItemStatus
Thuộc tính 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 ( |
Trường | |
---|---|
code |
Mã trạng thái. |
processingErrors[] |
Thông tin chi tiết về lỗi trong trường hợp mục đó ở trạng thái LỖI. |
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 ( |
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 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 xảy ra trong quá trình máy chủ Tìm kiếm trên đám mây xử lý các mục. Một mục có thể chứa nhiều lỗi xử lý.
Enum | |
---|---|
PROCESSING_ERROR_CODE_UNSPECIFIED |
Chỉ nhập giá trị. 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 có định dạng không chính xác hoặc ở trạng thái không hợp lệ. FieldViolations chứa thêm thông tin chi tiết về vị trí xảy ra vấn đề. |
UNSUPPORTED_CONTENT_FORMAT |
Định dạng nội dung không được hỗ trợ. |
INDIRECT_BROKEN_ACL |
Các mục có thông tin ACL không đầy đủ do kế thừa các mục khác có ACL bị hỏng hoặc có các nhóm có phần tử con không được liên kết. |
ACL_CYCLE |
Biểu đồ kế thừa ACL tạo thành một chu kỳ. |
FieldViolation
Biểu diễn dưới dạng JSON |
---|
{ "field": string, "description": string } |
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 ( |
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. Độ dài tối đa được phép của thông báo là 8192 ký tự. |
RepositoryError.Type
Danh sách mã lỗi cho các vấn đề về 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á hạn mức. |
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, 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ủ kho 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 phân phát thông tin. Không thể tham chiếu các 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 ACL cho các mục khác 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 Item . |
|
Liệt kê tất cả hoặc một tập hợp con của Item resources . |
|
Khảo sát 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 tập hợp 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ò ý kiến và cập nhật sau. |
|
Huỷ đặt trước tất cả các mục khỏi hàng đợi, giúp tất cả các mục đó đủ đ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 mặt hàng lên. |