Method: settings.datasources.update

עדכון מקור נתונים.

הערה: כדי להפעיל את ה-API הזה צריך חשבון אדמין.

בקשת HTTP

PUT https://cloudsearch.googleapis.com/v1/settings/{source.name=datasources/*}

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
source.name

string

השם של משאב מקור הנתונים. פורמט: datasources/{sourceId}.

המערכת מתעלמת מהשם כשיוצרים מקור נתונים.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "source": {
    "name": string,
    "displayName": string,
    "shortName": string,
    "indexingServiceAccounts": [
      string
    ],
    "disableServing": boolean,
    "disableModifications": boolean,
    "itemsVisibility": [
      {

        // Union field gsuite_principal can be only one of the following:
        "gsuiteUserEmail": string,
        "gsuiteGroupEmail": string,
        "gsuiteDomain": boolean
        // End of list of possible types for union field gsuite_principal.
      }
    ],
    "returnThumbnailUrls": boolean,
    "operationIds": [
      string
    ]
  },
  "debugOptions": {
    object (DebugOptions)
  },
  "updateMask": string
}
שדות
source.displayName

string

חובה. שם תצוגה של מקור הנתונים. האורך המקסימלי הוא 300 תווים.
source.shortName

string

שם מקוצר או כינוי של המקור. הערך הזה ישמש להתאמה ל-'source' . לדוגמה, אם השם המקוצר הוא <value>, שאילתות כמו <value> יחזירו תוצאות רק עבור המקור הזה. הערך חייב להיות ייחודי בכל מקורות הנתונים. הערך חייב להכיל רק תווים אלפאנומריים (a-zA-Z0-9). הערך לא יכול להתחיל ב-google ולא יכול להיות אחת מהאפשרויות הבאות: mail, gmail, docs, Drive, קבוצות, אתרים, יומן, hangouts, gplus, Keep, אנשים, צוותים. האורך המקסימלי הוא 32 תווים.
source.indexingServiceAccounts[]

string

רשימה של חשבונות שירות שיש להם גישה להוספה לאינדקס.
source.disableServing

boolean

השבתת ההצגה של תוצאות חיפוש או תוצאות סיוע.
source.disableModifications

boolean

אם True, מקור הנתונים מוגדר למצב קריאה-בלבד. במצב קריאה בלבד, ה-API של ההוספה לאינדקס דוחה כל בקשה להוספה לאינדקס או למחיקה של פריטים במקור הזה. הפעלת מצב קריאה בלבד לא מפסיקה את העיבוד של נתונים שאושרו בעבר.
source.itemsVisibility[]

object (GSuitePrincipal)

השדה הזה מגביל את החשיפה לפריטים ברמת מקור הנתונים. הפריטים במקור הנתונים מוגבלים לאיחוד המשתמשים והקבוצות הכלולים בשדה הזה. הערה: הפעולה הזו לא מבטיחה גישה לפריט ספציפי, כי למשתמשים צריכות להיות הרשאות ACL לגבי הפריטים שבקובץ. כך אפשר להבטיח גישה ברמה גבוהה לכל מקור הנתונים, ושהפריטים הספציפיים לא ישותפו מחוץ לאזור החשיפה.
source.returnThumbnailUrls

boolean

משתמש יכול לבקש לקבל URI של תמונה ממוזערת עבור פריטים שנוספו לאינדקס במקור הנתונים הזה.
source.operationIds[]

string

המזהים של פעולות הריצה הממושכות (LROs) שפועלות כרגע בסכימה הזו.
debugOptions

object (DebugOptions)

אפשרויות נפוצות לניפוי באגים.
updateMask

string (FieldMask format)

חל רק על settings.datasources.patch.

מעדכנים את המסכה כדי לקבוע אילו שדות לעדכן. נתיבי שדות לדוגמה: name, displayName.

  • אם השדה updateMask לא ריק, רק השדות שצוינו ב-updateMask יעודכנו.
  • אם תציינו שדה ב-updateMask אבל לא תציינו את הערך שלו במקור, השדה הזה יימחק.
  • אם השדה 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

מידע נוסף זמין במדריך להרשאות.