SharePoint

El conector de SharePoint te permite gestionar archivos, carpetas y archivos adjuntos en 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 empezar

En tu proyecto de Google Cloud, haz lo siguiente:

  • Asegúrate de que la conectividad de red esté configurada. Para obtener información, consulta Conectividad de red.
  • Concede el rol de gestión de identidades y accesos roles/connectors.admin al usuario que configure el conector.
  • Concede los roles de gestión de identidades y accesos roles/secretmanager.viewer y roles/secretmanager.secretAccessor a la cuenta de servicio que quieras usar para el conector:
  • Habilita secretmanager.googleapis.com (API Secret Manager) y connectors.googleapis.com (API Connectors). Para obtener más información, consulta Habilitar servicios.

Crear una conexión de SharePoint

Una conexión es específica de una fuente de datos. Esto significa que, si tiene muchas fuentes de datos, debe crear una conexión independiente para cada una de ellas. Para crear una conexión, sigue estos pasos:

  1. En la consola de Cloud, ve a la página Integration Connectors > Connections (Conectores de integración > Conexiones) y, a continuación, selecciona o crea un proyecto de Google Cloud.

    Ve a la página Conexiones.

  2. Haga clic en + Crear para abrir la página Crear conexión.
  3. En la sección Ubicación, selecciona una ubicación de la lista Región y, a continuación, haz clic en Siguiente.

    Para ver la lista de todas las regiones admitidas, consulta Ubicaciones.

  4. En la sección Detalles de la conexión, haz lo siguiente:
    1. Selecciona SharePoint en la lista de conectores.
    2. Seleccione una versión del conector en la lista Versión del conector.
    3. En el campo Nombre de conexión, introduce un nombre para la instancia de conexión. El nombre de la conexión puede contener letras minúsculas, números o guiones. El nombre debe empezar por una letra y terminar con una letra o un número, y no puede superar los 49 caracteres.
    4. Si quiere, puede introducir una Descripción para la instancia de conexión.
    5. También puedes habilitar Registro en la nube y, a continuación, seleccionar un nivel de registro. De forma predeterminada, el nivel de registro es Error.
    6. En el campo Cuenta de servicio, selecciona una cuenta que tenga los roles necesarios.
    7. Si quieres, configura los ajustes del nodo de conexión:

      • Número mínimo de nodos: introduce el número mínimo de nodos de conexión.
      • Número máximo de nodos: introduce el número máximo de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se necesitan más nodos para procesar más transacciones en una conexión y, a la inversa, se necesitan menos nodos para procesar menos transacciones. Para saber cómo influyen los nodos en el precio de tu conector, consulta la sección Precios de los nodos de conexión. Si no introduces ningún valor, de forma predeterminada, el número mínimo de nodos se establece en 2 (para mejorar la disponibilidad) y el máximo en 50.

    8. También puedes hacer clic en + Añadir etiqueta para añadir una etiqueta a la conexión en forma de par clave-valor.
    9. Haz clic en Siguiente.
  5. En la sección Destinos, introduce los detalles del host remoto (sistema backend) al que quieras conectarte y haz clic en Siguiente.
  6. En el campo Tipo de destino, selecciona un tipo de destino. Por ejemplo, la dirección del host es https://<SITE_NAME>.sharepoint.com.

    • Para especificar el nombre de host o la dirección IP de destino, selecciona Dirección de host y introduce la dirección en el campo Host 1.
    • Para establecer una conexión privada, selecciona Endpoint attachment (Endpoint adjunto) y elige el adjunto que quieras de la lista Endpoint Attachment (Endpoint adjunto).

    Si quieres establecer una conexión pública con tus sistemas backend con seguridad adicional, puedes configurar direcciones IP de salida estáticas para tus conexiones y, a continuación, configurar las reglas de tu cortafuegos para que solo se permitan las direcciones IP estáticas específicas.

    Para introducir más destinos, haz clic en +Añadir destino.

  7. En la sección Autenticación, introduce los detalles de autenticación.
    1. Seleccione un Tipo de autenticación e introduzca los detalles pertinentes.

      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 online de SharePoint.
      • Credenciales de cliente de OAuth 2.0 con token de portador JWT. Seleccione esta opción si usa credenciales de cliente de OAuth 2.0 con un token de portador 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 saber cómo configurar estos tipos de autenticación, consulta Configurar la autenticación.

    3. Haz clic en Siguiente.
  8. En la sección Revisar, comprueba los detalles de la conexión y la autenticación.
  9. Haz clic en Crear.

