SharePoint

El conector de SharePoint proporciona acceso de SQL a los servicios y servidores de SharePoint.

Versiones compatibles

Este conector es compatible con Windows SharePoint Services 3.0, Microsoft Office SharePoint Server 2007 y versiones posteriores, y SharePoint Online.

Antes de comenzar

Antes de usar el conector de SharePoint, realiza las siguientes tareas:

  • En tu proyecto de Google Cloud, haz lo siguiente:
    • Asegúrate de que la conectividad de red esté configurada. Para obtener información sobre los patrones de red, consulta Conectividad de red.
    • Otorga el rol de IAM roles/connectors.admin al usuario que configure el conector.
    • Otorga los siguientes roles de IAM a la cuenta de servicio que deseas usar para el conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano que debe autenticarse y tener autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta Crea una cuenta de servicio.

    • Habilita los siguientes servicios:
      • secretmanager.googleapis.com (API de Secret Manager)
      • connectors.googleapis.com (API de conectores)

      Para comprender cómo habilitar servicios, consulta Habilita servicios.

    Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.

Configura el conector

Para configurar el conector, debes crear una conexión a tu fuente de datos (sistema de backend). Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, sigue estos pasos:

  1. En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.

    Ir a la página Conexiones

  2. Haz clic en + Crear nuevo para abrir la página Crear conexión.
  3. En la sección Ubicación, elige la ubicación para la conexión.
    1. Región: selecciona una ubicación de la lista desplegable.

      Entre las regiones admitidas para los conectores, se incluyen las siguientes:

      Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.

    2. Haz clic en Siguiente.
  4. En la sección Detalles de la conexión, completa lo siguiente:
    1. Conector: Selecciona SharePoint en la lista desplegable de conectores disponibles.
    2. Versión del conector: selecciona la versión del conector de la lista desplegable de versiones disponibles.
    3. En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir con los siguientes criterios:

      • Los nombres de las conexiones pueden usar letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
      • Los nombres de las conexiones no pueden superar los 49 caracteres.
    4. De manera opcional, ingresa una Descripción para la instancia de conexión.
    5. De manera opcional, habilita Cloud Logging y, luego, selecciona un nivel de registro. De forma predeterminada, el nivel de registro se establece en Error.
    6. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
    7. De manera opcional, configura los parámetros de nodo de conexión:

      • Cantidad mínima de nodos: Ingresa la cantidad mínima de nodos de conexión.
      • Cantidad máxima de nodos: Ingresa la cantidad máxima de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se requieren más nodos para procesar más transacciones para una conexión y, del mismo modo, se requieren menos para procesar menos transacciones. Para comprender cómo los nodos afectan el precio del conector, consulta Precios de nodos de conexión. Si no ingresas ningún valor, se establecen de forma predeterminada los nodos mínimos en 2 (para una mejor disponibilidad) y los nodos máximos se establecen en 50.

    8. De forma opcional, haz clic en + Agregar etiqueta para agregar una etiqueta a la conexión en forma de un par clave-valor.
    9. Haz clic en Siguiente.
  5. En la sección Destinos, ingresa los detalles del host remoto (sistema de backend) al que deseas conectarte.
    1. Tipo de destino: Selecciona un Tipo de destino. Por ejemplo, la dirección del host es https://xxxxx.sharepoint.com.
      • Selecciona Dirección de host en la lista para especificar el nombre de host o la dirección IP del destino.
      • Si deseas establecer una conexión privada a tus sistemas de backend, selecciona Adjunto de extremo en la lista y, luego, selecciona el archivo adjunto de extremo requerido en la lista Adjunto de extremo.

      Si deseas establecer una conexión pública a tus sistemas de backend con seguridad adicional, puedes configurar direcciones IP salientes estáticas para tus conexiones y, luego, configurar tus reglas de firewall para incluir en la lista de entidades permitidas solo las direcciones IP estáticas específicas.

      Para ingresar destinos adicionales, haz clic en +Agregar destino.

    2. Haz clic en Siguiente.
  6. En la sección Autenticación, ingresa los detalles de autenticación.
    1. Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.

      La conexión de SharePoint admite los siguientes tipos de autenticación:

      • Credenciales de Windows. Selecciona esta opción si usas la edición local de SharePoint.
      • AzureAD. Selecciona esta opción si usas la edición en línea de SharePoint.
      • Credenciales de cliente de OAuth 2.0 con portador de JWT. Selecciona esta opción si usas credenciales de cliente de OAuth 2.0 con portador de JWT para la autenticación.
      • Credenciales de cliente de OAuth 2.0 con secreto de cliente Selecciona esta opción si usas credenciales de cliente de OAuth 2.0 con secreto de cliente para la autenticación.

      2. Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.

    2. Haz clic en Siguiente.
  7. Revisa: Revisa tus detalles de conexión y autenticación.
  8. Haz clic en Crear.

