SharePoint

El conector de SharePoint te permite administrar archivos, carpetas y archivos adjuntos en SharePoint.

Versiones compatibles

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

Antes de comenzar

En tu proyecto de Google Cloud, realiza las siguientes tareas:

  • Asegúrate de que la conectividad de red esté configurada. Para obtener más información, consulta Conectividad de red.
  • Otorga el rol de IAM roles/connectors.admin al usuario que configura el conector.
  • Otorga los roles de IAM roles/secretmanager.viewer y roles/secretmanager.secretAccessor a la cuenta de servicio que deseas usar para el conector:
  • Habilita secretmanager.googleapis.com (API de Secret Manager) y connectors.googleapis.com (API de Connectors). Para obtener más información, consulta Cómo habilitar servicios.

Crea una conexión de SharePoint

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, haz lo siguiente:

  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, selecciona una ubicación de la lista Región y, luego, haz clic en Siguiente.

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

  4. En la sección Detalles de la conexión, completa lo siguiente:
    1. Selecciona SharePoint en la lista de conectores.
    2. Selecciona una versión del conector en la lista Versión del conector.
    3. En el campo Nombre de la conexión, ingresa 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 comenzar con una letra y terminar con una letra o un número, y no debe exceder 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. En el campo Cuenta de servicio, selecciona una cuenta 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 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, luego, ingresa la dirección en el campo Host 1.
    • Para establecer una conexión privada, selecciona Adjunto de extremo y elige el adjunto requerido de la lista Adjunto de extremo.

    Si deseas establecer una conexión pública con 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 permitir solo las direcciones IP estáticas específicas.

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

  7. 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 del cliente para la autenticación.
    2. Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.

    3. Haz clic en Siguiente.
  8. En la sección Revisar, revisa los detalles de conexión y autenticación.
  9. 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 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 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 adjunto de servicio para crear un 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 una vinculación de extremo, consulta Crea una vinculación de extremo.

Especifica los detalles de las credenciales de Windows en Google Cloud

Cuando creas la conexión en Integration Connectors , 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 los parámetros OAuthClientId y OAuthClientSecret, haz lo siguiente:

  1. Accede al portal de Azure.
  2. En Servicios de Azure, selecciona Registros de aplicaciones y, luego, Nuevo registro.
  3. Ingresa un nombre de aplicación y selecciona Cualquier inquilino de Microsoft Entra ID: multiinquilino.
  4. Haz clic en Register.
  5. Después de crear la app, navega a la sección Certificados y secretos, crea un secreto del cliente para la aplicación y guarda su valor.
  6. En Permisos de 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:Sites.Read.All.

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

    Permisos delegados Permisos de la aplicación
    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
  7. Guarda los cambios.
  8. Si seleccionaste usar permisos que requieren consentimiento del administrador, puedes otorgarlos desde el arrendatario actual en la página Permisos de la API.
  9. Para agregar el alcance, ve a la sección Expose an API, agrega alcances de AllSites.Manage, Sites.FullControl.All y selecciona quién puede controlar (administradores y usuarios).
  10. Haz clic en Guardar.

Especifica las credenciales en Google Cloud

Cuando creas la conexión en Integration Connectors , 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.
  • Scopes: Ingresa una lista de los permisos deseados separados por comas. Por ejemplo, Sites.FullControl.All
  • Secreto del 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 seleccionado anteriormente.
  • URL de autorización: Es la URL de autorización que generas cuando creas un cliente de OAuth. Ingresa 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.

Autoriza la conexión en Google Cloud

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

    El Estado del conector nuevo 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á en 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 aplicaciones.
  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 enumeran los valores de configuración de ejemplo 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 el tipo de autenticación de credenciales de cliente de OAuth 2.0 con portador de JWT, debes completar los siguientes pasos:

  1. Crea un certificado.
  2. Carga el certificado en el 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.

Crea 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 Granting access via Azure AD App-Only y pégala en el archivo de texto.
  4. Cambia el nombre del archivo de texto por el siguiente: 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 tus 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.

Carga el certificado en Azure Portal

  1. Accede al portal de Azure y registra una aplicación nueva 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 nombre de la cuenta; un solo arrendatario).
  2. Ve a Permisos de API > Agregar permiso > Solicitar permisos de API > SharePoint.
  3. Selecciona Permisos de aplicación y, luego, agrega los permisos que necesites.
  4. Selecciona Grant admin consent y, luego, Yes.
  5. Después de crear la app, navega a la sección Certificados y secretos.
  6. Selecciona Subir certificado y, luego, sube tu certificado CER desde tu computadora. Cuando finalice la carga, selecciona Agregar.

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

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

Obtén una clave privada

Puedes obtener una clave privada convirtiendo el archivo PFX en un archivo PEM con OpenSSL.

  1. Desde el símbolo del sistema, ve a la carpeta con tu archivo PFX y ejecuta el siguiente comando: openssl pkcs12 -in MyCertificate.pfx -out MyCertificate.pem -nodes
  2. Ingresa la contraseña del 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 usuario de la app recién registrada en el portal de Azure.
  2. Accede con la autenticación de la principal de servicio de SharePoint List con las siguientes credenciales:
    • ID de cliente
    • ID de usuario
    • Clave privada
    • Huella digital (contraseña de clave privada)

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

