REST Resource: settings.datasources
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Recurso: DataSource
La fuente de datos es un espacio de nombres lógico para los elementos que se indexarán. Todos los elementos deben pertenecer a un origen de datos. Este es el requisito previo para que los elementos se puedan indexar en Cloud Search.
Representación JSON |
{
"name": string,
"displayName": string,
"shortName": string,
"indexingServiceAccounts": [
string
],
"disableServing": boolean,
"disableModifications": boolean,
"itemsVisibility": [
{
object (GSuitePrincipal )
}
],
"returnThumbnailUrls": boolean,
"operationIds": [
string
]
} |
Campos |
name |
string
Es el nombre del recurso de la fuente de datos. Formato: datasources/{sourceId}. El nombre se ignora cuando se crea una fuente de datos.
|
displayName |
string
Obligatorio. Es el nombre visible del origen de datos. La longitud máxima es de 300 caracteres.
|
shortName |
string
Un nombre corto o alias para la fuente. Este valor se usará para hacer coincidir el operador "source". Por ejemplo, si el nombre corto es <value>, las consultas como source:<value> solo mostrarán resultados para esta fuente. El valor debe ser único en todas las fuentes de datos. El valor solo debe contener caracteres alfanuméricos (a-zA-Z0-9). El valor no puede comenzar con “google” ni ser uno de los siguientes: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Su longitud máxima es de 32 caracteres.
|
indexingServiceAccounts[] |
string
Es la lista de cuentas de servicio que tienen acceso a la indexación.
|
disableServing |
boolean
Inhabilita la publicación de cualquier resultado de búsqueda o asistencia.
|
disableModifications |
boolean
Si es verdadero, establece la fuente de datos en modo de solo lectura. En el modo de solo lectura, la API de Indexing rechaza todas las solicitudes para indexar o borrar elementos de esta fuente. Habilitar el modo de solo lectura no detiene el procesamiento de los datos aceptados anteriormente.
|
itemsVisibility[] |
object (GSuitePrincipal )
Este campo restringe la visibilidad a los elementos a nivel del origen de datos. Los elementos del origen de datos se restringen a la unión de usuarios y grupos incluidos en este campo. Ten en cuenta que esto no garantiza el acceso a un elemento específico, ya que los usuarios deben tener permisos de LCA en los elementos contenidos. Esto garantiza un acceso de alto nivel a todo el origen de datos y que los elementos individuales no se compartan fuera de esta visibilidad.
|
returnThumbnailUrls |
boolean
Un usuario puede solicitar el URI de la miniatura de los elementos indexados en esta fuente de datos.
|
operationIds[] |
string
Son los IDs de las operaciones de larga duración (LRO) que se están ejecutando actualmente para este esquema.
|
Métodos |
|
Crea una fuente de datos. |
|
Borra una fuente de datos. |
|
Obtiene una fuente de datos. |
|
Muestra una lista de las fuentes de datos. |
|
Actualiza una fuente de datos. |
|
Actualiza una fuente de datos. |
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 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. |"]]