Configurar 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 seguir estos pasos:

  1. Configura PSC y crea un endpoint de conexión.
  2. Especifica las credenciales en Google Cloud.

Configurar PSC y crear un acoplamiento de endpoint

  1. Crea un grupo de instancias con la IP en la que se aloja SharePoint.
  2. Crea un balanceador de carga de red de paso a través interno y usa el grupo de instancias que has creado como backend. El balanceador de carga interno TCP debe tener habilitado el acceso global.
  3. Publica el balanceador de carga en Private Service Connect. Se genera un adjunto de servicio después de publicar el balanceador de carga.
  4. Publica el servicio y especifica el balanceador de carga que has creado.
  5. Usa el adjunto de servicio para crear un adjunto de endpoint.
  6. Después de crear el adjunto de endpoint, crea una conexión de SharePoint con la IP del adjunto de endpoint.
  7. Para obtener más información sobre cómo crear una vinculación de endpoint, consulta Crear una vinculación de endpoint.

Especifica los detalles de las credenciales de Windows en Google Cloud.

Cuando crees la conexión en Integration Connectors , debes especificar los siguientes detalles:

En la sección Authentication (Autenticación), selecciona Windows credentials (Credenciales de Windows) como tipo de autenticación y, a continuación, introduce los siguientes detalles:

  • Nombre de usuario: introduce el nombre de usuario.
  • Contraseña: selecciona la contraseña.
  • Versión del secreto: introduce la versión del secreto.

Tipo de conexión de credenciales de Windows

En la siguiente tabla se muestran los valores de configuración de ejemplo del 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
Número mínimo de nodos 2
Número máximo de nodos 50
Tipo de destino Dirección del host
Anfitrión 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 de secreto 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 aplicación y obtén el OAuthClientId y el OAuthClientSecret.
  2. Especifica las credenciales en Google Cloud.
  3. Autoriza la conexión en Google Cloud.
  4. Añade la URL de redirección a tu aplicación.

Registra tu aplicación y obtén OAuthClientId y OAuthClientSecret

Para registrar tu aplicación y obtener los valores de OAuthClientId y OAuthClientSecret de tu aplicación, haz lo siguiente:

  1. Inicia sesión en Azure Portal.
  2. En Servicios de Azure, selecciona Registros de aplicaciones y, a continuación, Nuevo registro.
  3. Introduce un nombre de aplicación y selecciona Cualquier cliente de Microsoft Entra ID (multitenant).
  4. Haz clic en Registrarse.
  5. Después de crear la aplicación, ve a la página Certificados y secretos.
  6. Crea un secreto de cliente para la aplicación y guarda su valor.
  7. Ve a la página Permisos de API.
  8. Haz clic en Añadir un permiso.
  9. En el cuadro de diálogo Solicitar permisos de API, selecciona la API, el tipo y los permisos de la tabla siguiente para realizar operaciones en la aplicación.
  10. Para que la conexión esté activa, debe conceder el permiso Sites.Read.All a la API Microsoft Graph.

    API Nombre del permiso Tipo
    Microsoft Graph ConsentRequest.Read.All Application/ Delegated
    Microsoft Graph ConsentRequest.ReadWrite.All Application/ Delegated
    Microsoft Graph DelegatedAdminRelationship.Read.All Application/ Delegated
    Microsoft Graph DelegatedAdminRelationship.ReadWrite.All Application/ Delegated
    Microsoft Graph DelegatedPermissionGrant.Read.All Application/ Delegated
    Microsoft Graph DelegatedPermissionGrant.ReadWrite.All Application/ Delegated
    Microsoft Graph Files.Read.All Application/ Delegated
    Microsoft Graph Files.ReadWrite.All Application/ Delegated
    Microsoft Graph Sites.FullControl.All Application/ Delegated
    Microsoft Graph Sites.Manage.All Application/ Delegated
    Microsoft Graph Sites.Read.All Application/ Delegated
    Microsoft Graph Sites.ReadWrite.All Application/ Delegated
    Microsoft Graph Sites.Selected Application/ Delegated
    Microsoft Graph TermStore.Read.All Application/ Delegated
    Microsoft Graph TermStore.ReadWrite.All Application/ Delegated
    Microsoft Graph User.Export.All Application/ Delegated
    Microsoft Graph User.Read Delegated
    Microsoft Graph User.Read.All Application/ Delegated
    Microsoft Graph User.ReadWrite.All Application/ Delegated
    SharePoint EnterpriseResource.Read Delegated
    SharePoint EnterpriseResource.Write Delegated
    SharePoint Project.Read Delegated
    SharePoint Project.Write Delegated
    SharePoint ProjectWebApp.FullControl Delegated
    SharePoint ProjectWebAppReporting.Read Delegated
    SharePoint TaskStatus.Submit Delegated
  11. Guarda los cambios.
  12. Si has seleccionado permisos que requieren el consentimiento de administrador, puedes concederlos desde el tenant actual en la página Permisos de API.
  13. Para añadir el ámbito, vaya a la sección Exponer una API, añada los ámbitos AllSites.Manage, Sites.FullControl.All y seleccione quién puede controlarlos (administradores y usuarios).
  14. Haz clic en Guardar.