Configura la autenticación

El conector de SharePoint admite los siguientes tipos de autenticación:

Tipo de autenticación de credenciales de Windows

Para habilitar el tipo de autenticación de credenciales de Windows, debes completar los siguientes pasos:
  1. Configura PSC y crea un archivo adjunto de extremo.
  2. Especifica las credenciales en Google Cloud.

Configura PSC y crea un adjunto de extremo

  1. Crea un grupo de instancias con la IP en la que se aloja SharePoint.
  2. Crea un balanceador de cargas de red de transferencia interno y usa el grupo de instancias que creaste como backend. El balanceador de cargas interno de TCP debe tener habilitado el acceso global.
  3. Publica el balanceador de cargas en Private Service Connect. Se genera un archivo adjunto de servicio después de que se publica el balanceador de cargas.
  4. Publica el servicio y especifica el balanceador de cargas que creaste.
  5. Usa el archivo adjunto del servicio para crear un archivo adjunto de extremo.
  6. Después de crear el adjunto del extremo, crea una conexión de SharePoint con la IP del adjunto del extremo.

    7. Para obtener más información sobre cómo crear un archivo adjunto de extremo, consulta Crea un archivo adjunto de extremo.

Especifica los detalles de las credenciales de Windows en Google Cloud

Cuando crees la conexión en Conectores de integración , debes especificar los siguientes detalles:

En la sección Autenticación, selecciona Credenciales de Windows como el tipo de autenticación y, luego, ingresa los siguientes detalles:

  • Nombre de usuario: Ingresa el nombre de usuario.
  • Contraseña: Selecciona la contraseña.
  • Versión del Secret: Ingresa la versión del Secret.

Tipo de conexión de credenciales de Windows

En la siguiente tabla, se enumeran los valores de configuración de muestra para el tipo de conexión de credenciales de Windows.
Nombre del campo Detalles
Región us-central1
Conector SharePoint
Versión del conector 1
Nombre de la conexión sharepoint-staging-psc
Cuenta de servicio SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Cantidad mínima de nodos 2
Cantidad máxima de nodos 50
Tipo de destino Dirección del host
host 1 http://192.0.2.0
puerto 1 24
Autenticación Credenciales de Windows
Nombre de usuario USER_NAME
Contraseña CONTRASEÑA
Versión del Secret 1

Tipo de autenticación de Azure AD

Para habilitar el tipo de autenticación de Azure AD, debes completar los siguientes pasos:
  1. Registra tu app y obtén OAuthClientId y OAuthClientSecret.
  2. Especifica las credenciales en Google Cloud.
  3. Autoriza la conexión en Google Cloud.
  4. Agrega la URL de redireccionamiento a tu app.

Registra tu app y obtén OAuthClientId y OAuthClientSecret

Para registrar tu app y obtener el OAuthClientId y el OAuthClientSecret, haz lo siguiente:
  1. Accede al portal de Azure.
  2. En Servicios de Azure, selecciona Registros de apps y, luego, Nuevo registro.
  3. Ingresa un nombre de aplicación y selecciona Cualquier usuario de ID de Microsoft Entra: multiusuario. En la siguiente imagen, se muestra la página para registrar una aplicación:
  4. Después de crear la app, navega a la sección Certificados y secretos, crea un secreto de cliente para la aplicación y guarda el valor del secreto de cliente. En la siguiente imagen, se muestra la página Certificados y secretos:
  5. En Permisos de la API, selecciona los permisos de aplicación y los permisos delegados necesarios. Para que la conexión esté activa, debes otorgar el siguiente permiso mínimo:AllSites.Manage

    En la siguiente tabla, se enumeran los permisos necesarios para realizar operaciones en la aplicación.

    Permisos delegados Permisos de la app
    ConsentRequest.Read.All AllSites.FullControl
    ConsentRequest.ReadWrite.All AllSites.Manage
    DelegatedAdminRelationship.Read.All AllSites.Read
    DelegatedAdminRelationship.ReadWrite.All AllSites.Write
    DelegatedPermissionGrant.Read.All EnterpriseResource.Read
    DelegatedPermissionGrant.ReadWrite.All EnterpriseResource.Write
    Files.Read.All MyFiles.Read
    Files.ReadWrite.All MyFiles.Write
    Group.Create Project.Read
    Group.Read.All Project.Write
    Group.ReadWrite.All ProjectWebApp.FullControl
    Sites.FullControl.All ProjectWebAppReporting.Read
    Sites.FullControl.All Sites.FullControl.All
    Sites.Manage.All Sites.Manage.All
    Sites.Read.All Sites.Read.All
    Sites.ReadWrite.All Sites.ReadWrite.All
    Sites.Selected Sites.Search.All
    User.Export.All Sites.Selected
    User.Read TaskStatus.Submit
    User.Read.All TermStore.Read.All
    User.ReadWrite.All TermStore.Read.All
    TermStore.ReadWrite.All
    TermStore.ReadWrite.All
    User.Read.All
    User.Read.All
    User.ReadWrite.All
    User.ReadWrite.All
  6. Guarda los cambios.
  7. Si seleccionaste usar permisos que requieren el consentimiento del administrador, puedes otorgarlos desde el inquilino actual en la página Permisos de API. En la siguiente imagen, se muestra la página de permisos de la API:
  8. Para agregar el permiso, ve a la sección Expón una API, agrega los permisos AllSites.Manage, Sites.FullControl.All y selecciona quién puede controlarlos (administradores y usuarios). En la siguiente imagen, se muestra la página Exponer una API:
  9. Haz clic en Guardar.