Cuando creas 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 portador de JWT como el tipo de autenticación y, luego, ingresa los siguientes detalles:

  • En el campo 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.
  • 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 o el certificado públicos que se proporcionan al conector.
  • En el campo Versión del secreto, selecciona la versión del secreto que se seleccionó anteriormente.
  • En el campo Contraseña de la clave privada, selecciona el secreto de Secret Manager que contiene la contraseña (paráfrasis) del archivo de clave privada. Usa la misma contraseña que configuraste para proteger la clave privada cuando creaste el certificado.
  • En el campo Versión del secreto, selecciona la versión del secreto que se seleccionó anteriormente.
  • En el campo Tenant de Azure, ingresa el tenant en línea de Microsoft que se usa para acceder a los datos.

Tipo de conexión de certificado de 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
Tenant de Azure AZURE_TENANT_ID

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

Para habilitar el tipo de conexión de secreto del 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 valores para el título, el dominio de la app y el 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 Grant Permission.
  2. En el campo ID de app, ingresa el ID de cliente que generaste anteriormente y haz clic en Buscar. 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.com/content/tenant" Right="FullControl"/>
          </AppPermissionRequests>
            
  4. Haz clic en Crear. La app de SharePoint muestra un cuadro de diálogo de consentimiento de permisos.
  5. Haz clic en Confiar.

Especifica 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 del cliente como el tipo de autenticación y, luego, ingresa los siguientes detalles:

  • En el campo ID de cliente, ingresa el ID de cliente que proporciona el conector para la app que creaste.
  • En el campo Secreto de cliente, selecciona el secreto de Secret Manager que contiene el secreto del cliente para la app conectada que creaste.
  • En el campo Versión del secreto, 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á en 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

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 Application Integration. Puedes usar la conexión en una integración a través de la tarea Connectors.

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 adjunto.

Parámetros de entrada de la acción DeleteAttachment

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

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 Es la URL relativa de la carpeta.
DocumentName String Nombre del archivo que se registrará.
Comentario String No Es un mensaje de registro opcional.

Acción CheckOutDocument

Esta acción te permite extraer un archivo.

Parámetros de entrada de la acción CheckOutDocument

Nombre del parámetro Tipo de datos Obligatorio Descripción
RelativeURL String Es la URL relativa de la carpeta.
DocumentName String Nombre del archivo que se 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 String Es la URL relativa de la carpeta.
DocumentName String Nombre del archivo para el que se debe deshacer la confirmació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 String Es la URL relativa del archivo fuente.
DestFileRelativeUrl String Es la 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
Nombre del archivo String Nombre del archivo que se subirá.
RelativeUrl String Es la URL relativa de la carpeta.
Contenido String No Es el contenido que se subirá como un archivo.
ContentBytes String No Contenido de bytes (como una cadena en Base64) para subir como un archivo. Úsalo para subir datos binarios.
HasBytes Booleano No Especifica si el contenido que se 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 String Es la URL completa del archivo que se descargará.
Biblioteca String 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 String Es la URL del archivo fuente que se debe mover.
DestinationFolderURL String Es la 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 String Es la URL relativa de la carpeta.
FolderName String Nombre de la carpeta que se creará.

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 Nombre de la lista de archivos adjuntos.
Nombre del archivo String Nombre del archivo adjunto.
ItemId String ID del archivo adjunto que se agregará.
Contenido String Es el contenido del archivo adjunto.
ContentBytes String No Contenido de bytes (como una cadena en Base64) para subir como adjunto. Úsalo para subir datos binarios.
HasBytes Booleano No Especifica si el contenido que se 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 String Es la URL relativa del archivo.
HasBytes Booleano No Especifica si el contenido que se descargará es binario. El valor predeterminado es false.

Ejemplos de acciones

En esta sección, se describe cómo realizar algunas de las acciones en 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 registrar la entrada en un documento

En este ejemplo, se confirma 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 extraer un archivo

En este ejemplo, se extrae 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: Descartar una confirmación

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. 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 se 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: Descarga 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: Descarga 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: Descarga 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. 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": "	http://z8**.sharepoint.com/sites/SharepointGCS/Docs/SharpointGCS.docx",
      "Library": "Docs",
      "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": "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: Mueve un archivo adjunto

En este ejemplo, se mueve un 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: Crea 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: Agregar un archivo adjunto

En este ejemplo, se agrega un 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 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: Descarga un archivo adjunto

En este ejemplo, se descarga un 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: Descarga 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: Enumera 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: Obtén 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 Valor predeterminado.

    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 correctamente, 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 Valor predeterminado.
  • Para comprender cómo crear y usar la tarea Connectors en Apigee Integration, 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?