Especifica las credenciales en Google Cloud.

Cuando crees la conexión en Integration Connectors , debes especificar los siguientes detalles:

En la sección Authentication (Autenticación), selecciona AzureAD como tipo de autenticación y, a continuación, introduce los siguientes detalles:

  • ID de cliente: introduce el ID de cliente que se usa para solicitar tokens de acceso.
  • Permisos: introduce una lista de permisos separados por comas. Por ejemplo, Sites.FullControl.All
  • Secreto de cliente: introduce el secreto que contiene el secreto de cliente de la aplicación conectada que has creado.
  • Versión del secreto: versión del secreto seleccionado arriba.
  • URL de autorización: la URL de autorización que generas al crear un cliente de OAuth. Introduce la URL con el siguiente formato: https://login.microsoftonline.com/TENANT_IDENTIFIER/oauth2/v2.0/authorize?prompt=consent. Por ejemplo, https://login.microsoftonline.com/9byyyyyyyyy8112/oauth2/v2.0/authorize?prompt=consent.

Autorizar la conexión en Google Cloud

  1. En la página Conexiones, busca la conexión que acabas de crear.

    El estado del nuevo conector será Autorización necesaria.

  2. Haz clic en Se requiere autorización.

    Se mostrará el panel Editar autorización.

  3. Copia el valor de URI de redirección en tu aplicación externa. Para obtener más información, consulta el artículo Añadir la URL de redirección a tu aplicación.
  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 será Activa en la página Conexiones.

Añade la URL de redirección a tu aplicación

  1. En el portal de Azure, haga clic en Servicios de Azure > Registros de aplicaciones.
  2. Haz clic en el nombre de tu aplicación.
  3. Haz clic en Añadir URI de redirección.
  4. Haz clic en Añadir una plataforma.
  5. En el cuadro de diálogo Web, pega el URI de redirección que has copiado al autorizar 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 ejemplo del tipo de conexión 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
Número mínimo de nodos 2
Número máximo de nodos 50
Tipo de destino Dirección del host
Anfitrión 1 http://z8**.sharepoint.com
Autenticación AzureAD
ID de cliente CLIENT_ID
Ámbitos Sites.FullControl.All
Secreto de cliente CLIENT_SECRET
Versión de secreto 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 JWT

Para habilitar OAuth 2.0 (credenciales de cliente) con el tipo de autenticación de token de portador JWT, debes seguir estos pasos:

  1. Crea un certificado.
  2. Sube el certificado a Azure Portal.
  3. Obtener una clave privada
  4. Completa la configuración.
  5. Especifica las credenciales de token web JSON (JWT) de OAuth 2.0 en Google Cloud.