Especifica las credenciales en Google Cloud

Cuando crees la conexión en Conectores de integración , debes especificar los siguientes detalles:

En la sección Autenticación, selecciona AzureAD como el tipo de autenticación y, luego, ingresa los siguientes detalles:

  • ID de cliente: Ingresa el ID de cliente que se usa para solicitar tokens de acceso.
  • Permisos: Ingresa una lista de permisos deseados separados por comas. Por ejemplo, Sites.FullControl.All
  • Secreto de cliente: Ingresa el secreto que contiene el secreto del cliente para la app conectada que creaste.
  • Versión del secreto: Es la versión del secreto que seleccionaste anteriormente.
  • URL de autorización: Es la URL de autorización que se genera cuando se crea el cliente. Ingresa la URL con el siguiente formato: https://login.microsoftonline.com/<tenant_identifier>/oauth2/v2.0/authorize. Por ejemplo, https://login.microsoftonline.com/9bxxxxxxxxx8112/oauth2/v2.0/authorize.

Autoriza la conexión en Google Cloud

  1. En la página Conexiones, busca la conexión recién creada.

    El Estado del nuevo conector será Se requiere autorización.

  2. Haz clic en Se requiere autorización.

    Se mostrará el panel Editar autorización.

  3. Copia el valor del URI de redireccionamiento en tu aplicación externa. Para obtener más información, consulta Cómo agregar la URL de redireccionamiento a tu app.
  4. Verifica los detalles de la autorización.
  5. Haz clic en Autorizar.

    Si la autorización se realiza correctamente, el estado de la conexión se establecerá como Activa en la página Conexiones.

Agrega la URL de redireccionamiento a tu app

  1. En el portal de Azure, haz clic en Servicios de Azure > Registros de apps.
  2. Haz clic en el nombre de tu app.
  3. Haz clic en Agregar URI de redireccionamiento.
  4. Haz clic en Agregar una plataforma.
  5. En el diálogo Web, pega el URI de redireccionamiento que copiaste cuando autorizaste la conexión en Google Cloud.

Tipo de conexión de Azure AD

En la siguiente tabla, se muestran los valores de configuración de muestra para el tipo de conexión de Azure AD:
Nombre del campo Detalles
Región us-central1
Conector SharePoint
Versión del conector 1
Nombre de la conexión sharepoint-google-cloud-con
Cuenta de servicio SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Cantidad mínima de nodos 2
Cantidad máxima de nodos 50
Tipo de destino Dirección del host
host 1 http://z8**.sharepoint.com
Autenticación AzureAD
ID de cliente CLIENT_ID
Permisos Sites.FullControl.All
Secreto del cliente CLIENT_SECRET
Versión del Secret 1
URL de autorización https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/authorize

OAuth 2.0: credenciales de cliente con el tipo de autenticación de portador de JWT

Para habilitar OAuth 2.0: credenciales de cliente con el tipo de autenticación de portador de JWT, debes completar los siguientes pasos:
  1. Crea un certificado.
  2. Sube el certificado al portal de Azure.
  3. Obtén una clave privada.
  4. Completa la configuración.
  5. Especifica las credenciales de portador de JWT de OAuth 2.0 en Google Cloud.

Para habilitar el tipo de autenticación de portador de JWT, debes crear un certificado, subirlo al portal de Azure y, luego, obtener una clave privada.

