Method: settings.datasources.update

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

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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>, שאילתות כמו source:<value> יחזירו תוצאות רק לגבי המקור הזה. הערך חייב להיות ייחודי בכל מקורות הנתונים. הערך חייב להכיל רק תווים אלפאנומריים (a-zA-Z0-9). הערך לא יכול להתחיל ב-'google' ולא יכול להיות אחד מהערכים הבאים: mail, ‏ gmail, ‏ docs, ‏ drive, ‏ groups, ‏ sites, ‏ calendar, ‏ hangouts, ‏ gplus, ‏ keep, ‏ people, ‏ teams. האורך המקסימלי שלו הוא 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

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