Crear un certificado

  1. Crea una carpeta vacía en tu ordenador.
  2. Crea un archivo de texto en la carpeta.
  3. Copia la secuencia de comandos de PowerShell de la página Granting access via Azure AD App-Only (Conceder acceso solo a la aplicación mediante Azure AD) y pégala en el archivo de texto.
  4. Cambia el nombre del archivo de texto a 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

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

  8. Pega el comando copiado con los cambios en Windows PowerShell y, a continuación, pulsa Intro.

    Windows PowerShell te pedirá que introduzcas 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.

Subir el certificado a Azure Portal

  1. Inicia sesión en Azure Portal y registra una aplicación nueva especificando los siguientes detalles:
    • Nombre: introduce un nombre para la aplicación.
    • Tipos de cuenta admitidos: selecciona Solo cuentas de este directorio de la empresa (solo nombre de cuenta - cliente único).
  2. Ve a Permisos de API > Añadir permiso > Solicitar permisos de API > SharePoint.
  3. Selecciona Permisos de la aplicación y añade los permisos que necesites.
  4. Selecciona Conceder consentimiento de administrador y, a continuación, .
  5. Después de crear la aplicación, ve a la sección Certificados y secretos.
  6. Selecciona Subir certificado y, a continuación, sube el certificado CER desde tu ordenador. Cuando termine la subida, selecciona Añadir.

    No añadas secretos de cliente en la aplicación, ya que interfiere con el flujo de autenticación basada en certificados.

  7. Vaya a Manifest, busque KeyCredentials y copie el valor de customKeyIdentifier como huella digital. Lo usarás más adelante. Ya has registrado la aplicación y vinculado el certificado.

Obtener una clave privada

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

  1. En el símbolo del sistema, ve a la carpeta que contiene el archivo PFX y ejecuta el siguiente comando: openssl pkcs12 -in MyCertificate.pfx -out MyCertificate.pem -nodes
  2. Introduce la contraseña PFX que usaste en el proceso de creación del certificado.
  3. Abre el archivo PEM en un editor de texto y copia todo el texto, que es tu clave privada.

Completa la configuración

  1. Copia el ID de cliente y el ID de cliente de la aplicación que acabas de registrar en Azure Portal.
  2. Inicia sesión con la autenticación de la entidad de servicio de la lista de SharePoint con las siguientes credenciales:
    • ID de cliente
    • ID de cliente
    • Clave privada
    • Huella digital (contraseña de clave privada)

Especificar las credenciales de token de portador JWT de OAuth 2.0 en Google Cloud

Cuando crees la conexión en Integration Connectors , debes especificar los siguientes detalles:

En la sección Autenticación, selecciona Credenciales de cliente de OAuth 2.0 con token de portador JWT como tipo de autenticación y, a continuación, introduce los siguientes detalles:

  • En el campo ID de cliente, introduce el ID de cliente que se usa para solicitar tokens de acceso. Es la clave de consumidor que se genera al registrar la aplicación en el portal de Azure.
  • En el campo Clave privada, selecciona el secreto de Secret Manager que contiene el contenido del archivo de clave privada en formato PEM. La clave privada debe coincidir con la clave pública o el certificado proporcionado al conector.
  • En el campo Versión del secreto, selecciona la versión del secreto que has elegido más arriba.
  • En el campo Contraseña de clave privada, selecciona el secreto del gestor de secretos que contenga la contraseña (frase de contraseña) del archivo de clave privada. Usa la misma contraseña que definiste para proteger la clave privada cuando creaste el certificado.
  • En el campo Versión del secreto, selecciona la versión del secreto que has elegido más arriba.
  • En el campo Azure Tenant (Cliente de Azure), introduce el cliente online de Microsoft que se usa para acceder a los datos.

Tipo de conexión de certificado de portador JWT

En la siguiente tabla se muestran los valores de configuración de ejemplo del 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
Número mínimo de nodos 2
Número máximo de nodos 50
Tipo de destino Dirección del host
Anfitrión 1 http://z8**.sharepoint.com
puerto 1 ****
Autenticación Credenciales de cliente de OAuth 2.0 con token de portador JWT
ID de cliente de OAuth CLIENT_ID
Clave privada CLAVE
Versión de secreto 1
Contraseña de clave privada CONTRASEÑA
Versión de secreto 1
Cliente 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 seguir estos pasos:

  1. Registra el complemento.
  2. Concede permisos al complemento.
  3. Especificar las credenciales de cliente de OAuth 2.0 en Google Cloud
  4. Reautorización del código de autorización

