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

Es el nombre del recurso de la fuente de datos. Formato: datasources/{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. Es el nombre visible del origen de datos. La longitud máxima es de 300 caracteres.
source.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.
source.indexingServiceAccounts[]

string

Es la lista de cuentas de servicio que tienen acceso a la indexación.
source.disableServing

boolean

Inhabilita la publicación de cualquier resultado de búsqueda o asistencia.
source.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.
source.itemsVisibility[]

object (GSuitePrincipal)

Este campo restringe la visibilidad de 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.
source.returnThumbnailUrls

boolean

Indica si un usuario puede solicitar el URI de la miniatura para los elementos indexados en esta fuente de datos.
source.operationIds[]

string

Son los IDs de las operaciones de larga duración (LRO) que se están ejecutando actualmente para este esquema.
debugOptions

object (DebugOptions)

Opciones de depuración comunes.
updateMask

string (FieldMask format)

Solo se aplica a settings.datasources.patch.

Máscara de actualización para controlar qué campos se actualizarán. Ejemplos de rutas de campo: name, displayName.

  • Si updateMask no está vacío, solo se actualizan los campos especificados en updateMask.
  • Si especificas un campo en updateMask, pero no especificas su valor en la fuente, ese campo se borra.
  • Si updateMask no está presente, está vacío o tiene el valor *, se actualizan 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.