REST Resource: indexing.datasources.items

{
  "name": string,
  "acl": {
    object (ItemAcl)
  },
  "metadata": {
    object (ItemMetadata)
  },
  "structuredData": {
    object (ItemStructuredData)
  },
  "content": {
    object (ItemContent)
  },
  "version": string,
  "status": {
    object (ItemStatus)
  },
  "queue": string,
  "payload": string,
  "itemType": enum (Item.ItemType)
}

string

שם הפריט. פורמט: datasources/{sourceId}/items/{itemId}

יש למלא שדה זה. האורך המקסימלי הוא 1,536 תווים.

object (ItemAcl)

רשימה של בקרת גישה לפריט הזה.

object (ItemMetadata)

פרטי המטא-נתונים.

object (ItemStructuredData)

הנתונים המובְנים של הפריט שצריכים להתאים להגדרת אובייקט רשומה בסכימה של מקור הנתונים.

object (ItemContent)

תוכן הפריט שיתווסף לאינדקס וניתן יהיה לחפש אותו.

string (bytes format)

חובה. מערכת ההוספה לאינדקס שומרת את הגרסה ממקור הנתונים כמחרוזת של בייט, ומשווה בין גרסת הפריט באינדקס לגרסה של הפריט שבתור באמצעות סדר מילוני.

הוספה של Cloud Search לאינדקס לא תגרום להוספה לאינדקס או למחיקה של פריטים שנמצאים בתור, שערך הגרסה שלהם נמוך או שווה לגרסה של הפריט הנוכחי שנוסף לאינדקס. האורך המקסימלי של השדה הזה הוא 1,024 בייטים.

כדי לדעת איך גרסת הפריט משפיעה על תהליך המחיקה, ניתן לעיין במאמר טיפול בתיקונים אחרי מחיקה ידנית.

מחרוזת בקידוד base64.

object (ItemStatus)

סטטוס הפריט. שדה 'פלט בלבד'.

string

מוסיפים את הפריט הזה לתור שאליו שייך הפריט. האורך המקסימלי הוא 100 תווים.

string (bytes format)

מחבר מצב נוסף יכול לאחסן עבור פריט זה. האורך המקסימלי הוא 10,000 בייטים.

מחרוזת בקידוד base64.

enum (Item.ItemType)

הסוג של הפריט הזה.

{
  "inheritAclFrom": string,
  "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
  "readers": [
    {
      object (Principal)
    }
  ],
  "deniedReaders": [
    {
      object (Principal)
    }
  ],
  "owners": [
    {
      object (Principal)
    }
  ]
}

string

שם הפריט שממנו יורש רשימת הרשאות הגישה (ACL). הערה: ירושה של ACL רק מספקת הרשאות גישה לפריטי צאצא, לא מגדירה קשרים מבניים. היא גם לא מספקת דרכים נוחות למחוק קבוצות גדולות של פריטים. מחיקת הורה מסוג ACL מהאינדקס משנה רק את הרשאות הגישה של פריטי צאצא שמפנים להורה בשדה inheritAclFrom. הפריט עדיין מופיע באינדקס, אך ייתכן שלא יופיע בתוצאות החיפוש. לעומת זאת, מחיקה של פריט בקונטיינר מוחקת גם את כל הפריטים שמפנים למאגר באמצעות השדה containerName. האורך המקסימלי של השדה הזה הוא 1,536 תווים.

enum (ItemAcl.AclInheritanceType)

מגדיר את סוג כללי הגישה שיחולו כשהפריט יורש את רשימת ה-ACL שלו מהורה. צריך להגדיר את האפשרות הזו תמיד במקביל לשדה inheritAclFrom. בנוסף, כשהשדה inheritAclFrom מוגדר, צריך להגדיר את השדה הזה כ-AclInheritanceType חוקי.

object (Principal)

