מתבצע עדכון של רשימת ה-ACL, המטא-נתונים והתוכן של Item
. אם הוא לא קיים, הוא יוסיף את התג Item
. השיטה הזו לא תומכת בעדכונים חלקיים. שדות שלא צוינו ערכים נמחקים מהאינדקס של Cloud Search.
כדי להפעיל את ה-API הזה, צריך חשבון אדמין או חשבון שירות. חשבון השירות שבו נעשה שימוש הוא החשבון שנכלל ברשימת ההיתרים במקור הנתונים התואם.
בקשת HTTP
POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:index
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
item.name |
שם הפריט. פורמט: datasources/{sourceId}/items/{itemId} יש למלא שדה זה. האורך המקסימלי הוא 1,536 תווים. |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "item": { "name": string, "acl": { "inheritAclFrom": string, "aclInheritanceType": enum ( |
שדות | |
---|---|
item.acl |
רשימה של בקרת גישה לפריט הזה. |
item.metadata |
פרטי המטא-נתונים. |
item.structuredData |
הנתונים המובְנים של הפריט שצריכים להתאים להגדרת אובייקט רשום בסכימה של מקור הנתונים. |
item.content |
תוכן הפריט להוספה לאינדקס ולחיפוש בטקסט. |
item.version |
חובה. מערכת ההוספה לאינדקס מאחסנת את הגרסה ממקור הנתונים כמחרוזת בייט, ומשווה את גרסת הפריט באינדקס לגרסה של הפריט שבתור לפי סדר מילולי. ההוספה לאינדקס ב-Cloud Search לא תוסיף לאינדקס או תמחק פריטים בתור עם ערך גרסה שקטן או שווה לגרסה של הפריט הנוכחי שנוסף לאינדקס. האורך המקסימלי לשדה הזה הוא 1,024 בייטים. כדי להבין איך גרסת הפריט משפיעה על תהליך המחיקה, אפשר לקרוא את המאמר בנושא טיפול בתיקונים לאחר מחיקה ידנית. מחרוזת בקידוד base64. |
item.status |
הסטטוס של הפריט. שדה פלט בלבד. |
item.queue |
מוסיפים את הפריט הזה לתור. האורך המקסימלי הוא 100 תווים. |
item.payload |
מחבר מצב נוסף יכול לאחסן את הפריט הזה. האורך המקסימלי הוא 10,000 בייטים. מחרוזת בקידוד base64. |
item.itemType |
הסוג של הפריט הזה. |
connectorName |
שם המחבר שמבצע את השיחה. פורמט: datasources/{sourceId}/connectors/{ID} |
mode |
חובה. מצב ה-RequestMode עבור בקשה זו. |
debugOptions |
אפשרויות נפוצות לניפוי באגים. |
indexItemOptions |
|
גוף התגובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של Operation
.
היקפי הרשאות
כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:
https://www.googleapis.com/auth/cloud_search.indexing
https://www.googleapis.com/auth/cloud_search
למידע נוסף, ניתן לעיין במדריך ההרשאות.
IndexItemOptions
ייצוג JSON |
---|
{ "allowUnknownGsuitePrincipals": boolean } |
שדות | |
---|---|
allowUnknownGsuitePrincipals |
קובעת אם בקשת האינדקס תאפשר חשבונות משתמשים ב-Google Workspace שלא קיימים או שנמחקו. |