Crear un certificado

  1. Crea una carpeta vacía en tu computadora.
  2. Crea un archivo de texto en la carpeta.
  3. Copia la secuencia de comandos de PowerShell de la página Otorgar acceso a través de la app de Azure AD y pégala en el archivo de texto.
  4. Cambia el nombre del archivo de texto por Create-SelfSignedCertificate.ps1.
  5. Ejecuta Windows PowerShell en la carpeta.
  6. Ve al directorio que contiene el archivo de texto.
  7. Copia el siguiente comando: .\Create-SelfSignedCertificate.ps1 -CommonName "CERTIFICATE_NAME" -StartDate 2022-09-25 -EndDate 2023-10-25

    Ingresa un nombre único para CERTIFICATE_NAME. Cambia StartDate a la fecha actual y EndDate a la fecha que elijas.

  8. Pega el comando copiado con los cambios en Windows PowerShell y, luego, presiona Intro.

    Windows PowerShell solicita que ingreses la contraseña para proteger la clave privada. Asegúrate de guardar la contraseña para usarla más adelante.

    Windows PowerShell crea dos archivos: MyCertificate.pfx y MyCertificate.cer.

Sube el certificado al portal de Azure

  1. Accede al portal de Azure y registra una nueva aplicación especificando los siguientes detalles:
    • Nombre: Ingresa un nombre para la aplicación.
    • Tipos de cuentas compatibles: Selecciona Cuentas solo en este directorio de la organización (solo el nombre de la cuenta: inquilino único).
  2. Ve a Permisos de API > Agregar permiso > Solicitar permisos de API > SharePoint.
  3. Selecciona Permisos de la aplicación y, luego, agrega los permisos necesarios.
  4. Selecciona Otorgar consentimiento del administrador y, luego, Sí.
  5. Después de crear la app, navega a la sección Certificates & Secrets.
  6. Selecciona Upload Certificate y, luego, sube tu certificado CER desde la computadora. Cuando finalice la carga, selecciona Agregar.

    No agregues secretos de cliente en la app, ya que interfieren con el flujo de autenticación basado en certificados.

  7. Ve a Manifest, busca KeyCredentials y, luego, copia el customKeyIdentifier como la huella digital. Lo usarás más adelante. Ya registraste la app y vinculaste el certificado.

Cómo obtener una clave privada

Para obtener una clave privada, convierte el archivo PFX en un archivo PEM con OpenSSL.

  1. Desde el símbolo del sistema, ve a la carpeta con el archivo PFX y ejecuta el siguiente comando: openssl pkcs12 -in MyCertificate.pfx -out MyCertificate.pem -nodes
  2. Ingresa la contraseña de PFX que usaste en el proceso de creación del certificado.
  3. Abre el archivo PEM en un editor de texto y copia la siguiente sección de la clave privada: 
    -----BEGIN PRIVATE KEY----- 

-----END PRIVATE KEY-----

Completa la configuración

  1. Copia el ID de cliente y el ID de usuario de la app registrada recientemente en el portal de Azure.
  2. Accede con la autenticación de principal de servicio de la lista de SharePoint con las siguientes credenciales:
    • ID de cliente
    • ID de usuario
    • Clave privada
    • Huella digital (contraseña de clave privada)

Especifica las credenciales de portador de JWT de OAuth 2.0 en Google Cloud

Cuando crees la conexión en Conectores de integración , debes especificar los siguientes detalles:

En la sección Authentication, selecciona OAuth 2.0 client credentials with JWT bearer como el tipo de autenticación y, luego, ingresa los siguientes detalles:

  • ID de cliente: Ingresa el ID de cliente que se usa para solicitar tokens de acceso. Esta es la clave de consumidor que se generó cuando registraste la app en el portal de Azure.
  • Clave privada: Selecciona el Secret de Secret Manager que contiene el contenido del archivo de clave privada en formato PEM. La clave privada debe coincidir con la clave o el certificado públicos que se proporcionan al conector.
  • Versión del secreto: Es la versión del secreto que seleccionaste anteriormente.
  • Contraseña de la clave privada: Selecciona el Secret de Secret Manager que contiene la contraseña (parafraseo) del archivo de clave privada.
  • Versión del secreto: Es la versión del secreto que seleccionaste anteriormente.
  • Usuario de Azure: Es el usuario de Microsoft Online que se usa para acceder a los datos.

Tipo de conexión de certificado portador de JWT

En la siguiente tabla, se enumeran los valores de configuración de muestra para el tipo de conexión de certificado de portador de JWT de OAuth 2.0.
Nombre del campo Detalles
Región europe-west1
Conector SharePoint
Versión del conector 1
Nombre de la conexión sharepoint-jwt-certificate
Cuenta de servicio SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Cantidad mínima de nodos 2
Cantidad máxima de nodos 50
Tipo de destino Dirección del host
host 1 http://z8**.sharepoint.com
puerto 1 ****
Autenticación Credenciales de cliente de OAuth 2.0 con portador de JWT
ID de cliente de OAuth CLIENT_ID
Clave privada CLAVE
Versión del Secret 1
Contraseña de clave privada CONTRASEÑA
Versión del Secret 1
Usuario de Azure AZURE_TENANT_ID

