- משאב: פריט
- ItemAcl
- ItemAcl.AclInheritanceType
- חשבון משתמש
- 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.
טיפוסים בני מנייה (enums) | |
---|---|
NOT_APPLICABLE |
ערך ברירת המחדל כאשר הפריט הזה לא יורש רשימת ACL. אם השדה inheritAclFrom ריק, יש להשתמש בפונקציה NOT_APPLICABLE. לפריט ללא ירושה של רשימות בקרת גישה יכולות להיות עדיין רשימות בקרת גישה שסופקו על ידי השדות readers ו-deniedReaders שלו. |
CHILD_OVERRIDE |
במהלך התנגשות בין הרשאות, ה-ACL של פריט הצאצא קובעת את גישת הקריאה שלו. |
PARENT_OVERRIDE |
במהלך התנגשות בין הרשאות, ה-ACL של פריט ההורה המצוין בשדה inheritAclFrom קובעת את גישת הקריאה. |
BOTH_PERMIT |
הגישה תינתן רק אם הפריט הזה ופריט ההורה שצוין בשדה inheritAclFrom מתירים גישת קריאה. |
המשתמש
הפניה למשתמש, לקבוצה או לדומיין.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד הערך של |
|
gsuitePrincipal |
חשבון המשתמש הזה הוא משתמש, קבוצה או דומיין ב-Google Workspace. |
userResourceName |
חשבון המשתמש הזה הוא משתמש שזוהה באמצעות זהות חיצונית. שדה השם חייב לציין את השם של משאב המשתמש בפורמט הבא: Identitysources/{sourceId}/users/{ID} |
groupResourceName |
חשבון המשתמש הזה הוא קבוצה שזוהתה באמצעות זהות חיצונית. שדה השם חייב לציין את השם של משאב הקבוצה בפורמט הזה: Identitysources/{sourceId}/groups/{ID} |
ItemMetadata
שדות מטא-נתונים זמינים של הפריט.
ייצוג JSON |
---|
{ "title": string, "sourceRepositoryUrl": string, "containerName": string, "objectType": string, "createTime": string, "updateTime": string, "interactions": [ { object ( |
שדות | |
---|---|
title |
שם הפריט. אם מזינים, זו תהיה הכותרת המוצגת של תוצאת ה-query.search. האורך המקסימלי הוא 2,048 תווים. |
sourceRepositoryUrl |
קישור למאגר המקור שמציג את הנתונים. תוצאות החיפוש מחילה את הקישור הזה על הכותרת. רווחים לבנים או תווים מיוחדים עלולים לגרום לקישורי תוצאות של Cloud Seach להפעיל הודעה על הפניה מחדש. כדי להימנע מכך, יש לקודד את כתובת ה-URL. האורך המקסימלי הוא 2,048 תווים. |
containerName |
שם המאגר של הפריט הזה. מחיקת הפריט מהמאגר תגרום למחיקה אוטומטית של הפריט הזה. הערה: רשימות ACL אינן עוברות בירושה מפריט מכיל. כדי לספק ירושה של ACL לפריט, יש להשתמש בשדה |
objectType |
סוג הפריט. הוא צריך להיות תואם לשם של הגדרת אובייקט בסכימה שרשומה עבור מקור הנתונים. לדוגמה, אם הסכימה של מקור הנתונים מכילה הגדרת אובייקט בשם 'document', בבקשות להוספת פריטים לאינדקס עבור אובייקטים מסוג זה צריך להגדיר את objectType ל-'document'. האורך המקסימלי הוא 256 תווים. |
createTime |
השעה שבה הפריט נוצר במאגר המקור. חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
updateTime |
שעת השינוי האחרון של הפריט במאגר המקור. חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
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 |
השעה שבה המשתמש ביצע פעולה בפריט. אם קיימות מספר פעולות מאותו סוג עבור משתמש יחיד, רק הפעולה האחרונה מתועדת. חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
Interaction.InteractionType
סוג הפעילות שהמשתמש ביצע בפריט.
טיפוסים בני מנייה (enums) | |
---|---|
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[] |
חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
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[] |
האורך המקסימלי המותר לערכי טקסט הוא 2,048 תווים. |
NamedProperty.HtmlValues
רשימה של ערכי HTML.
ייצוג JSON |
---|
{ "values": [ string ] } |
שדות | |
---|---|
values[] |
האורך המקסימלי של ערכי HTML הוא 2,048 תווים. |
ItemContent
תוכן של פריט להוספה לאינדקס ולהצגה על ידי Cloud Search. רק מחרוזות בקידוד UTF-8 מותרות בתור inlineContent
. אם התוכן מועלה ולא בינארי, הוא חייב להיות בקידוד UTF-8.
ייצוג JSON |
---|
{ "contentFormat": enum ( |
שדות | |
---|---|
contentFormat |
|
hash |
נתוני הגיבוב (hashing) מחושבים וסופקו על ידי לקוח ה-API לתוכן. אפשר להשתמש בשיטה הזו עם השיטה items.push כדי לחשב את הערך 'מצב שינוי'. האורך המקסימלי הוא 2,048 תווים. |
שדה איחוד הערך של |
|
inlineContent |
תוכן שמופיע בגוף שיטת העדכון. האורך המקסימלי הוא 102,400 בייטים (100 KiB). מחרוזת בקידוד base64. |
contentDataRef |
העלאת מזהה הפניה של תוכן שהועלה בעבר באמצעות שיטת כתיבה. |
ItemContent.ContentFormat
הפורמט של התוכן. אם הפורמט הוא RAW, התוכן צריך להיות בפורמט שצוין על ידי mimeType
.
טיפוסים בני מנייה (enums) | |
---|---|
UNSPECIFIED |
ערך לא חוקי. |
HTML |
contentFormat הוא HTML. |
TEXT |
contentFormat הוא טקסט חופשי. |
RAW |
contentFormat הוא בייטים גולמיים. |
UploadItemRef
מייצג הפניה לסשן העלאה. ההפניה הזו נוצרה באמצעות upload method
. קובץ העזר הזה תקף למשך 30 יום ממועד היצירה שלו. עדכון של תוכן הפריט עשוי להתייחס לתוכן שהועלה דרך contentDataRef
.
ייצוג JSON |
---|
{ "name": string } |
שדות | |
---|---|
name |
שם ההפניה לתוכן. האורך המקסימלי הוא 2,048 תווים. |
ItemStatus
כאן מופיעים הסטטוס של הפריט ושגיאות, אם יש כאלה.
ייצוג JSON |
---|
{ "code": enum ( |
שדות | |
---|---|
code |
קוד סטטוס. |
processingErrors[] |
פרטי שגיאה, אם הפריט נמצא במצב ERROR. |
repositoryErrors[] |
שגיאה במאגר שדווחה על ידי המחבר. |
ProcessingError
ייצוג JSON |
---|
{ "code": enum ( |
שדות | |
---|---|
code |
קוד שגיאה שמציין את אופי השגיאה. |
errorMessage |
תיאור השגיאה. |
fieldViolations[] |
אם שדות הפריט לא חוקיים, השדה הזה מכיל את הפרטים על שגיאות האימות. |
ProcessingErrorCode
קודים לציון השגיאה שאירעה במהלך עיבוד הפריטים על ידי שרת Cloud Search. בפריט אחד עשויות להיות כמה שגיאות עיבוד.
טיפוסים בני מנייה (enums) | |
---|---|
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
רשימת קודי שגיאה לבעיות תקשורת במאגר.
טיפוסים בני מנייה (enums) | |
---|---|
UNKNOWN |
שגיאה לא ידועה. |
NETWORK_ERROR |
מארח לא ידוע או לא נגיש. |
DNS_ERROR |
בעיית DNS, כגון שרת ה-DNS אינו מגיב. |
CONNECTION_ERROR |
לא ניתן להתחבר לשרת המאגר. |
AUTHENTICATION_ERROR |
האימות נכשל עקב פרטי כניסה שגויים. |
AUTHORIZATION_ERROR |
לחשבון השירות אין הרשאה עבור המאגר. |
SERVER_ERROR |
שגיאת שרת במאגר. |
QUOTA_EXCEEDED |
חריגה מהמכסה. |
SERVICE_UNAVAILABLE |
זמנית, השרת לא זמין. |
CLIENT_ERROR |
שגיאה שקשורה ללקוח, כמו בקשה לא חוקית מהמחבר לשרת המאגר. |
Item.ItemType
טיפוסים בני מנייה (enums) | |
---|---|
UNSPECIFIED |
|
CONTENT_ITEM |
פריט שנוסף לאינדקס רק לצורך הצגת מידע. לא ניתן להפנות לפריטים האלה בשדות containerName או inheritAclFrom . |
CONTAINER_ITEM |
פריט שנוסף לאינדקס ומטרתו לספק פריטים אחרים עם רשימות ACL ו/או להכיל פריטים אחרים. |
VIRTUAL_CONTAINER_ITEM |
פריט שלא נוסף לאינדקס, אבל יש לו את אותה מטרה כמו CONTAINER_ITEM. |
שיטות |
|
---|---|
|
מחיקת Item resource לשם המשאב שצוין. |
|
מוחק את כל הפריטים בתור. |
|
הפונקציה מקבלת Item resource לפי שם הפריט. |
|
מתבצע עדכון של רשימת ה-ACL, המטא-נתונים והתוכן של Item . |
|
רשימה של כל חלקי הItem resources או קבוצת משנה שלהם. |
|
עריכת סקרים לגבי פריטים שלא שמורים מתור ההוספה לאינדקס וסימון קבוצה כ'שמורה', החל בפריטים בעלי חותמת הזמן הישנה ביותר מהעדיפות הגבוהה ביותר ItemStatus . |
|
דוחף פריט לתור לצורך תשאול ועדכון במועד מאוחר יותר. |
|
מבטל את שמירת כל הפריטים מתור, כך שכולם עומדים בדרישות להישאל. |
|
יוצר סשן העלאה להעלאת תוכן של פריטים. |