רשימה של חשבונות משתמשים שמורשים לראות את הפריט בתוצאות החיפוש. אופציונלי אם מקבלים בירושה הרשאות מפריט אחר או אם הפריט לא אמור להיות גלוי, כמו virtual containers. מספר הרכיבים המקסימלי הוא 1,000.

object (Principal)

רשימה של חשבונות משתמשים שבקשת הגישה שלהם לפריט בתוצאות החיפוש נדחתה באופן מפורש. הגישה של חשבונות משתמשים חסומה כברירת מחדל, אבל כדאי להשתמש בקוראים שנדחו כדי לטפל בחריגים ולבטל את רשימת הקוראים המורשים. אפשר לכלול עד 100 רכיבים.

object (Principal)

זה שינוי אופציונלי. רשימת הבעלים של הפריט. לשדה הזה אין השפעה על הרשאות הגישה למסמכים. עם זאת, הוא מציע דירוג קל יותר משפר את הדירוג של פריטים שבהם המשתמש ששלח את השאילתה הוא הבעלים. מספר הרכיבים המקסימלי הוא 5.

{

  // Union field principal can be only one of the following:
  "gsuitePrincipal": {
    object (GSuitePrincipal)
  },
  "userResourceName": string,
  "groupResourceName": string
  // End of list of possible types for union field principal.
}

object (GSuitePrincipal)

חשבון המשתמש הזה הוא משתמש, קבוצה או דומיין ב-Google Workspace.

string

חשבון המשתמש הזה הוא משתמש שזוהה באמצעות זהות חיצונית. בשדה השם צריך לציין את השם של משאב המשתמש בפורמט הבא: Identitysources/{sourceId}/users/{ID}

string

חשבון המשתמש הזה הוא קבוצה שמזוהה באמצעות זהות חיצונית. שדה השם חייב לציין את שם משאב הקבוצה בפורמט הבא: Identitysources/{sourceId}/groups/{ID}

{
  "title": string,
  "sourceRepositoryUrl": string,
  "containerName": string,
  "objectType": string,
  "createTime": string,
  "updateTime": string,
  "interactions": [
    {
      object (Interaction)
    }
  ],
  "contentLanguage": string,
  "mimeType": string,
  "searchQualityMetadata": {
    object (SearchQualityMetadata)
  },
  "keywords": [
    string
  ],
  "hash": string,
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}

string

שם הפריט. אם הנתונים יוצגו, זו תהיה הכותרת המוצגת של תוצאת החיפוש query.search. האורך המקסימלי הוא 2,048 תווים.

string

קישור למאגר המקור שמציג את הנתונים. תוצאות חיפוש מחילות את הקישור הזה על הכותר. רווחים לבנים או תווים מיוחדים עלולים לגרום לקישורים של תוצאות Cloud Seach להפעיל הודעה על הפניה אוטומטית; כדי להימנע מכך, לקודד את כתובת ה-URL. האורך המקסימלי הוא 2,048 תווים.

string

שם המאגר של הפריט הזה. מחיקה של פריט המאגר תוביל למחיקה אוטומטית של הפריט הזה. הערה: רשימות ACL לא עוברות בירושה מפריט במאגר. כדי לספק ירושה של ACL לפריט, משתמשים בשדה inheritAclFrom. האורך המקסימלי הוא 1,536 תווים.

string

סוג הפריט. הוא צריך להתאים לשם של הגדרת האובייקט בסכימה שרשומה עבור מקור הנתונים. לדוגמה, אם הסכימה של מקור הנתונים מכילה הגדרת אובייקט בשם 'document', בקשות להוספת פריטים לאינדקס עבור אובייקטים מהסוג הזה צריכות להגדיר את objectType כ-'document'. האורך המקסימלי הוא 256 תווים.

string (Timestamp format)

השעה שבה הפריט נוצר במאגר המקור.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

string (Timestamp format)

השעה שבה הפריט שונה לאחרונה במאגר המקור.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