OAuth 2.0: Tipo de conexión de secreto de cliente

Para habilitar el tipo de conexión de secreto de cliente de OAuth 2.0, debes completar los siguientes pasos:

  1. Registra el complemento.
  2. Otorga permisos al complemento.
  3. Especifica las credenciales de cliente de OAuth 2.0 en Google Cloud
  4. Cómo volver a autorizar el código de autorización

Registra el complemento

  1. Navega a la página Register Add-In con la siguiente URL: https://<SITE_NAME>.SharePoint.com/_layouts/15/appregnew.aspx.
  2. En la sección Información de la app, genera el ID de cliente y el secreto del cliente.
  3. Especifica los valores de Título, Dominio de la app y URI de redireccionamiento.
  4. Haz clic en Crear.Se registrará el complemento, y la app de SharePoint mostrará la información creada.

Otorga permisos al complemento

  1. Navega al sitio de SharePoint con la siguiente URL: https://<SITE_NAME>-admin.sharepoint.com/_layouts/15/appinv.aspx. Se te redireccionará a la página Otorgar permiso.
  2. En el campo ID de app, ingresa el ID de cliente que generaste antes y haz clic en Búsqueda. Se propagan los valores de Título, Dominio de la app y URL de redireccionamiento.
  3. Ingresa la siguiente solicitud de permiso en formato XML: 
    <AppPermissionRequests AllowAppOnlyPolicy="true">
<AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="FullControl"/>
</AppPermissionRequests>
  4. Haz clic en Crear. La app de Sharepoint muestra un diálogo de consentimiento de permisos.
  5. Haz clic en Confiar en este dispositivo.

Especifica las credenciales de cliente de OAuth 2.0 en Google Cloud

Cuando crees la conexión en Conectores de integración , debes especificar los siguientes detalles:

En la sección Authentication, selecciona OAuth 2.0 client credentials with client secret como el tipo de autenticación y, luego, ingresa los siguientes detalles:

  • ID de cliente: Ingresa el ID de cliente que proporciona el conector para la app que creaste.
  • Secreto de cliente: Selecciona el Secret de Secret Manager que contiene el secreto del cliente para la app conectada que creaste.
  • Versión del Secret: Selecciona la versión del secreto del cliente.

Cómo volver a autorizar el código de autorización

Si usas el tipo de autenticación Authorization code y realizaste cambios de configuración en tu aplicación de SharePoint, debes volver a autorizar tu conexión de SharePoint. Para volver a autorizar una conexión, sigue estos pasos:

  1. Haz clic en la conexión requerida en la página Conexiones.

    Se abrirá la página de detalles de la conexión.

  2. Haz clic en Editar para editar los detalles de la conexión.
  3. Verifica los detalles de OAuth 2.0: Código de autorización en la sección Autenticación.

    Si es necesario, realiza los cambios necesarios.

  4. Haz clic en Guardar. Esto te llevará a la página de detalles de la conexión.
  5. Haz clic en Editar autorización en la sección Autenticación. Se mostrará el panel Autorizar.
  6. Haz clic en Autorizar.

    Si la autorización se realiza correctamente, el estado de la conexión se establecerá como Activa en la página Conexiones.

Tipo de conexión de credenciales de cliente

En la siguiente tabla, se enumeran los valores de configuración de muestra para el tipo de conexión de credenciales de cliente de OAuth 2.0.
Nombre del campo Detalles
Región europe-west1
Conector SharePoint
Versión del conector 1
Nombre de la conexión sharepoint-client-credentials
Cuenta de servicio SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Cantidad mínima de nodos 2
Cantidad máxima de nodos 50
Tipo de destino Dirección del host
host 1 http://z8**.sharepoint.com
puerto 1 ****
Autenticación Credenciales de cliente de OAuth 2.0 con secreto del cliente
ID de cliente CLIENT_ID
Secreto del cliente CLIENT_SECRET
Versión del Secret 1

Entidades, operaciones y acciones

