- משאב: פריט
- ItemAcl
- ItemAcl.AclInheritanceType
- Principal
- ItemMetadata
- אינטראקציה
- 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
- שיטות
משאב: פריט
מייצג אובייקט יחיד שהוא פריט באינדקס החיפוש, כמו קובץ, תיקייה או רשומה במסד נתונים.
ייצוג ב-JSON |
---|
{ "name": string, "acl": { object ( |
שדות | |
---|---|
name |
שם הפריט. פורמט: datasources/{sourceId}/items/{itemId} יש למלא שדה זה. האורך המקסימלי הוא 1,536 תווים. |
acl |
רשימת בקרת הגישה של הפריט הזה. |
metadata |
פרטי המטא-נתונים. |
structuredData |
הנתונים המובְנים של הפריט, שצריכים להתאים להגדרת אובייקט רשום בסכימה של מקור הנתונים. |
content |
תוכן הפריט שרוצים להוסיף לאינדקס ולאפשר לחפש את הטקסט שלו. |
version |
חובה. מערכת ההוספה לאינדקס שומרת את הגרסה ממקור הנתונים כמחרוזת בייטים ומשוותת בין גרסת הפריט שנוספה לאינדקס לבין גרסת הפריט שבתור באמצעות סדר לקסיקלי. המערכת של הוספה לאינדקס של Cloud Search לא תוסיף לאינדקס או תמחק פריט כלשהו בתור עם ערך גרסה שקטן או שווה לגרסה של הפריט שנוסף כרגע לאינדקס. האורך המקסימלי של השדה הזה הוא 1,024 בייטים. מידע על האופן שבו גרסת הפריט משפיעה על תהליך המחיקה זמין במאמר טיפול בגרסאות לאחר מחיקה ידנית. מחרוזת בקידוד Base64. |
status |
סטטוס הפריט. שדה פלט בלבד. |
queue |
התור שאליו הפריט הזה שייך. האורך המקסימלי הוא 100 תווים. |
payload |
מחבר מצב נוסף יכול לאחסן את הפריט הזה. האורך המקסימלי הוא 10,000 בייטים. מחרוזת בקידוד Base64. |
itemType |
הסוג של הפריט הזה. |
ItemAcl
פרטי רשימת בקרת הגישה של הפריט. מידע נוסף זמין במאמר מיפוי רשימות ACL.
ייצוג ב-JSON |
---|
{ "inheritAclFrom": string, "aclInheritanceType": enum ( |
שדות | |
---|---|
inheritAclFrom |
השם של הפריט שממנו יירשו את רשימת הרשאות הגישה (ACL). הערה: ירושה של רשימות ACL מספקת רק הרשאות גישה לפריטי הצאצאים, ולא מגדירה יחסי מבנה או מספקת דרכים נוחות למחיקת קבוצות גדולות של פריטים. מחיקת הורה של ACL מהאינדקס משנה רק את הרשאות הגישה של פריטי הצאצא שמפנים להורה בשדה |
aclInheritanceType |
הגדרת סוג כללי הגישה שחלים כשפריט יורש את רשימת ה-ACL שלו מהורה. תמיד צריך להגדיר את השדה הזה יחד עם השדה |
readers[] |
רשימה של חשבונות משתמשים שמותר להם לראות את הפריט בתוצאות החיפוש. אופציונלי אם המערכת יורשת הרשאות מפריט אחר או אם הפריט לא מיועד להיות גלוי, למשל |
deniedReaders[] |
רשימה של חשבונות משתמשים שנדחתה להם באופן מפורש הגישה לפריט בתוצאות החיפוש. כברירת מחדל, חשבונות משתמשים לא מקבלים גישה, אבל אפשר להשתמש בקוראים שמוגדרים לדחייה כדי לטפל בהחרגות ולעקוף את רשימת הקוראים המורשים. המספר המקסימלי של רכיבים הוא 100. |
owners[] |
זה שינוי אופציונלי. רשימת הבעלים של הפריט. השדה הזה לא משפיע על הרשאות הגישה למסמכים. עם זאת, יש לו השפעה קלה על דירוג הפריטים שבהם המשתמש ששלח את השאילתה הוא הבעלים. המספר המקסימלי של רכיבים הוא 5. |
ItemAcl.AclInheritanceType
סוגי הירושה של רשימות ACL.
טיפוסים בני מנייה (enum) | |
---|---|
NOT_APPLICABLE |
ערך ברירת המחדל כשהפריט הזה לא יורש רשימת ACL. משתמשים בערך NOT_APPLICABLE כשהשדה inheritAclFrom ריק. לפריט ללא ירושה של רשימות ACL עדיין יכולות להיות רשימות ACL שמסופקות על ידי השדות readers ו-deniedReaders שלו. |
CHILD_OVERRIDE |
במהלך התנגשויות הרשאה, רשימת ה-ACL של פריט הצאצא קובעת את הרשאת הקריאה שלו. |
PARENT_OVERRIDE |
במהלך מחלוקת לגבי הרשאה, רשימת ה-ACL של פריט ההורה שצוין בשדה inheritAclFrom קובעת את הרשאת הקריאה. |
BOTH_PERMIT |
הגישה ניתנת רק אם הפריט הזה והפריט ההורה שצוין בשדה inheritAclFrom מאפשרים גישה לקריאה. |
חשבון משתמש
הפניה למשתמש, לקבוצה או לדומיין.
ייצוג ב-JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה האיחוד הערך של |
|
gsuitePrincipal |
חשבון המשתמש הזה הוא משתמש, קבוצה או דומיין ב-Google Workspace. |
userResourceName |
חשבון המשתמש הזה הוא משתמש שזוהה באמצעות זהות חיצונית. בשדה name צריך לציין את שם משאב המשתמש בפורמט הזה: identitysources/{sourceId}/users/{ID} |
groupResourceName |
חשבון המשתמש הזה הוא קבוצה שזוהתה באמצעות זהות חיצונית. בשדה name צריך לציין את שם המשאב של הקבוצה בפורמט הזה: identitysources/{sourceId}/groups/{ID} |
ItemMetadata
שדות המטא-נתונים הזמינים לפריט.
ייצוג ב-JSON |
---|
{ "title": string, "sourceRepositoryUrl": string, "containerName": string, "objectType": string, "createTime": string, "updateTime": string, "interactions": [ { object ( |
שדות | |
---|---|
title |
שם הפריט. אם הערך הזה יצוין, הוא ישמש ככותרת של תוצאת החיפוש של השאילתה. האורך המקסימלי הוא 2048 תווים. |
sourceRepositoryUrl |
קישור למאגר המקור שממנו הנתונים מגיעים. תוצאות החיפוש יכללו את הקישור הזה לכותרת. רווחים או תווים מיוחדים עלולים לגרום לכך שקישורים לתוצאות של חיפוש ב-Cloud יפעילו הודעה על הפניה אוטומטית. כדי למנוע זאת, צריך לקודד את כתובת ה-URL. האורך המקסימלי הוא 2048 תווים. |
containerName |
השם של המאגר של הפריט הזה. מחיקת הפריט שבקונטיינר תוביל למחיקה אוטומטית של הפריט הזה. הערה: רשימות ACL לא עוברות בירושה מפריט מאגר. כדי לספק ירושה של ACL לפריט, משתמשים בשדה |
objectType |
סוג הפריט. השם הזה צריך להתאים לשם של הגדרת אובייקט בסכימה שרשומה למקור הנתונים. לדוגמה, אם הסכימה של מקור הנתונים מכילה הגדרת אובייקט בשם 'document', בבקשות להוספת פריטים לאינדקס של אובייקטים מהסוג הזה צריך להגדיר את objectType לערך 'document'. האורך המקסימלי הוא 256 תווים. |
createTime |
השעה שבה הפריט נוצר במאגר המקור. חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
updateTime |
השעה שבה הפריט השתנה לאחרונה במאגר המקור. חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
interactions[] |
רשימה של אינטראקציות עם הפריט. האינטראקציות משמשות לשיפור האיכות של query.search, אבל הן לא גלויות למשתמשי הקצה. המספר המקסימלי של רכיבים הוא 1,000. |
contentLanguage |
קוד השפה BCP-47 של הפריט, למשל 'en-US' או 'sr-Latn'. מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. האורך המקסימלי הוא 32 תווים. |
mimeType |
סוג ה-MIME המקורי של |
searchQualityMetadata |
מטא-נתונים נוספים של איכות החיפוש של הפריט |
keywords[] |
מילות מפתח או ביטויים נוספים שצריכים להתאים לפריט. משמש באופן פנימי לתוכן שנוצר על ידי משתמשים. המספר המקסימלי של רכיבים הוא 100. האורך המקסימלי הוא 8,192 תווים. |
hash |
ערך גיבוב שסופק על ידי מבצע הקריאה ל-API. אפשר להשתמש בזה בשילוב עם השיטה |
contextAttributes[] |
קבוצה של מאפיינים עם שם שמשויכים לפריט. אפשר להשתמש באפשרות הזו כדי להשפיע על הדירוג של הפריט על סמך ההקשר בבקשה. המספר המקסימלי של רכיבים הוא 10. |
אינטראקציה
מייצג אינטראקציה בין משתמש לבין פריט.
ייצוג ב-JSON |
---|
{ "type": enum ( |
שדות | |
---|---|
type |
|
principal |
המשתמש שביצע פעולה לגבי הפריט. |
interactionTime |
השעה שבה המשתמש ביצע פעולה לגבי הפריט. אם יש כמה פעולות מאותו סוג לגבי משתמש יחיד, רק הפעולה האחרונה מתועדת. חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
Interaction.InteractionType
סוג הפעילות שהמשתמש ביצע בפריט.
טיפוסים בני מנייה (enum) | |
---|---|
UNSPECIFIED |
ערך לא חוקי. |
VIEW |
האינטראקציה הזו מציינת שהמשתמש צפה בפריט. |
EDIT |
האינטראקציה הזו מציינת שהמשתמש ערך את הפריט. |
SearchQualityMetadata
מטא-נתונים נוספים של איכות החיפוש של הפריט.
ייצוג ב-JSON |
---|
{ "quality": number } |
שדות | |
---|---|
quality |
אינדיקציה לאיכות הפריט, שמשמשת להשפעה על איכות החיפוש. הערך צריך להיות בין 0.0 (איכות נמוכה ביותר) ל-1.0 (איכות גבוהה ביותר). ערך ברירת המחדל הוא 0.0. |
ContextAttribute
מאפיין בעל שם שמשויך לפריט, שאפשר להשתמש בו כדי להשפיע על הדירוג של הפריט על סמך ההקשר בבקשה.
ייצוג ב-JSON |
---|
{ "name": string, "values": [ string ] } |
שדות | |
---|---|
name |
שם המאפיין. השדה לא יכול להיות ריק. האורך המקסימלי הוא 32 תווים. השם חייב להתחיל באות, והוא יכול להכיל רק אותיות (A-Z, a-z) או מספרים (0-9). השם ינורמליז (באותיות קטנות) לפני ההתאמה. |
values[] |
ערכי הטקסט של המאפיין. המספר המקסימלי של רכיבים הוא 10. האורך המקסימלי של רכיב במערך הוא 32 תווים. הערך ינורמלי (באותיות קטנות) לפני ההתאמה. |
ItemStructuredData
שדות הנתונים המובְנים שזמינים לפריט.
ייצוג ב-JSON |
---|
{
"object": {
object ( |
שדות | |
---|---|
object |
אובייקט הנתונים המובְנים שצריך להתאים להגדרת אובייקט רשום בסכימה של מקור הנתונים. |
hash |
ערך גיבוב שסופק על ידי מבצע הקריאה ל-API. אפשר להשתמש בזה בשילוב עם השיטה |
StructuredDataObject
אובייקט של נתונים מובְנים שמורכב מנכסים עם שמות.
ייצוג ב-JSON |
---|
{
"properties": [
{
object ( |
שדות | |
---|---|
properties[] |
המאפיינים של האובייקט. המספר המקסימלי של רכיבים הוא 1,000. |
NamedProperty
צמד שם-ערך מוגדר לנתונים מובְנים. הסוג של הערך צריך להיות זהה לסוג הרשום של המאפיין name
בהגדרת האובייקט של objectType
.
ייצוג ב-JSON |
---|
{ "name": string, // Union field |
שדות | |
---|---|
name |
שם הנכס. השם הזה צריך להתאים לשם הנכס שרשום להגדרת האובייקט בהסכימה. האורך המקסימלי המותר למאפיין הזה הוא 256 תווים. |
שדה האיחוד value . הערכים של המאפיין הנקרא. חשוב לזכור שנכס יכול להכיל ערכים מסוג אחד בלבד. הערך של value יכול להיות רק אחת מהאפשרויות הבאות: |
|
integerValues |
|
doubleValues |
|
timestampValues |
|
booleanValue |
|
objectValues |
|
enumValues |
|
dateValues |
|
textValues |
|
htmlValues |
|
NamedProperty.IntegerValues
רשימה של ערכים שלמים.
ייצוג ב-JSON |
---|
{ "values": [ string ] } |
שדות | |
---|---|
values[] |
|
NamedProperty.DoubleValues
רשימה של ערכים כפולים.
ייצוג ב-JSON |
---|
{ "values": [ number ] } |
שדות | |
---|---|
values[] |
|
NamedProperty.TimestampValues
רשימה של ערכים של חותמות זמן.
ייצוג ב-JSON |
---|
{ "values": [ string ] } |
שדות | |
---|---|
values[] |
חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
NamedProperty.ObjectValues
רשימה של ערכי אובייקטים.
ייצוג ב-JSON |
---|
{
"values": [
{
object ( |
שדות | |
---|---|
values[] |
|
NamedProperty.EnumValues
רשימה של ערכים של enum.
ייצוג ב-JSON |
---|
{ "values": [ string ] } |
שדות | |
---|---|
values[] |
האורך המקסימלי המותר לערכים של מחרוזות הוא 32 תווים. |
NamedProperty.DateValues
רשימה של ערכים של תאריכים.
ייצוג ב-JSON |
---|
{
"values": [
{
object ( |
שדות | |
---|---|
values[] |
|
NamedProperty.TextValues
רשימה של ערכי טקסט.
ייצוג ב-JSON |
---|
{ "values": [ string ] } |
שדות | |
---|---|
values[] |
האורך המקסימלי המותר של ערכי טקסט הוא 2048 תווים. |
NamedProperty.HtmlValues
רשימה של ערכי HTML.
ייצוג ב-JSON |
---|
{ "values": [ string ] } |
שדות | |
---|---|
values[] |
האורך המקסימלי המותר לערכים של html הוא 2048 תווים. |
ItemContent
התוכן של פריט שרוצים להוסיף לאינדקס ולהציג ב-Cloud Search. רק מחרוזות בקידוד UTF-8 מותרות בתור inlineContent
. אם התוכן מוריד ולא בינארי, הוא חייב להיות בקידוד UTF-8.
ייצוג ב-JSON |
---|
{ "contentFormat": enum ( |
שדות | |
---|---|
contentFormat |
|
hash |
פרטי גיבוב שחושבו ונשלחו על ידי לקוח ה-API לתוכן. אפשר להשתמש בו בשילוב עם השיטה items.push כדי לחשב את המצב המשופר. האורך המקסימלי הוא 2048 תווים. |
שדה האיחוד הערך של |
|
inlineContent |
תוכן שסופק בתוך שיטת העדכון. האורך המקסימלי הוא 102,400 בייטים (100KiB). מחרוזת בקידוד Base64. |
contentDataRef |
העלאת מזהה ההפניה של תוכן שהועלה בעבר באמצעות שיטת הכתיבה. |
ItemContent.ContentFormat
הפורמט של התוכן. אם הפורמט הוא RAW, התוכן צריך להיות בפורמט שצוין ב-mimeType
.
טיפוסים בני מנייה (enum) | |
---|---|
UNSPECIFIED |
ערך לא חוקי. |
HTML |
הערך של contentFormat הוא HTML. |
TEXT |
contentFormat הוא טקסט חופשי. |
RAW |
contentFormat הוא בייטים גולמיים. |
UploadItemRef
מייצג הפניה לסשן העלאה. קובץ העזר הזה נוצר באמצעות upload method
. ההפניה הזו תקפה למשך 30 יום לאחר היצירה שלה. עדכון תוכן הפריט עשוי להתייחס לתוכן הזה שהועבר באמצעות contentDataRef
.
ייצוג ב-JSON |
---|
{ "name": string } |
שדות | |
---|---|
name |
השם של קובץ העזר של התוכן. האורך המקסימלי הוא 2048 תווים. |
ItemStatus
השדה הזה מכיל את סטטוס הפריט ואת כל השגיאות.
ייצוג ב-JSON |
---|
{ "code": enum ( |
שדות | |
---|---|
code |
קוד הסטטוס. |
processingErrors[] |
פרטי השגיאה במקרה שהפריט נמצא בסטטוס ERROR. |
repositoryErrors[] |
שגיאה במאגר שדווחה על ידי המחבר. |
ProcessingError
ייצוג ב-JSON |
---|
{ "code": enum ( |
שדות | |
---|---|
code |
קוד שגיאה שמציין את אופי השגיאה. |
errorMessage |
תיאור השגיאה. |
fieldViolations[] |
אם שדות הפריט לא תקינים, השדה הזה מכיל את הפרטים על שגיאות האימות. |
ProcessingErrorCode
קודים שמציינים את השגיאה שנתקלה בה במהלך עיבוד הפריטים על ידי שרת Cloud Search. פריט אחד עשוי להכיל כמה שגיאות עיבוד.
טיפוסים בני מנייה (enum) | |
---|---|
PROCESSING_ERROR_CODE_UNSPECIFIED |
מזינים רק ערך. משתמשים בערך הזה בקטע 'פריטים'. |
MALFORMED_REQUEST |
הפורמט של ACL, המטא-נתונים או התוכן של הפריט שגוי או שהם במצב לא תקין. השדה FieldViolations מכיל פרטים נוספים על מיקום הבעיה. |
UNSUPPORTED_CONTENT_FORMAT |
פורמט התוכן לא נתמך. |
INDIRECT_BROKEN_ACL |
פריטים עם פרטי ACL חלקיים בגלל שהם יורשים פריטים אחרים עם רשימת ACL שבורה, או שיש להם קבוצות עם צאצאים שלא מותאמים למפה. |
ACL_CYCLE |
גרף הירושה של ACL יצר מחזור. |
FieldViolation
ייצוג ב-JSON |
---|
{ "field": string, "description": string } |
שדות | |
---|---|
field |
הנתיב של השדה עם ההפרה. |
description |
תיאור השגיאה. |
RepositoryError
שגיאות במהלך התקשורת של המחבר למאגר המקור.
ייצוג ב-JSON |
---|
{
"type": enum ( |
שדות | |
---|---|
type |
סוג השגיאה. |
httpStatusCode |
קודי שגיאה. תואם להגדרה של קודי מצב HTTP. |
errorMessage |
הודעה שמתארת את השגיאה. האורך המרבי המותר של ההודעה הוא 8,192 תווים. |
RepositoryError.Type
רשימה של קודי שגיאה לבעיות תקשורת עם המאגר.
טיפוסים בני מנייה (enum) | |
---|---|
UNKNOWN |
שגיאה לא ידועה. |
NETWORK_ERROR |
מארח לא ידוע או לא נגיש. |
DNS_ERROR |
בעיה ב-DNS, למשל שרת ה-DNS לא מגיב. |
CONNECTION_ERROR |
לא ניתן להתחבר לשרת המאגר. |
AUTHENTICATION_ERROR |
האימות נכשל בגלל פרטי כניסה שגויים. |
AUTHORIZATION_ERROR |
חשבון השירות לא מורשה למאגר. |
SERVER_ERROR |
שגיאה בשרת המאגר. |
QUOTA_EXCEEDED |
חריגה מהמכסה. |
SERVICE_UNAVAILABLE |
השרת לא זמין כרגע. |
CLIENT_ERROR |
שגיאה שקשורה ללקוח, כמו בקשה לא חוקית מהמחבר לשרת המאגר. |
Item.ItemType
טיפוסים בני מנייה (enum) | |
---|---|
UNSPECIFIED |
|
CONTENT_ITEM |
פריט שנוסף לאינדקס למטרה היחידה של הצגת מידע. אי אפשר להפנות לפריטים האלה בשדות containerName או inheritAclFrom . |
CONTAINER_ITEM |
פריט שמתווסף לאינדקס ומטרתו לספק לפריטים אחרים רשימות ACL ו/או להכיל פריטים אחרים. |
VIRTUAL_CONTAINER_ITEM |
פריט שלא נוסף לאינדקס, אבל למעט זאת יש לו את אותו מטרה כמו CONTAINER_ITEM. |
Methods |
|
---|---|
|
מחיקה של Item resource בשם המשאב שצוין. |
|
מחיקה של כל הפריטים בתור. |
|
אחזור של Item resource לפי שם הפריט. |
|
עדכון ה-ACL, המטא-נתונים והתוכן של Item . |
|
הצגת כל הרשימה או קבוצת משנה של Item resources . |
|
הבדיקה מחפשת פריטים שלא הוקצו מתוך תור ההוספה לאינדקס ומסמנת קבוצה כ'הוקצה', החל מהפריטים עם חותמת הזמן הישנה ביותר מהעדיפות הגבוהה ביותר ItemStatus . |
|
דחיפת פריט לתור לצורך בדיקה ועדכון מאוחר יותר. |
|
מבטלת את ההזמנה של כל הפריטים בתור, כך שכל הפריטים יהיו כשירים לבדיקה. |
|
יצירת סשן העלאה להעלאת תוכן של פריט. |