Registrar el complemento

  1. Ve a la página Registrar complemento con la siguiente URL: https://<SITE_NAME>.SharePoint.com/_layouts/15/appregnew.aspx.
  2. En la sección Información de la aplicación, genera el ID de cliente y el secreto de cliente.
  3. Especifica los valores de Título, Dominio de la aplicación y URI de redirección.
  4. Haz clic en Crear.El complemento se registrará y la aplicación de SharePoint mostrará la información creada.

Conceder permisos al complemento

  1. Ve al sitio de SharePoint con la siguiente URL: https://<SITE_NAME>-admin.sharepoint.com/_layouts/15/appinv.aspx. Se te redirigirá a la página Conceder permiso.
  2. En el campo ID de aplicación, introduce el ID de cliente que has generado anteriormente y haz clic en Buscar. Los valores de Título, Dominio de la aplicación y URL de redirección se rellenan automáticamente.
  3. Introduce la siguiente solicitud de permiso en formato XML:
          <AppPermissionRequests AllowAppOnlyPolicy="true">
          <AppPermissionRequest Scope="http://sharepoint.com/content/tenant" Right="FullControl"/>
          </AppPermissionRequests>
            
  4. Haz clic en Crear. La aplicación de SharePoint muestra un cuadro de diálogo de consentimiento de permisos.
  5. Haz clic en Confiar.

Especificar las credenciales de cliente de OAuth 2.0 en Google Cloud

Cuando crees la conexión en Integration Connectors, debes especificar los siguientes detalles:

En la sección Autenticación, selecciona Credenciales de cliente de OAuth 2.0 con secreto de cliente como tipo de autenticación y, a continuación, introduce los siguientes detalles:

  • En el campo ID de cliente, introduce el ID de cliente que te ha proporcionado el conector de la aplicación que has creado.
  • En el campo Secreto de cliente, selecciona el secreto de Secret Manager que contenga el secreto de cliente de la aplicación conectada que has creado.
  • En el campo Versión del secreto, selecciona la versión del secreto de cliente.

Reautorización del código de autorización

Si usas el tipo de autenticación Authorization code y has hecho algún cambio en la configuración de 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. En la página Conexiones, haga clic en la conexión que quiera.

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

  2. Haz clic en Editar para modificar 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, haz los cambios pertinentes.

  4. Haz clic en Guardar. Se te dirigirá a la página de detalles de la conexión.
  5. En la sección Autenticación, haga clic en Editar autorización. Se muestra el panel Autorizar.
  6. Haz clic en Autorizar.

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

Tipo de conexión de credenciales de cliente

En la siguiente tabla se muestran los valores de configuración de ejemplo del 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
Número mínimo de nodos 2
Número máximo de nodos 50
Tipo de destino Dirección del host
Anfitrión 1 http://z8**.sharepoint.com
puerto 1 ****
Autenticación Credenciales de cliente de OAuth 2.0 con secreto de cliente
ID de cliente CLIENT_ID
Secreto de cliente CLIENT_SECRET
Versión de secreto 1

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

Una vez que hayas creado la conexión, estará disponible tanto en Apigee Integration como en Application Integration. Puedes usar la conexión en una integración a través de la tarea Conectores.

Acciones

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

Acción DeleteAttachment

Esta acción elimina un archivo adjunto.

Parámetros de entrada de la acción DeleteAttachment

Nombre del parámetro Tipo de datos Obligatorio Descripción
ListTitle Cadena Título del elemento de la lista.
ItemId Cadena ID del elemento de la lista.
FileName Cadena Nombre del archivo que se va a eliminar de la biblioteca de documentos.

Acción CheckInDocument

Esta acción te permite registrarte en un documento.

Parámetros de entrada de la acción CheckInDocument

Nombre del parámetro Tipo de datos Obligatorio Descripción
RelativeURL Cadena URL relativa de la carpeta.
DocumentName Cadena Nombre del archivo que se va a registrar.
Comentario Cadena No Un mensaje de confirmación opcional.

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 Cadena URL relativa de la carpeta.
DocumentName Cadena Nombre del archivo que se va a extraer.

Acción DiscardCheckOutDocument