Todos los Integration Connectors proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se expone como entidades, operaciones y acciones.

  • Entidades: Una entidad puede considerarse como un objeto o una colección de propiedades en la aplicación o servicio conectados. La definición de una entidad difiere de conector a conector. Por ejemplo, en un conector de bases de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; en un conector de sistema de mensajería, las colas son las entidades.

    Sin embargo, es posible que un conector no admita o tenga ninguna entidad, en cuyo caso la lista Entities estará vacía.

  • Operaciones: Una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:

    Cuando se selecciona una entidad de la lista disponible, se genera una lista de operaciones disponibles para esa entidad. Para obtener una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea de conectores. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, estas operaciones no compatibles no se incluyen en la lista Operations.

  • Acción: Una acción es una función de primera clase que está disponible para la integración mediante la interfaz de Conectores. Una acción te permite realizar cambios en una entidad o entidades y variar de un conector a otro. Por lo general, una acción tendrá algunos parámetros de entrada y un parámetro de salida. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Acciones

En esta sección, se enumeran algunas de las acciones que admite el conector. Para comprender cómo configurar las acciones, consulta Ejemplos de acciones.

Acción DeleteAttachment

Esta acción borra un archivo adjunto.

Parámetros de entrada de la acción DeleteAttachment

Nombre del parámetro Tipo de datos Obligatorio Descripción
ListTitle String Sí Es el título del elemento de la lista.
ItemId String Sí Es el ID del elemento de la lista.
Nombre del archivo String Sí Es el nombre del archivo que se borrará de la biblioteca de documentos.

Para comprender cómo configurar la acción DeleteAttachment, consulta Ejemplos de acciones.

Acción CheckInDocument

Esta acción te permite registrar un documento.

Parámetros de entrada de la acción CheckInDocument

Nombre del parámetro Tipo de datos Obligatorio Descripción
RelativeURL String Sí Es la URL relativa de la carpeta.
DocumentName String Sí Es el nombre del archivo que se registrará.
Comentario String No Es un mensaje de registro de entrada opcional.

Para comprender cómo configurar la acción CheckInDocument, consulta Ejemplos de acciones.

Acción CheckOutDocument

Esta acción te permite consultar un archivo.

Parámetros de entrada de la acción CheckOutDocument

Nombre del parámetro Tipo de datos Obligatorio Descripción
RelativeURL String Sí Es la URL relativa de la carpeta.
DocumentName String Sí Es el nombre del archivo que se va a revisar.

Para comprender cómo configurar la acción CheckOutDocument, consulta Ejemplos de acciones.

Acción DiscardCheckOutDocument

Esta acción te permite deshacer el check out de un archivo.

Parámetros de entrada de la acción DiscardCheckOutDocument

Nombre del parámetro Tipo de datos Obligatorio Descripción
RelativeURL String Sí Es la URL relativa de la carpeta.
DocumentName String Sí Es el nombre del archivo para el que se debe deshacer el check out.

Para comprender cómo configurar la acción DiscardCheckOutDocument, consulta Ejemplos de acciones.

Acción CopyDocument

Esta acción te permite copiar un archivo de una ubicación a otra.

Parámetros de entrada de la acción CopyDocument

Nombre del parámetro Tipo de datos Obligatorio Descripción
SourceFileRelativeUrl String Sí Es la URL relativa del archivo de origen.
DestFileRelativeUrl String Sí Es la URL relativa del archivo de destino.

Para comprender cómo configurar la acción CopyDocument, consulta Ejemplos de acciones.

Acción UploadDocument

Esta acción te permite subir un archivo.

Parámetros de entrada de la acción UploadDocument

Nombre del parámetro Tipo de datos Obligatorio Descripción
Nombre del archivo String Sí Es el nombre del archivo que se subirá.
RelativeUrl String Sí Es la URL relativa de la carpeta.
Contenido String No Es el contenido que se subirá como un archivo.
ContentBytes String No Es el contenido de bytes (como una cadena de Base64) que se subirá como un archivo. Úsala para subir datos binarios.
HasBytes Booleano No Especifica si el contenido que se subirá es binario. El valor predeterminado es false.

Para comprender cómo configurar la acción UploadDocument, consulta Ejemplos de acciones.

Acción DownloadDocument

Esta acción te permite descargar un archivo.

Parámetros de entrada de la acción DownloadDocument

Nombre del parámetro Tipo de datos Obligatorio Descripción
RemoteFile String Sí Es la URL completa del archivo que se descargará.
Biblioteca String Sí Es el nombre de la biblioteca en el servidor de SharePoint.
HasBytes Booleano No Especifica si el contenido se debe descargar como bytes. El valor predeterminado es false.

Para comprender cómo configurar la acción DownloadDocument, consulta Ejemplos de acciones.

Acción MoveAttachmentOrDocument

Esta acción te permite mover un archivo de una carpeta a otra.

Parámetros de entrada de la acción MoveAttachmentOrDocument

