עדכון ה-ACL, המטא-נתונים והתוכן של Item
. אם הוא לא קיים, הוא יוכנס.Item
בשיטה הזו אין תמיכה בעדכונים חלקיים. שדות ללא ערכים שצוינו נמחקים מאינדקס Cloud Search.
כדי להפעיל את ה-API הזה, נדרש חשבון אדמין או חשבון שירות. חשבון השירות שבו נעשה שימוש הוא זה שרשום ברשימת ההיתרים במקור הנתונים המתאים.
בקשת HTTP
POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:index
כתובת ה-URL משתמשת בתחביר של Transcoding של 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 שלא קיימים או נמחקו. |