Method: settings.datasources.update

Actualiza una fuente de datos.

Nota: Para ejecutar esta API, se requiere una cuenta de administrador.

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 la 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. El nombre visible de la fuente de datos. La longitud máxima es de 300 caracteres.
source.shortName

string

Es 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 esa fuente. El valor debe ser único en todas las fuentes de datos. El valor debe contener solo caracteres alfanuméricos (a-zA-Z0-9). El valor no puede empezar con "google" ni puede ser uno de los siguientes: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, team. La 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 la búsqueda o la 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 Indexing rechaza las solicitudes de indexación o eliminación de elementos de esta fuente. La habilitación del modo de solo lectura no detiene el procesamiento de datos previamente aceptados.
source.itemsVisibility[]

object (GSuitePrincipal)

Este campo restringe la visibilidad de 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 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 sobre 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 una solicitud de usuario para obtener el URI en miniatura de los elementos indexados en esta fuente de datos.
source.operationIds[]

string

Los IDs 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.

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

  • Si updateMask no está vacío, solo se actualizarán los campos especificados en updateMask.
  • Si especificas un campo en updateMask, pero no especificas su valor en la fuente, ese campo se borrará.
  • 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 la autorización

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