REST Resource: settings.datasources
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
משאב: DataSource
מקור הנתונים הוא מרחב שמות לוגי לפריטים שרוצים להוסיף לאינדקס. כל הפריטים חייבים להיות שייכים למקור נתונים. זוהי התנאי המקדים להוספת פריטים לאינדקס של Cloud Search.
ייצוג ב-JSON |
{
"name": string,
"displayName": string,
"shortName": string,
"indexingServiceAccounts": [
string
],
"disableServing": boolean,
"disableModifications": boolean,
"itemsVisibility": [
{
object (GSuitePrincipal )
}
],
"returnThumbnailUrls": boolean,
"operationIds": [
string
]
} |
שדות |
name |
string
השם של משאב מקור הנתונים. הפורמט הוא datasources/{sourceId}. השם מתעלם כשיוצרים מקור נתונים.
|
displayName |
string
חובה. שם התצוגה של מקור הנתונים. האורך המקסימלי הוא 300 תווים.
|
shortName |
string
שם קצר או כינוי למקור. הערך הזה ישמש להתאמה לאופרטור 'source'. לדוגמה, אם השם המקוצר הוא <value>, שאילתות כמו source:<value> יחזירו תוצאות רק לגבי המקור הזה. הערך חייב להיות ייחודי בכל מקורות הנתונים. הערך חייב להכיל רק תווים אלפאנומריים (a-zA-Z0-9). הערך לא יכול להתחיל ב-'google' ולא יכול להיות אחד מהערכים הבאים: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. האורך המקסימלי שלו הוא 32 תווים.
|
indexingServiceAccounts[] |
string
רשימה של חשבונות שירות שיש להם גישה להוספה לאינדקס.
|
disableServing |
boolean
להשבית את הצגת תוצאות החיפוש או תוצאות העזרה.
|
disableModifications |
boolean
אם הערך הוא true, מקור הנתונים מוגדר למצב קריאה בלבד. במצב קריאה בלבד, ה-API של ההוספה לאינדקס דוחה את כל הבקשות להוספה של פריטים מהמקור הזה לאינדקס או למחיקה שלהם. הפעלת מצב קריאה בלבד לא עוצרת את העיבוד של נתונים שאושרו בעבר.
|
itemsVisibility[] |
object (GSuitePrincipal )
השדה הזה מגביל את החשיפה לפריטים ברמת מקור הנתונים. הפריטים במקור הנתונים מוגבלים לאיחוד של המשתמשים והקבוצות שכלולים בשדה הזה. חשוב לזכור שהפעולה הזו לא מבטיחה גישה לפריט ספציפי, כי למשתמשים צריכות להיות הרשאות ACL בפריטים הכלולים. כך מובטחת גישה ברמה גבוהה לכל מקור הנתונים, והפריטים הנפרדים לא משותפים מחוץ לחשיפה הזו.
|
returnThumbnailUrls |
boolean
האם משתמש יכול לבקש לקבל URI של תמונה ממוזערת עבור פריטים שנוספו לאינדקס במקור הנתונים הזה.
|
operationIds[] |
string
המזהים של הפעולות הארוכות (LROs) שפועלות כרגע בסכמה הזו.
|
Methods |
|
יצירת מקור נתונים. |
|
מחיקה של מקור נתונים. |
|
אחזור של מקור נתונים. |
|
הצגת רשימה של מקורות הנתונים. |
|
עדכון של מקור נתונים. |
|
עדכון של מקור נתונים. |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[],[],null,["# REST Resource: settings.datasources\n\n- [Resource: DataSource](#DataSource)\n - [JSON representation](#DataSource.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: DataSource\n--------------------\n\nDatasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"displayName\": string, \"shortName\": string, \"indexingServiceAccounts\": [ string ], \"disableServing\": boolean, \"disableModifications\": boolean, \"itemsVisibility\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/GSuitePrincipal) } ], \"returnThumbnailUrls\": boolean, \"operationIds\": [ string ] } ``` |\n\n| Fields ||\n|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The name of the datasource resource. Format: datasources/{sourceId}. The name is ignored when creating a datasource. |\n| `displayName` | `string` Required. Display name of the datasource The maximum length is 300 characters. |\n| `shortName` | `string` A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is *\\\u003cvalue\\\u003e* then queries like *source:\\\u003cvalue\\\u003e* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters. |\n| `indexingServiceAccounts[]` | `string` List of service accounts that have indexing access. |\n| `disableServing` | `boolean` Disable serving any search or assist results. |\n| `disableModifications` | `boolean` If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data. |\n| `itemsVisibility[]` | `object (`[GSuitePrincipal](/workspace/cloud-search/docs/reference/rest/v1/GSuitePrincipal)`)` This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility. |\n| `returnThumbnailUrls` | `boolean` Can a user request to get thumbnail URI for Items indexed in this data source. |\n| `operationIds[]` | `string` IDs of the Long Running Operations (LROs) currently running for this schema. |\n\n| Methods ------- ||\n|------------------------------------------------------------------------------------------|-----------------------|\n| ### [create](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/create) | Creates a datasource. |\n| ### [delete](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/delete) | Deletes a datasource. |\n| ### [get](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/get) | Gets a datasource. |\n| ### [list](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/list) | Lists datasources. |\n| ### [patch](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/patch) | Updates a datasource. |\n| ### [update](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/update) | Updates a datasource. |"]]