Nombre del parámetro Tipo de datos Obligatorio Descripción
SourceFileURL String Sí Es la URL del archivo de origen que se debe mover.
DestinationFolderURL String Sí Es la URL de la carpeta de destino.

Para comprender cómo configurar la acción MoveAttachmentOrDocument, consulta Ejemplos de acciones.

Acción CreateFolder

Esta acción te permite crear una carpeta.

Parámetros de entrada de la acción CreateFolder

Nombre del parámetro Tipo de datos Obligatorio Descripción
RelativeURL String Sí Es la URL relativa de la carpeta.
FolderName String Sí Es el nombre de la carpeta que se creará.

Para comprender cómo configurar la acción CreateFolder, consulta Ejemplos de acciones.

Acción AddAttachments

Esta acción te permite agregar un archivo adjunto.

Parámetros de entrada de la acción AddAttachments

Nombre del parámetro Tipo de datos Obligatorio Descripción
ListTitle String Sí Es el nombre de la lista de archivos adjuntos.
Nombre del archivo String Sí Es el nombre del archivo adjunto.
ItemId String Sí Es el ID del archivo adjunto que se agregará.
Contenido String Sí Contenido del archivo adjunto.
ContentBytes String No Es el contenido de bytes (como una cadena de Base64) que se subirá como archivo adjunto. Úsala para subir datos binarios.
HasBytes Booleano No Especifica si el contenido que se subirá es binario. El valor predeterminado es false.

Para comprender cómo configurar la acción AddAttachments, consulta Ejemplos de acciones.

Acción DownloadAttachments

Esta acción te permite descargar archivos adjuntos.

Parámetros de entrada de la acción DownloadAttachments

Nombre del parámetro Tipo de datos Obligatorio Descripción
RemoteFile String Sí Es la URL relativa del archivo.
HasBytes Booleano No Especifica si el contenido que se descargará es binario. El valor predeterminado es false.

Para comprender cómo configurar la acción DownloadAttachments, consulta Ejemplos de acciones.

Ejemplos de acciones

En esta sección, se describe cómo realizar algunas de las acciones de este conector.

Ejemplo: Borra un archivo adjunto

En este ejemplo, se borra el archivo especificado.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DeleteAttachment y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"ListTitle": "My lists",
"ItemId": "1",
"FileName": "sitepages.txt"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea DeleteAttachment tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: Cómo revisar un documento

En este ejemplo, se revisa un documento.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción CheckInDocument y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.txt",
"Comment": "Comment test"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea CheckInDocument tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: Cómo consultar un archivo

En este ejemplo, se revisa un archivo.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción CheckOutDocument y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.txt"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea CheckOutDocument tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: Cómo descartar un retiro

En este ejemplo, se revierte el check out de un archivo.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DiscardCheckOutDocument y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.docx"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea DiscardCheckOutDocument tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: Cómo copiar un archivo

En este ejemplo, se copia un archivo de una ubicación a otra.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción CopyDocument y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"SourceFileRelativeUrl": "/Shared Documents/Document.docx",
"DestFileRelativeUrl": "/Shared Documents/TestFolder/Document123.docx"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea CopyDocument tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: Sube un archivo de texto

En este ejemplo, se sube un archivo de texto a la ubicación especificada.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción UploadDocument y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"FileName": "test.txt",
"RelativeUrl": "/Shared Documents/TestFolder",
"Content": "abcd"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea UploadDocument tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: Cómo subir un archivo binario

En este ejemplo, se sube un archivo binario a la ubicación especificada. Cuando subas un archivo binario, especifica el contenido que deseas subir como una cadena codificada en Base64.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción UploadDocument y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"FileName": "test.txt",
"RelativeUrl": "/Shared Documents/TestFolder",
"ContentBytes": "SGVsbG8gd29ybGQK",
"HasBytes": "true"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea UploadDocument tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: Cómo descargar un archivo

En este ejemplo, se descarga un archivo.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DownloadDocument y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"RemoteFile": "/TestFolder/test.txt",
"Library": "Shared Documents"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea DownloadDocument tendrá un valor similar al siguiente:

    [{
"Success": "True",
"Content": "Test File",
}]

Ejemplo: Cómo descargar un archivo binario

En este ejemplo, se descarga un archivo binario.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DownloadDocument y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"RemoteFile": "/TestFolder/test1.png",
"Library": "Shared Documents"
"HasBytes": "true"  
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea DownloadDocument tendrá un valor similar al siguiente:

    [{
"Success": "True",
"ContentBytes": "VGVzdCBGaWxl",
}]

Ejemplo: Cómo mover un archivo adjunto