Esta acción te permite deshacer la extracción de un archivo.

Parámetros de entrada de la acción DiscardCheckOutDocument

Nombre del parámetro Tipo de datos Obligatorio Descripción
RelativeURL Cadena URL relativa de la carpeta.
DocumentName Cadena Nombre del archivo para el que se debe deshacer la extracción.

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 Cadena URL relativa del archivo de origen.
DestFileRelativeUrl Cadena URL relativa del archivo de destino.

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
FileName Cadena Nombre del archivo que se va a subir.
RelativeUrl Cadena URL relativa de la carpeta.
Contenido Cadena No Contenido que se va a subir como archivo.
ContentBytes Cadena No Contenido de bytes (como una cadena Base64) que se va a subir como archivo. Úsalo para subir datos binarios.
HasBytes Booleano No Especifica si el contenido que se va a subir es binario. El valor predeterminado es false.

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 Cadena URL completa del archivo que se va a descargar.
Biblioteca Cadena 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.

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 Cadena URL del archivo de origen que se debe mover.
DestinationFolderURL Cadena URL de la carpeta de destino.

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 Cadena URL relativa de la carpeta.
FolderName Cadena Nombre de la carpeta que se va a crear.

Acción AddAttachments

Esta acción te permite añadir un archivo adjunto.

Parámetros de entrada de la acción AddAttachments

Nombre del parámetro Tipo de datos Obligatorio Descripción
ListTitle Cadena Nombre de la lista de archivos adjuntos.
FileName Cadena Nombre del archivo adjunto.
ItemId Cadena ID del archivo adjunto que se va a añadir.
Contenido Cadena Contenido del archivo adjunto.
ContentBytes Cadena No Contenido de bytes (como una cadena Base64) que se va a subir como archivo adjunto. Úsalo para subir datos binarios.
HasBytes Booleano No Especifica si el contenido que se va a subir es binario. El valor predeterminado es false.

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 Cadena URL relativa del archivo.
HasBytes Booleano No Especifica si el contenido que se va a descargar es binario. El valor predeterminado es false.

Ejemplos de acciones

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

Ejemplo: eliminar un archivo adjunto

En este ejemplo se elimina el archivo especificado.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción DeleteAttachment y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 connectorOutputPayload response de la tarea DeleteAttachment tendrá un valor similar al siguiente:

    [{
    "Status": "Success"
    }]

Ejemplo: registrarse en un documento

En este ejemplo se registra un documento.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción CheckInDocument y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 connectorOutputPayload response de la tarea CheckInDocument tendrá un valor similar al siguiente:

    [{
    "Status": "Success"
    }]

Ejemplo: consultar un archivo

En este ejemplo se extrae un archivo.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción CheckOutDocument y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 connectorOutputPayload response de la tarea CheckOutDocument tendrá un valor similar al siguiente:

    [{
    "Status": "Success"
    }]

Ejemplo: descartar una salida

En este ejemplo, se revierte la extracción de un archivo.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción DiscardCheckOutDocument y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 connectorOutputPayload response de la tarea DiscardCheckOutDocument tendrá un valor similar al siguiente:

    [{
    "Status": "Success"
    }]

Ejemplo: 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. Seleccione la acción CopyDocument y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 connectorOutputPayload response de la tarea CopyDocument tendrá un valor similar al siguiente:

    [{
    "Status": "Success"
    }]

Ejemplo: subir 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. Seleccione la acción UploadDocument y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 connectorOutputPayload response de la tarea UploadDocument tendrá un valor similar al siguiente:

    [{
    "Status": "Success"
    }]

Ejemplo: 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 quieras subir como una cadena codificada en Base64.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción UploadDocument y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 connectorOutputPayload response de la tarea UploadDocument tendrá un valor similar al siguiente:

    [{
    "Status": "Success"
    }]

Ejemplo: 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. Seleccione la acción DownloadDocument y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 connectorOutputPayload response de la tarea DownloadDocument tendrá un valor similar al siguiente:

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

Ejemplo: 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. Seleccione la acción DownloadDocument y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 connectorOutputPayload response de la tarea DownloadDocument tendrá un valor similar al siguiente:

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

Ejemplo: Descargar un archivo de un sitio específico