object (Interaction)

רשימת אינטראקציות עם הפריט. האינטראקציות משמשות לשיפור האיכות של query.search, אבל הן לא חשופות למשתמשי הקצה. מספר הרכיבים המקסימלי הוא 1,000.

string

קוד השפה BCP-47 של הפריט, למשל en-US או 'sr-Latn'. מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. האורך המקסימלי הוא 32 תווים.

string

סוג ה-mime המקורי של ItemContent.content במאגר המקור. האורך המקסימלי הוא 256 תווים.

object (SearchQualityMetadata)

מטא-נתונים נוספים של איכות החיפוש של הפריט

string

מילות מפתח או ביטויים נוספים שאמורים להתאים לפריט. משמש באופן פנימי לתוכן שנוצר על ידי משתמשים. אפשר לכלול עד 100 רכיבים. האורך המקסימלי הוא 8,192 תווים.

string

ערך הגיבוב שסופק על ידי שולח הקריאה ל-API. אפשר לחשב את השינוי הזה באמצעות השיטה items.push. האורך המקסימלי הוא 2,048 תווים.

object (ContextAttribute)

קבוצה של מאפיינים בעלי שם שמשויכים לפריט. המידע הזה יכול לשמש להשפעה על דירוג הפריט על סמך ההקשר של הבקשה. אפשר לכלול עד 10 רכיבים.

{
  "type": enum (Interaction.InteractionType),
  "principal": {
    object (Principal)
  },
  "interactionTime": string
}

enum (Interaction.InteractionType)

object (Principal)

המשתמש שביצע פעולה בפריט.

string (Timestamp format)

השעה שבה המשתמש ביצעו פעולה בפריט. אם קיימות כמה פעולות מאותו סוג לגבי משתמש יחיד, רק הפעולה האחרונה מתועדת.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

{
  "quality": number
}

number

אינדיקציה לאיכות הפריט, שמשמשת כדי להשפיע על איכות החיפוש. הערך צריך להיות בין 0.0 (האיכות הנמוכה ביותר) ל-1.0 (האיכות הגבוהה ביותר). ערך ברירת המחדל הוא 0.0.

{
  "name": string,
  "values": [
    string
  ]
}

string

שם המאפיין. השדה לא יכול להיות ריק. האורך המקסימלי הוא 32 תווים. השם חייב להתחיל באות והוא יכול להכיל רק אותיות (A-Z, a-z) או מספרים (0-9). השם יעבור נירמול (באותיות קטנות) לפני שתהיה התאמה.

string

ערכי טקסט של המאפיין. אפשר לכלול עד 10 רכיבים. האורך המקסימלי של רכיב במערך הוא 32 תווים. הערך יעבור נירמול (באותיות קטנות) לפני ההתאמה.

{
  "object": {
    object (StructuredDataObject)
  },
  "hash": string
}

object (StructuredDataObject)

אובייקט הנתונים המובְנים שצריך להתאים להגדרת האובייקט הרשומה בסכימה של מקור הנתונים.

string

ערך הגיבוב שסופק על ידי שולח הקריאה ל-API. אפשר לחשב את השינוי הזה באמצעות השיטה items.push. האורך המקסימלי הוא 2,048 תווים.

{
  "properties": [
    {
      object (NamedProperty)
    }
  ]
}

object (NamedProperty)

המאפיינים של האובייקט. מספר הרכיבים המקסימלי הוא 1,000.

{
  "name": string,

  // Union field value can be only one of the following:
  "integerValues": {
    object (NamedProperty.IntegerValues)
  },
  "doubleValues": {
    object (NamedProperty.DoubleValues)
  },
  "timestampValues": {
    object (NamedProperty.TimestampValues)
  },
  "booleanValue": boolean,
  "objectValues": {
    object (NamedProperty.ObjectValues)
  },
  "enumValues": {
    object (NamedProperty.EnumValues)
  },
  "dateValues": {
    object (NamedProperty.DateValues)
  },
  "textValues": {
    object (NamedProperty.TextValues)
  },
  "htmlValues": {
    object (NamedProperty.HtmlValues)
  }
  // End of list of possible types for union field value.
}