En este ejemplo, se mueve un archivo adjunto de una ubicación a otra.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción MoveAttachmentOrDocument y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"SourceFileURL": "/Shared Documents/test.txt",
"DestinationFolderURL": "/Shared Documents/TestFolder"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea MoveAttachmentOrDocument tendrá un valor similar al siguiente:

    [{
"Result": "Success"
}]

Ejemplo: Cómo crear una carpeta

En este ejemplo, se crea una carpeta en la ubicación especificada.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción CreateFolder y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"FolderName": "TestFolder123"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea CreateFolder tendrá un valor similar al siguiente:

    [{
"Id": "110842b7-2393-4f11-9391-3d75214e9fb8",
"Status": "Success"
}]

Ejemplo: Cómo agregar un archivo adjunto

En este ejemplo, se agrega un archivo adjunto a la lista especificada.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción AddAttachments y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"ListTitle": "My Lists",
"FileName": "TestAttachment2",
"Content": "abcd text",
"ItemId": "1"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea AddAttachments tendrá un valor similar al siguiente:

    [{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment2",
"Status": "Success"
}]

Ejemplo: Agrega un archivo adjunto binario

En este ejemplo, se agrega un archivo adjunto binario a la lista especificada.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción AddAttachments y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"ListTitle": "My Lists",
"FileName": "TestAttachment3",
"ContentBytes": "VGVzdCBGaWxl",
"HasBytes": "true",  
"ItemId": "1"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea AddAttachments tendrá un valor similar al siguiente:

    [{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment3",
"Status": "Success"
}]

Ejemplo: Cómo descargar un archivo adjunto

En este ejemplo, se descarga un archivo adjunto.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DownloadAttachments y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"RemoteFile": "/Shared Documents/Document.txt"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea DownloadAttachments tendrá un valor similar al siguiente:

    [{
"Success": "True",
"Content": "Test File",
}]

Ejemplo: Cómo descargar un archivo adjunto binario

En este ejemplo, se descarga un archivo adjunto binario.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DownloadAttachments y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"RemoteFile": "/Shared Documents/Document.docx",
"HasBytes": "true"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea DownloadAttachments tendrá un valor similar al siguiente:

    [{
"Success": "True",
"ContentBytes": "VGVzdCBGaWxl",
}]

Ejemplos de operaciones de entidades

En esta sección, se muestra cómo realizar algunas de las operaciones de la entidad en este conector.

Ejemplo: Muestra una lista de todos los archivos

En este ejemplo, se enumeran todos los archivos de la entidad Files.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Files en la lista Entity.
  3. Selecciona la operación List y haz clic en Listo.
  4. De forma opcional, en la sección Entrada de tarea de la tarea Conectores, puedes filtrar tu conjunto de resultados especificando una cláusula de filtro. También puedes especificar varias condiciones de filtro con los operadores lógicos.

Ejemplo: Cómo obtener una lista

En este ejemplo, se obtiene una lista con el ID especificado de la entidad My Lists.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona My Lists en la lista Entity.
  3. Selecciona la operación Get y haz clic en Listo.
  4. En la sección Task Input de la tarea Connectors, haz clic en EntityId y, luego, ingresa 3 en el campo Default Value.

    Aquí, 3 es un valor de clave primaria en la entidad My Lists.

Ejemplo: Crea un registro

En este ejemplo, se crea un registro en la entidad My Lists.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona My Lists en la lista Entity.
  3. Selecciona la operación Create y haz clic en Listo.
  4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"AuthorId": 11.0, 
"BaseName": "3_",
"Attachments": false,
"Title": "Created List New"
}

    Si la integración se realiza de forma correcta, el campo connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [{
"ID": 3.0
}]

Ejemplo: Borra un registro

En este ejemplo, se borra el registro con el ID especificado en la entidad My Lists.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona My Lists en la lista Entity.
  3. Selecciona la operación Delete y haz clic en Listo.
  4. En la sección Task Input de la tarea Connectors, haz clic en entityId y, luego, ingresa 2 en el campo Default Value.

Usa la conexión de SharePoint en una integración

Después de crear la conexión, estará disponible en la integración de Apigee y en la integración de aplicaciones. Puedes usar la conexión en una integración a través de la tarea Connectors.

  • Para comprender cómo crear y usar la tarea Connectors en la integración de Apigee, consulta Tarea Connectors.
  • Para comprender cómo crear y usar la tarea Connectors en Application Integration, consulta Tarea Connectors.

Obtén ayuda de la Comunidad de Google Cloud

Puedes publicar tus preguntas y debatir sobre este conector en la comunidad de Google Cloud en Cloud Forums.

¿Qué sigue?