En este ejemplo se descarga un archivo de un sitio específico.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción DownloadDocument y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:
    {
      "RemoteFile": "	http://z8**.sharepoint.com/sites/SharepointGCS/Docs/SharpointGCS.docx",
      "Library": "Docs",
      "HasBytes": true
    }
    
  4. Si la acción se realiza correctamente, el parámetro connectorOutputPayload de la respuesta DownloadDocument tendrá un valor similar al siguiente:

    [
      {
        "Success": "True",
        "ContentBytes": "UEsDBAoAAAAAAAAAIQD/////TwEAAE8BAAAQAAAAW3RyYXNoXS8wMDAwLmRhdP////nFmjQeC1QbGmk9o7n0xjiLgudAMOrYQBpOZdZp5/OrWkWbudVPccasL5uVSKun3URrHAxow7iMUm2WSi7nlGy2Mr+sjJxQSrYFcFtDQyo/QSutWhbNcAODEWh14mklzxCS9C5CW3Fmwme/gMKGjGoXlSVyvtDoB+u0A6XtA8bkWTnPNHSvxcepoAKIdsR96imCvxe4MxOWqHWnQkLDyjNMOMrrQeMDF7nOMCCvPlVn5Vd6KlDYnHlW1zLOcQf6WmKl2xN4Z8WBXZfkrJZqPv6yNdWyp8ADRmgTdRSqDkPpQqzvqWj3qpdiRZqSwyBRtfr2kHBumkTNjSi6drBMFMxZEgrktw6ZxuEXcx3v16cXd6k5JVO3kOXMg/HFnH"
      }
    ]

    Para descargar un archivo de un sitio específico, debes proporcionar la dirección completa del archivo remoto.

Ejemplo: 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. Seleccione la acción MoveAttachmentOrDocument y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 connectorOutputPayload response de la tarea MoveAttachmentOrDocument tendrá un valor similar al siguiente:

    [{
    "Result": "Success"
    }]

Ejemplo: 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. Seleccione la acción CreateFolder y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 connectorOutputPayload response de la tarea CreateFolder tendrá un valor similar al siguiente:

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

Ejemplo: añadir un archivo adjunto

En este ejemplo se añade un archivo adjunto a la lista especificada.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción AddAttachments y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 connectorOutputPayload response de la tarea AddAttachments tendrá un valor similar al siguiente:

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

Ejemplo: añadir un archivo adjunto binario

En este ejemplo se añade un archivo adjunto binario a la lista especificada.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción AddAttachments y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 connectorOutputPayload response de la tarea AddAttachments tendrá un valor similar al siguiente:

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

Ejemplo: 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. Seleccione la acción DownloadAttachments y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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: 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. Seleccione la acción DownloadAttachments y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 entidad en este conector.

Ejemplo: listar 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, a continuación, haz clic en Hecho.
  4. Opcionalmente, en la sección Entrada de tarea de la tarea Conectores, puedes filtrar el conjunto de resultados especificando una cláusula de filtro. También puede especificar varias condiciones de filtro mediante operadores lógicos.

Ejemplo: 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, a continuación, haz clic en Hecho.
  4. En la sección Entrada de tarea de la tarea Conectores, haga clic en EntityId y, a continuación, introduzca 3 en el campo Valor predeterminado.

    En este caso, 3 es un valor de clave principal de la entidad My Lists.

Ejemplo: crear 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, a continuación, haz clic en Hecho.
  4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 correctamente, el campo connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [{
    "ID": 3.0
    }]

Ejemplo: eliminar un registro

En este ejemplo se elimina el registro 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 Delete y, a continuación, haz clic en Hecho.
  4. En la sección Entrada de tarea de la tarea Conectores, haga clic en entityId y, a continuación, introduzca 2 en el campo Valor predeterminado.
  • Para saber cómo crear y usar la tarea Conectores en la integración de Apigee, consulta Tarea Conectores.
  • Para saber cómo crear y usar la tarea Conectores en Application Integration, consulta Tarea Conectores.

Obtener ayuda de la comunidad de Google Cloud

Puedes publicar tus preguntas y hablar sobre este conector en la comunidad de Google Cloud, en los foros de Cloud.

Siguientes pasos