REST Resource: settings.datasources
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
منبع: DataSource
منبع داده یک فضای نام منطقی برای مواردی است که باید نمایه شوند. همه موارد باید به یک منبع داده تعلق داشته باشند. این پیش نیاز قبل از ایندکس شدن موارد در جستجوی ابری است.
نمایندگی JSON |
---|
{
"name": string,
"displayName": string,
"shortName": string,
"indexingServiceAccounts": [
string
],
"disableServing": boolean,
"disableModifications": boolean,
"itemsVisibility": [
{
object (GSuitePrincipal )
}
],
"returnThumbnailUrls": boolean,
"operationIds": [
string
]
} |
فیلدها |
---|
name | string نام منبع داده. قالب: منابع داده/{sourceId}. هنگام ایجاد یک منبع داده، نام نادیده گرفته می شود. |
displayName | string مورد نیاز. نام نمایشی منبع داده حداکثر طول 300 کاراکتر است. |
shortName | string نام کوتاه یا نام مستعار برای منبع. این مقدار برای مطابقت با عملگر «source» استفاده خواهد شد. به عنوان مثال، اگر نام کوتاه <value> باشد، پرس و جوهایی مانند source:<value> فقط نتایج را برای این منبع برمی گرداند. مقدار باید در همه منابع داده منحصر به فرد باشد. مقدار فقط باید دارای نویسه های الفبایی باشد (a-zA-Z0-9). این مقدار نمیتواند با «google» شروع شود و نمیتواند یکی از موارد زیر باشد: نامه، gmail، اسناد، درایو، گروهها، سایتها، تقویم، hangouts، gplus، keep، افراد، تیمها. حداکثر طول آن 32 کاراکتر است. |
indexingServiceAccounts[] | string فهرست حسابهای خدماتی که دسترسی نمایهسازی دارند. |
disableServing | boolean غیرفعال کردن ارائه نتایج جستجو یا کمک. |
disableModifications | boolean اگر درست باشد، منبع داده را روی حالت فقط خواندنی تنظیم می کند. در حالت فقط خواندنی، API Indexing هرگونه درخواست برای فهرست یا حذف موارد در این منبع را رد می کند. فعال کردن حالت فقط خواندنی، پردازش دادههای پذیرفته شده قبلی را متوقف نمیکند. |
itemsVisibility[] | object ( GSuitePrincipal ) این فیلد دید را به موارد در سطح منبع داده محدود می کند. موارد موجود در منبع داده به اتحادیه کاربران و گروههای موجود در این قسمت محدود میشوند. توجه داشته باشید که این امر دسترسی به یک مورد خاص را تضمین نمی کند، زیرا کاربران باید مجوزهای ACL را در مورد موارد موجود داشته باشند. این امر دسترسی سطح بالایی را به کل منبع داده تضمین می کند و موارد منفرد خارج از این قابلیت مشاهده به اشتراک گذاشته نمی شوند. |
returnThumbnailUrls | boolean آیا کاربر می تواند درخواست کند URI تصویر کوچک برای موارد نمایه شده در این منبع داده را دریافت کند. |
operationIds[] | string شناسههای عملیات طولانی مدت (LRO) که در حال حاضر برای این طرح اجرا میشوند. |
روش ها |
---|
| یک منبع داده ایجاد می کند. |
| یک منبع داده را حذف می کند. |
| یک منبع داده دریافت می کند. |
| فهرست منابع داده |
| یک منبع داده را به روز می کند. |
| یک منبع داده را به روز می کند. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[],[],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. |"]]