- מקור: פריט
- ItemAcl
- ItemAcl.AclInheritanceType
- ראשי
- ItemMetadata
- אינטראקציה
- Interactive.InteractionType
- SearchQualMetadata
- הקשר
- ItemItemdData
- מבנה של נתונים מובְנים
- נכס בעל שם
- NamedProperty.IntegerValues
- NamedProperty.DoubleValues
- NamedProperty.TimestampValues
- NamedProperty.ObjectValues
- NamedProperty.EnumValues
- NamedProperty.DateValues
- NamedProperty.TextValues
- NamedProperty.HtmlValues
- ItemContent
- ItemContent.ContentContent
- UploadItemRef
- סטטוס פריט
- שגיאת עיבוד
- קוד שגיאה לעיבוד
- הפרת שדה
- שגיאת Repository
- RepositoryError.Type
- Item.ItemType
- שיטות
משאב: פריט
מייצג אובייקט יחיד שהוא פריט באינדקס החיפוש, כגון קובץ, תיקייה או רשומת מסד נתונים.
ייצוג JSON |
---|
{ "name": string, "acl": { object ( |
שדות | |
---|---|
name |
שם הפריט. פורמט: datasources/{sourceId}/items/{itemId} יש למלא שדה זה. האורך המרבי הוא 1536 תווים. |
acl |
רשימת בקרת גישה לפריט הזה. |
metadata |
המטא-נתונים. |
structuredData |
הנתונים המובְנים של הפריט צריכים להיות תואמים להגדרה של אובייקט רשום בסכימה של מקור הנתונים. |
content |
תוכן של פריטים להוספה לאינדקס ושהטקסט זמין לחיפוש. |
version |
חובה. מערכת ההוספה לאינדקס מאחסנת את הגרסה ממקור הנתונים כמחרוזת בייט ומשווה את גרסת הפריט באינדקס לגרסה של הפריט שבתור באמצעות סדר הקסדצימלי. יצירת אינדקס ב-Cloud Search לא תוסיף לאינדקס או תמחק פריט כלשהו שבתור שלו יש ערך גרסה נמוך יותר או שווה לגרסה של הפריט שנוסף לאינדקס כרגע. האורך המרבי עבור השדה הזה הוא 1,024 בייטים. למידע נוסף על האופן שבו גרסת הפריט משפיעה על תהליך המחיקה, יש לעיין בקטע גרסאות קודמות של מחיקה לאחר מחיקות ידניות. מחרוזת בקידוד base64. |
status |
סטטוס הפריט. שדה לפלט בלבד. |
queue |
הבאים בתור לפריט זה. האורך המרבי הוא 100 תווים. |
payload |
אפשר לאחסן מחבר נוסף עבור הפריט הזה. האורך המרבי הוא 10,000 בייטים. מחרוזת בקידוד base64. |
itemType |
הסוג של הפריט הזה. |
הפריט
גישה לפרטי הרשימה של בקרת הגישה לפריט. לקבלת מידע נוסף, אפשר לעיין ברשימות ACL של מפות.
ייצוג JSON |
---|
{ "inheritAclFrom": string, "aclInheritanceType": enum ( |
שדות | |
---|---|
inheritAclFrom |
שם הפריט שיקבל בירושה את רשימת הרשאות הגישה (ACL). הערה: ירושה של ACL רק מספקת הרשאות גישה לפריטי צאצא ולא מגדירה קשרים מבניים, וגם לא מספקת דרכים נוחות למחיקת קבוצות גדולות של פריטים. מחיקת ההורה של ה-ACL מהאינדקס משנה רק את הרשאות הגישה של פריטי צאצא שמפנים להורה בשדה |
aclInheritanceType |
הגדרה של סוג כללי הגישה שיחול כשפריט יורש ACL מהורה. הערך הזה צריך תמיד להיות מוגדר לצד השדה |
readers[] |
רשימת חשבונות שמורשים לראות את הפריט בתוצאות החיפוש. אופציונלי אם מקבלים בירושה הרשאות מפריט אחר או אם הפריט אינו מיועד להצגה, למשל |
deniedReaders[] |
רשימה של חשבונות משתמשים שנפסלו באופן מפורש לגישה אל הפריט בתוצאות החיפוש. כברירת מחדל, משתמשים לא יכולים לגשת לקוראים, אבל הם יכולים להשתמש בתוספים שנדחו כדי לטפל בחריגות ולדלג על רשימת הקוראים המותרת. מספר הרכיבים המקסימלי הוא 100. |
owners[] |
אופציונלי. רשימת הבעלים של הפריט. השדה הזה לא משפיע על הרשאות הגישה למסמך. עם זאת, הדירוג מעט מאפשר לשפר את הפריטים כאשר המשתמש ששולח את השאילתה הוא הבעלים. מספר הרכיבים המקסימלי הוא 5. |
ItemAcl.AclInheritanceType
הסוגים של ירושה של ACL.
Enums | |
---|---|
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 |
המשתמש הראשי הוא קבוצה המזוהה באמצעות זהות חיצונית. שדה השם חייב לציין את שם המשאב של הקבוצה בפורמט הבא: Identitysources/{sourceId}/groups/{ID} |
מטא-נתונים של הפריט
שדות מטא-נתונים זמינים של הפריט.
ייצוג JSON |
---|
{ "title": string, "sourceRepositoryUrl": string, "containerName": string, "objectType": string, "createTime": string, "updateTime": string, "interactions": [ { object ( |
שדות | |
---|---|
title |
השם של הפריט. אם נתת אותה, זו תהיה הכותרת המוצגת של תוצאת ה-query.search. האורך המרבי הוא 2048 תווים. |
sourceRepositoryUrl |
קישור למאגר הנתונים שמציג את הנתונים. תוצאות החיפוש מחילות את הקישור על הכותרת. רווחים לבנים או תווים מיוחדים יכולים לגרום לקישורים של תוצאות החיפוש ב-Cloud Seach להפעיל הודעה על הפניה אוטומטית. כדי להימנע מכך, יש לקודד את כתובת ה-URL. האורך המרבי הוא 2048 תווים. |
containerName |
שם המאגר של הפריט הזה. מחיקת הפריט המכיל גורמת למחיקה אוטומטית של הפריט. הערה: רשימות ACL לא עוברות בירושה מפריט מאגר. כדי לספק ירושה של ACL עבור פריט, צריך להשתמש בשדה |
objectType |
סוג הפריט. השם הזה צריך להתאים לשם של הגדרת אובייקט בסכימה הרשומה עבור מקור הנתונים. לדוגמה, אם הסכימה של מקור הנתונים מכילה הגדרת אובייקט בשם 'document', אז בקשות להוספת פריטים לאינדקס עבור אובייקטים מהסוג הזה צריכות להגדיר את objectType ל'מסמך'. האורך המרבי הוא 256 תווים. |
createTime |
השעה שבה הפריט נוצר במאגר המקור. חותמת זמן בפורמט RFC3339 UTC "Zulu", ברזולוציה של ננו-שניות ועד 9 ספרות עשרוניות. דוגמאות: |
updateTime |
השעה שבה הפריט שונה לאחרונה במאגר המקור. חותמת זמן בפורמט RFC3339 UTC "Zulu", ברזולוציה של ננו-שניות ועד 9 ספרות עשרוניות. דוגמאות: |
interactions[] |
רשימת אינטראקציות עם הפריט. אינטראקציות משמשות לשיפור האיכות של query.search, אבל הן לא חשופות למשתמשי הקצה. מספר הרכיבים המקסימלי הוא 1000. |
contentLanguage |
קוד השפה BCP-47 של הפריט, כגון "en-US" או "sr-Latn". מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. האורך המרבי הוא 32 תווים. |
mimeType |
סוג MIME המקורי של |
searchQualityMetadata |
מטא-נתונים נוספים של איכות החיפוש של הפריט |
keywords[] |
מילות מפתח או ביטויים נוספים שאמורים להתאים לפריט. לשימוש פנימי עבור תוכן שנוצר על ידי משתמשים. מספר הרכיבים המקסימלי הוא 100. האורך המרבי הוא 8192 תווים. |
hash |
ערך הגיבוב שסופק על ידי ה-API שנקרא. אפשר להשתמש במאפיין הזה בשיטה |
contextAttributes[] |
קבוצה של מאפיינים בעלי שם שמשויכים לפריט. הדבר עשוי להשפיע על דירוג הפריט על סמך ההקשר שבבקשה. מספר הרכיבים המקסימלי הוא 10. |
אינטראקציה
מייצג אינטראקציה בין משתמש לפריט.
ייצוג JSON |
---|
{ "type": enum ( |
שדות | |
---|---|
type |
|
principal |
המשתמש שטיפל בפריט. |
interactionTime |
השעה שבה המשתמש ביצע פעולה בפריט. אם קיימות מספר פעולות מאותו סוג למשתמש יחיד, רק הפעולה האחרונה מתועדת. חותמת זמן בפורמט RFC3339 UTC "Zulu", ברזולוציה של ננו-שניות ועד 9 ספרות עשרוניות. דוגמאות: |
אינטראקציה.סוג אינטראקציה
סוג הפעילות שהמשתמש ביצע בפריט.
Enums | |
---|---|
UNSPECIFIED |
ערך לא חוקי. |
VIEW |
אינטראקציה זו מציינת שהמשתמש צפה בפריט. |
EDIT |
אינטראקציה זו מציינת שהמשתמש ערך את הפריט. |
מטא-נתונים של Searchאיכות מטא-נתונים
מטא-נתונים נוספים של איכות החיפוש של הפריט.
ייצוג JSON |
---|
{ "quality": number } |
שדות | |
---|---|
quality |
אינדיקציה לגבי איכות הפריט, שיכולה להשפיע על איכות החיפוש. הערך צריך להיות בין 0.0 (האיכות הנמוכה ביותר) ל-1.0 (האיכות הגבוהה ביותר). ערך ברירת המחדל הוא 0.0. |
מאפיין הקשר
מאפיין בעל שם המשויך לפריט, שיכול להשפיע על דירוג הפריט, על סמך ההקשר שבבקשה.
ייצוג JSON |
---|
{ "name": string, "values": [ string ] } |
שדות | |
---|---|
name |
שם המאפיין. הוא לא יכול להיות ריק. האורך המרבי הוא 32 תווים. השם חייב להתחיל באות ויכול להכיל רק אותיות (A-Z, a-z) או מספרים (0-9). השם ינרמל (אותיות קטנות) לפני ההתאמה. |
values[] |
ערכי הטקסט של המאפיין. מספר הרכיבים המקסימלי הוא 10. האורך המרבי של רכיב במערך הוא 32 תווים. הערך ינרמל (אותיות קטנות) לפני התאמה. |
נתוני מובְנים של פריט
שדות נתונים מובְנים של הפריט זמינים.
ייצוג JSON |
---|
{
"object": {
object ( |
שדות | |
---|---|
object |
אובייקט הנתונים המובְנים שצריך להתאים להגדרת אובייקט רשומה בסכימה של מקור הנתונים. |
hash |
ערך הגיבוב שסופק על ידי ה-API שנקרא. אפשר להשתמש במאפיין הזה בשיטה |
אובייקט נתונים מובנים
אובייקט נתונים מובְנים שמורכב מנכסים בעלי שם.
ייצוג JSON |
---|
{
"properties": [
{
object ( |
שדות | |
---|---|
properties[] |
המאפיינים של האובייקט. מספר הרכיבים המקסימלי הוא 1000. |
נכס בעל שם
צמד של שם-ערך שהוזן עבור נתונים מובְנים. סוג הערך צריך להיות זהה לסוג הרשום בנכס name
בהגדרת האובייקט objectType
.
ייצוג JSON |
---|
{ "name": string, // Union field |
שדות | |
---|---|
name |
שם הנכס. השם הזה צריך להיות תואם לשם של הנכס שרשום להגדרת אובייקט בסכימה. האורך המרבי המותר של הנכס הזה הוא 256 תווים. |
שדה איחוד value . הערכים של הנכס בעל השם. חשוב לשים לב שנכס יכול להכיל רק ערכים מסוג אחד. value יכול להיות רק אחד מאלה: |
|
integerValues |
|
doubleValues |
|
timestampValues |
|
booleanValue |
|
objectValues |
|
enumValues |
|
dateValues |
|
textValues |
|
htmlValues |
|
שם בעל שם.מספר שלם
רשימה של ערכי מספרים שלמים.
ייצוג JSON |
---|
{ "values": [ string ] } |
שדות | |
---|---|
values[] |
|
שם בעל שם.ערכים כפולים
רשימה של ערכים כפולים.
ייצוג JSON |
---|
{ "values": [ number ] } |
שדות | |
---|---|
values[] |
|
NamedProperty.TimestampValues
רשימת הערכים של חותמות הזמן.
ייצוג JSON |
---|
{ "values": [ string ] } |
שדות | |
---|---|
values[] |
חותמת זמן בפורמט RFC3339 UTC "Zulu", ברזולוציה של ננו-שניות ועד 9 ספרות עשרוניות. דוגמאות: |
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 תווים. |
תוכן הפריט
תוכן של פריט שיתווסף לאינדקס ויוצג על ידי Cloud Search. מותר להשתמש רק במחרוזות בקידוד UTF-8 בתור inlineContent
. אם התוכן מועלה ולא בינארי, עליו להיות בקידוד UTF-8.
ייצוג JSON |
---|
{ "contentFormat": enum ( |
שדות | |
---|---|
contentFormat |
|
hash |
פרטי הגיבוב מחושבים ומסופקים על ידי לקוח ה-API לתוכן. אפשר להשתמש בו עם items.push כדי לחשב מצב שהשתנה. האורך המרבי הוא 2048 תווים. |
שדה איחוד
|
|
inlineContent |
תוכן שסופק בתוך השורה משיטת העדכון. האורך המרבי הוא 1,024,000 בייטים (100 KiB). מחרוזת בקידוד base64. |
contentDataRef |
העלאת מזהה עזר של תוכן שהועלה בעבר באמצעות שיטת כתיבה. |
ContentContent.Contentformat
הפורמט של התוכן. אם הפורמט הוא RAW, התוכן צריך להיות בפורמט שצוין על ידי mimeType
.
Enums | |
---|---|
UNSPECIFIED |
ערך לא חוקי. |
HTML |
contentformat הוא HTML. |
TEXT |
contentformat הוא טקסט חופשי. |
RAW |
contentformat היא בייטים גולמיים. |
uploadItemRef
הקובץ הזה מייצג הפניה לסשן העלאה. קובץ העזר הזה נוצר באמצעות upload method
. קובץ העזר הזה תקף למשך 30 יום לאחר היצירה. עדכון של תוכן הפריט עשוי להפנות לתוכן שהועלה דרך contentDataRef
.
ייצוג JSON |
---|
{ "name": string } |
שדות | |
---|---|
name |
השם של ההפניה לתוכן. האורך המרבי הוא 2048 תווים. |
סטטוס הפריט
כולל סטטוס הפריט ושגיאות.
ייצוג JSON |
---|
{ "code": enum ( |
שדות | |
---|---|
code |
קוד הסטטוס. |
processingErrors[] |
פרטי שגיאה למקרה שהפריט נמצא במצב ERROR. |
repositoryErrors[] |
שגיאה במאגר דיווחה על ידי המחבר. |
שגיאת עיבוד
ייצוג JSON |
---|
{ "code": enum ( |
שדות | |
---|---|
code |
קוד שגיאה המציין את אופי השגיאה. |
errorMessage |
תיאור השגיאה. |
fieldViolations[] |
אם שדות הפריט לא תקינים, השדה הזה כולל פרטים על שגיאות האימות. |
קוד שגיאה לעיבוד
קודים לציון השגיאה שאירעה במהלך העיבוד של פריטים על ידי שרת Cloud Search. פריט אחד עשוי להכיל מספר שגיאות עיבוד.
Enums | |
---|---|
PROCESSING_ERROR_CODE_UNSPECIFIED |
קלט בלבד. יש להשתמש בערך הזה ב'פריטים'. |
MALFORMED_REQUEST |
ה-ACL, המטא-נתונים או התוכן של הפריט שגויים או במצב לא חוקי. הפרות המדיניות כוללות פרטים נוספים על המיקום של הבעיה. |
UNSUPPORTED_CONTENT_FORMAT |
אין תמיכה בפורמט הספירה. |
INDIRECT_BROKEN_ACL |
פריטים שמכילים פרטי ACL חלקיים כי התקבלו בהם פריטים אחרים עם רשימת ACL לא תקינה או כאלה שמכילים קבוצות עם צאצאים לא ממופים. |
ACL_CYCLE |
תרשים הירושה של ACL יצר מחזור. |
הפרת שדה
ייצוג JSON |
---|
{ "field": string, "description": string } |
שדות | |
---|---|
field |
נתיב שדה עם הפרה. |
description |
תיאור השגיאה. |
שגיאת מאגר
שגיאות בזמן שהמחבר מתקשר למאגר הנתונים.
ייצוג JSON |
---|
{
"type": enum ( |
שדות | |
---|---|
type |
סוג השגיאה. |
httpStatusCode |
קודי שגיאה. תואמת להגדרה של קודי סטטוס HTTP. |
errorMessage |
הודעה שמתארת את השגיאה. האורך המרבי המותר של ההודעה הוא 8192 תווים. |
שגיאת Repository.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 . |
|
דוחף פריט לתור לבדיקה במועד מאוחר יותר ולעדכון. |
|
שמירת כל הפריטים ב'הבאים בתור' מונעת את כשירותם להשתתף בסקרים. |
|
יוצר סשן העלאת תוכן של פריטים. |