REST Resource: settings.datasources
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Ресурс: Источник данных
Источник данных — это логическое пространство имен для индексируемых элементов. Все элементы должны принадлежать источнику данных. Это необходимое условие для индексации элементов в Cloud Search.
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 индексирования отклоняет любые запросы на индексирование или удаление элементов в этом источнике. Включение режима только для чтения не останавливает обработку ранее принятых данных. |
itemsVisibility[] | object ( GSuitePrincipal ) Это поле ограничивает видимость элементов на уровне источника данных. Элементы в источнике данных ограничены объединением пользователей и групп, включенных в это поле. Обратите внимание, что это не гарантирует доступ к конкретному элементу, поскольку пользователям необходимо иметь разрешения ACL для содержащихся элементов. Это обеспечивает высокий уровень доступа ко всему источнику данных и то, что отдельные элементы не будут доступны за пределами этой видимости. |
returnThumbnailUrls | boolean Может ли пользователь запросить URI миниатюр для элементов, проиндексированных в этом источнике данных. |
operationIds[] | string Идентификаторы длительных операций (LRO), которые в данный момент выполняются для этой схемы. |
Методы |
---|
| Создает источник данных. |
| Удаляет источник данных. |
| Получает источник данных. |
| Перечисляет источники данных. |
| Обновляет источник данных. |
| Обновляет источник данных. |
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. 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. |"]]