Method: settings.datasources.update

Actualiza una fuente de datos.

Nota: Esta API requiere una cuenta de administrador para ejecutarse.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
source.name

string

El nombre del recurso de fuente de datos. Formato: fuentes de datos/{sourceId}.

El nombre se ignora cuando se crea una fuente de datos.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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
}
Campos
source.displayName

string

Obligatorio. Nombre visible de la fuente de datos La longitud máxima es de 300 caracteres.

source.shortName

string

Un nombre corto o un alias para la fuente. Este valor se usará para hacer coincidir la “fuente” como "autor" y "título" usando un operador lógico. Por ejemplo, si el nombre corto es <value>, las consultas como <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” y no puede ser una de las siguientes: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, equipos. Su longitud máxima es de 32 caracteres.

source.indexingServiceAccounts[]

string

Lista de cuentas de servicio que tienen acceso de indexación.

source.disableServing

boolean

Inhabilita la publicación de resultados de búsqueda o asistencia.

source.disableModifications

boolean

Si es verdadero, configura la fuente de datos en modo de solo lectura. En el modo de solo lectura, la API de indexación rechaza cualquier solicitud para indexar o borrar elementos de esta fuente. La habilitación del modo de solo lectura no detiene el procesamiento de los datos aceptados previamente.

source.itemsVisibility[]

object (GSuitePrincipal)

Este campo restringe la visibilidad a los elementos a nivel de la fuente de datos. Los elementos dentro de la fuente de datos están restringidos a la unión de los 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 necesitan tener permisos de LCA en los elementos contenidos. Esto garantiza un acceso de alto nivel a toda la fuente de datos y que los elementos individuales no se compartan fuera de esta visibilidad.

source.returnThumbnailUrls

boolean

Puede un usuario solicitar la obtención del URI de miniatura para elementos indexados en esta fuente de datos.

source.operationIds[]

string

Son los ID de las operaciones de larga duración (LRO) que se ejecutan actualmente para este esquema.

debugOptions

object (DebugOptions)

Opciones de depuración comunes.

updateMask

string (FieldMask format)

Solo se aplica a settings.datasources.patch.

Actualizar máscara para controlar qué campos actualizar. Rutas de campo de ejemplo: name, displayName.

  • Si updateMask no está vacío, solo se actualizan los campos especificados en el updateMask.
  • Si especificas un campo en updateMask, pero no su valor en la fuente, se borrará ese campo.
  • Si updateMask no está presente, está vacío o tiene el valor *, se actualizarán todos los campos.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

Alcances de autorización

Se necesita uno de los siguientes permisos de 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

Para obtener más información, consulta la Guía de autorización.