עדכון מקור נתונים.
הערה: כדי להפעיל את ה-API הזה, נדרש חשבון אדמין.
בקשת HTTP
PUT https://cloudsearch.googleapis.com/v1/settings/{source.name=datasources/*}
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
source.name |
שם המשאב של מקור הנתונים. פורמט: datasources/{sourceId}. כשיוצרים מקור נתונים, המערכת מתעלמת מהשם. |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "source": { "name": string, "displayName": string, "shortName": string, "indexingServiceAccounts": [ string ], "disableServing": boolean, "disableModifications": boolean, "itemsVisibility": [ { // Union field |
שדות | |
---|---|
source.displayName |
חובה. השם המוצג של מקור הנתונים. האורך המקסימלי הוא 300 תווים. |
source.shortName |
שם קצר או כינוי למקור. הערך הזה ישמש להתאמת האופרטור 'מקור'. לדוגמה, אם השם המקוצר הוא <value>, שאילתות כמו source:<value> יחזירו תוצאות מהמקור הזה בלבד. הערך חייב להיות ייחודי בכל מקורות הנתונים. הערך חייב להכיל תווים אלפאנומריים בלבד (a-zA-Z0-9). הערך לא יכול להתחיל ב-'google' ולא יכול להיות אחד מהערכים הבאים: mail, gmail, docs, drive, ,groups, sites, calendar, hangouts, gplus, keep, people, Teams. האורך המקסימלי הוא 32 תווים. |
source.indexingServiceAccounts[] |
רשימה של חשבונות שירות שיש להם גישה להוספה לאינדקס. |
source.disableServing |
השבתת ההצגה של תוצאות חיפוש או סיוע. |
source.disableModifications |
אם הערך הוא True, מקור הנתונים יהיה במצב קריאה-בלבד. במצב קריאה-בלבד, ה-API ליצירת אינדקס דוחה את כל הבקשות להוספה לאינדקס או למחיקה של פריטים במקור זה. הפעלת מצב הקריאה-בלבד לא עוצרת את העיבוד של נתונים שהתקבלו בעבר. |
source.itemsVisibility[] |
השדה הזה מגביל את החשיפה של פריטים ברמת מקור הנתונים. הפריטים במקור הנתונים מוגבלים לאיחוד של משתמשים וקבוצות שכלולים בשדה הזה. הערה: הפעולה הזו לא מבטיחה גישה לפריט ספציפי, כי למשתמשים צריכות להיות הרשאות ACL בפריטים הנכללים. כך מובטחת גישה ברמה גבוהה לכל מקור הנתונים, ושלא ישותפו פריטים בודדים מחוץ לחשיפה הזו. |
source.returnThumbnailUrls |
האם משתמש יכול לבקש לקבל URI של תמונה ממוזערת עבור פריטים שנוספו לאינדקס במקור הנתונים הזה. |
source.operationIds[] |
מזהים של פעולות ממושכות (LRO) שפועלות כרגע עבור הסכימה הזו. |
debugOptions |
אפשרויות נפוצות לניפוי באגים. |
updateMask |
רלוונטי רק ל- יש לעדכן את המסכה כדי לקבוע אילו שדות לעדכן. דוגמה לנתיבי שדה:
|
גוף התגובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של Operation
.
היקפי הרשאות
כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:
https://www.googleapis.com/auth/cloud_search.settings.indexing
https://www.googleapis.com/auth/cloud_search.settings
https://www.googleapis.com/auth/cloud_search
למידע נוסף, ניתן לעיין במדריך ההרשאות.