string

שם הנכס. השם הזה צריך להתאים לשם המאפיין שנרשם להגדרת האובייקט בסכימה. האורך המקסימלי המותר לנכס הזה הוא 256 תווים.

object (NamedProperty.IntegerValues)

object (NamedProperty.DoubleValues)

object (NamedProperty.TimestampValues)

boolean

object (NamedProperty.ObjectValues)

object (NamedProperty.EnumValues)

object (NamedProperty.DateValues)

object (NamedProperty.TextValues)

object (NamedProperty.HtmlValues)

{
  "values": [
    string
  ]
}

string (int64 format)

{
  "values": [
    number
  ]
}

number

{
  "values": [
    string
  ]
}

string (Timestamp format)

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

{
  "values": [
    {
      object (StructuredDataObject)
    }
  ]
}

object (StructuredDataObject)

{
  "values": [
    string
  ]
}

string

האורך המקסימלי המותר לערכי מחרוזת הוא 32 תווים.

{
  "values": [
    {
      object (Date)
    }
  ]
}

object (Date)

{
  "values": [
    string
  ]
}

string

האורך המקסימלי המותר לערכי טקסט הוא 2,048 תווים.

{
  "values": [
    string
  ]
}

string

האורך המקסימלי המותר לערכי HTML הוא 2,048 תווים.

{
  "contentFormat": enum (ItemContent.ContentFormat),
  "hash": string,

  // Union field content can be only one of the following:
  "inlineContent": string,
  "contentDataRef": {
    object (UploadItemRef)
  }
  // End of list of possible types for union field content.
}

enum (ItemContent.ContentFormat)

string

פרטי הגיבוב (hash) שמחושבים וסופקו על ידי לקוח ה-API עבור התוכן. אפשר להשתמש בו עם השיטה items.push כדי לחשב את השינויים במצב. האורך המקסימלי הוא 2,048 תווים.

string (bytes format)

התוכן שמסופק בתוך שיטת העדכון. האורך המקסימלי הוא 102,400 בייטים (100KiB).

מחרוזת בקידוד base64.

object (UploadItemRef)

העלאת מזהה ההפניה של תוכן שהועלה בעבר באמצעות שיטת כתיבה.

{
  "name": string
}

string

השם של ההפניה לתוכן. האורך המקסימלי הוא 2,048 תווים.

{
  "code": enum (ItemStatus.Code),
  "processingErrors": [
    {
      object (ProcessingError)
    }
  ],
  "repositoryErrors": [
    {
      object (RepositoryError)
    }
  ]
}

enum (ItemStatus.Code)

קוד סטטוס.

object (ProcessingError)

פרטי השגיאה במקרה שהפריט במצב ERROR.

object (RepositoryError)

המחבר דווח על שגיאת מאגר.

{
  "code": enum (ProcessingErrorCode),
  "errorMessage": string,
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}

enum (ProcessingErrorCode)

קוד שגיאה שמציין את אופי השגיאה.

string

תיאור השגיאה.

object (FieldViolation)

אם שדות הפריט לא חוקיים, השדה הזה מכיל את הפרטים על שגיאות האימות.

{
  "field": string,
  "description": string
}

string

נתיב השדה עם הפרה.

string

תיאור השגיאה.

{
  "type": enum (RepositoryError.Type),
  "httpStatusCode": integer,
  "errorMessage": string
}

enum (RepositoryError.Type)

סוג השגיאה.

integer

קודי שגיאה. תואם להגדרה של קודי מצב HTTP.

string

הודעה שמתארת את השגיאה. האורך המקסימלי המותר להודעה הוא 8,192 תווים.