Office 365

El conector de Office365 te permite conectarte a una instancia de Office365 y realizar las operaciones compatibles.

Antes de comenzar

Antes de usar el conector de Office 365, realiza las siguientes tareas:

  • En tu proyecto de Google Cloud, haz lo siguiente:
    • 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 Office365 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 conexión 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. Instancia de Azure: El usuario de Microsoft Online que se usa para acceder a los datos. Si no se especifica, se usará tu tenant predeterminado.
    9. De forma opcional, haz clic en + Agregar etiqueta para agregar una etiqueta a la conexión en forma de un par clave-valor.
    10. Haz clic en Siguiente.
  5. 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 Office365 admite los siguientes tipos de autenticación:

      • Otorgamiento de código de autenticación de OAuth 2.0

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

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

Configura la autenticación

Ingresa los detalles según la autenticación que desees usar.

  • Otorgamiento de código de autenticación de OAuth 2.0
    • Token de acceso: el token de acceso que se usa para autenticar solicitudes con conexiones basadas en el flujo de código de autenticación.
    • ID de cliente: el ID de cliente que se usa para solicitar tokens de acceso.
    • Secreto de cliente: el secreto del cliente que se usa para solicitar tokens de acceso.

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.

Limitaciones del sistema

El conector de Office365 puede procesar 1 transacción por segundo, por nodo, y throttles las transacciones supera este límite. De forma predeterminada, los conectores de integración asignan 2 nodos (para una mejor disponibilidad) a una conexión.

Para obtener información sobre los límites aplicables a Integration Connectors, consulta Límites.

Acciones

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

Acción CancelEvent

Esta acción te permite cancelar un evento.

Parámetros de entrada de la acción CancelEvent

Nombre del parámetro Tipo de datos Obligatorio Descripción
EventId String Sí Es el ID del evento.
UserId String No Es el ID del usuario.
UserPrincipalName String No Es el nombre de usuario al que se debe asignar la licencia.
Comentario String No Un comentario que se debe incluir.

Por ejemplo, sobre cómo configurar la acción CancelEvent, consulta Ejemplos de acciones.

Acción MoveMail

Esta acción te permite mover un correo electrónico.

Parámetros de entrada de la acción MoveMail

Nombre del parámetro Tipo de datos Obligatorio Descripción
MessageId String Sí El ID del correo electrónico.
DestinationId String Sí Es el ID de la carpeta de destino a la que se moverá el correo electrónico.

Para ver ejemplos sobre cómo configurar la acción MoveMail, consulta Ejemplos de acciones.

Acción AssignLicense

Esta acción te permite asignar una licencia.

Parámetros de entrada de la acciónAssignLicense

Nombre del parámetro Tipo de datos Obligatorio Descripción
UserId String No Es el ID del usuario al que se debe asignar la licencia.
UserPrincipalName String No Es el nombre de usuario al que se debe asignar la licencia.
AddLicenseSkuId String No Es el identificador único del SKU.
DisabledPlans String No Una colección de identificadores únicos separados por comas para los planes que se inhabilitaron.
RemoveLicenses String No Una colección de IDs separados por comas que identifican las licencias que se deben quitar.

Por ejemplo, sobre cómo configurar la acción AssignLicense, consulta Ejemplos de acciones.

Acción ForwardEvent

Esta acción te permite reenviar un evento.

Parámetros de entrada de la acción ForwardEvent

Nombre del parámetro Tipo de datos Obligatorio Descripción
EventId String Sí El ID del evento.
UserId String No Es el ID del usuario.
UserPrincipalName String No El nombre de usuario para el que se debe asignar la licencia.
Comentario String No Un comentario que se debe incluir.
ToRecipients String Sí Una lista de correos electrónicos de los destinatarios separados por punto y coma.

Por ejemplo, sobre cómo configurar la acción ForwardEvent, consulta Ejemplos de acciones.

Acción UploadFile

Esta acción te permite subir un archivo.

Parámetros de entrada de la acción UploadFile

Nombre del parámetro Tipo de datos Obligatorio Descripción
Nombre del archivo String No Es el nombre del archivo al que debes subir el contenido.
LocalFile String No Archivo local que incluye el contenido que se subirá.
ContentStream String No El contenido como transmisión de entrada que se subirá cuando no se especifique la ruta local o la ruta de carpeta.
ParentId String Sí ID de la carpeta donde se encuentra el elemento actual.
Contenido String No Contenido del archivo que se subirá.

Por ejemplo, sobre cómo configurar la acción UploadFile, consulta Ejemplos de acciones.

Acción DownloadFile

Esta acción te permite descargar un archivo.

Parámetros de entrada de la acción DownloadFile

Nombre del parámetro Tipo de datos Obligatorio Descripción
FileId String Sí El ID del archivo que quieres descargar.
DownloadTo String No Dónde almacenar el archivo.
Codificación String No El tipo de codificación de entrada de FileData. Los valores permitidos son NONE, BASE64 y la el valor predeterminado es BASE64.
FileStream String No Una instancia de una transmisión de salida en la que se escriben los datos del archivo. Solo se usa si No se especificó DownloadTo.

Por ejemplo, sobre cómo configurar la acción DownloadFile, 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
ParentId String No Es el ID de la carpeta en la que se encuentra el elemento actual.
FolderName String Sí Nombre de la carpeta que se creará.

Para ver ejemplos sobre cómo configurar la acción CreateFolder, consulta Ejemplos de acciones.

Acción SendMail

Esta acción te permite enviar un correo electrónico.

Parámetros de entrada de la acción SendMail

Nombre del parámetro Tipo de datos Obligatorio Descripción
ToRecipients String No Los destinatarios a los que se debe enviar el correo electrónico.
Contenido String No Contenido del correo electrónico.
Asunto String No El asunto del correo electrónico.
ID String No El ID del mensaje que se enviará (opcional). El usuario puede usar un ID de correo electrónico existente o enviar un correo electrónico nuevo completando de forma opcional los otros campos.
Archivos adjuntos String No Los archivos adjuntos. Especifica los archivos adjuntos en el siguiente formato:

filename1,filecontent1;filename2,filecontent2 El contenido de cada archivo puede ser datos BASE64 o la ruta de un archivo local con el carácter @ antes.
Nombre del archivo String No Los destinatarios Especifica los destinatarios en el siguiente orden.
LocalFile String No Es el archivo que contiene el contenido del archivo adjunto.
ContentBytes String No Contenido del adjunto codificado en BASE64.
CCRecipients String No Los valores de los destinatarios en Cc separados por punto y coma
SenderEmail String No La dirección de correo electrónico en nombre de quién se debe enviar el correo electrónico Establece esta opción si quieres enviar correos electrónicos en nombre de la cuenta de otro usuario.
FromEmail String No Es la dirección de correo electrónico del usuario desde la que se debe enviar el correo electrónico. Establecer si quieres enviar un correo electrónico desde la cuenta de otro usuario.
ContentType String No Es el tipo de contenido del cuerpo del correo electrónico. Los valores permitidos son text y html. El valor predeterminado es text.

Para ver ejemplos sobre cómo configurar la acción SendMail, consulta Ejemplos de acciones.

Acción ForwardMail

Esta acción te permite reenviar un correo electrónico.

Parámetros de entrada de la acción ForwardMail

Nombre del parámetro Tipo de datos Obligatorio Descripción
MessageId String Sí Es el ID del correo electrónico.
ToRecipients String Sí Una lista de los correos electrónicos de los destinatarios separados por punto y coma.
Comentario String No Contenido adicional al mensaje original

Para ver ejemplos sobre cómo configurar la acción ForwardMail, consulta Ejemplos de acciones.

Acción DownloadEmail

Esta acción te permite descargar un correo electrónico.

Parámetros de entrada de la acción DownloadEmail

Nombre del parámetro Tipo de datos Obligatorio Descripción
MessageId String Sí Es el ID del mensaje que deseas descargar.
Codificación String No Es el tipo de codificación de entrada de datos de archivo.
DownloadTo String No Dónde almacenar el archivo.
FileStream String No Es una instancia de un flujo de salida en el que se deben escribir los datos del archivo. Este valor es de Solo se usa si no se proporciona DownloadTo.

Por ejemplo, sobre cómo configurar el DownloadMail, consulta Ejemplos de acciones.

Acción DownloadAttachments

Esta acción te permite descargar los archivos adjuntos de un correo electrónico.

Parámetros de entrada de la acción DownloadAttachments

Nombre del parámetro Tipo de datos Obligatorio Descripción
MessageId String Sí El ID del correo electrónico desde el que deseas obtener los archivos adjuntos.
Codificación String No Es el tipo de codificación de entrada de FileData. Los valores permitidos son NONE y BASE64.
DownloadTo String No Dónde almacenar los archivos adjuntos Si no se especifica, muestra los bytes de contenido del adjunto. Este valor es obligatorio si se especifica MessageId.
AttachmentId String No Es el ID del archivo adjunto que quieres descargar. Devuelve todos los archivos adjuntos del correo electrónico si no se especifica.
UserId String No Es el ID del usuario. Esto solo funcionará si el usuario autenticado tiene permisos de administrador.
FileStream String No Es una instancia de un flujo de salida en el que se escriben los datos de los archivos. Solo se usa si no se proporciona DownloadTo.

Por ejemplo, sobre cómo configurar el DownloadAttachments, consulta Ejemplos de acciones.

Ejemplos de acciones

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

Ejemplo: Cancela un evento

En este ejemplo, se cancela un evento con el ID especificado.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción CancelEvent 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: 
    {
"EventId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-GAAA=",   
"Comment": "Canceled due to rain"
}

    4. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea CancelEvent tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: Cómo asignar y quitar una licencia

En este ejemplo, se asignan y quitan licencias para el usuario especificado.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción AssignLicense 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: 
    {
"UserID": "ee58217f-b22e-4300-a876-53db3c71a87b",   
"AddLicenseSkuId": "c42b9cae-ea4f-4ab7-9717-81576235ccac",   
"RemoveLicenses": "c42b9cae-ea4f-4ab7-9717-81576235ccac"
}

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

    [{
"Status": "Success"
}]

Ejemplo: Reenvía un evento

En este ejemplo, se reenvía un evento.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción ForwardEvent 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: 
    {
"EventId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-PKBwAhfASdetQfTZ3pESzwWnAbAAAAAAENAAAhfASdetQfTZ3pESzwWnAbAAA_CxGjAAA=",   
"Comment": "forwarded due to rain",   
"ToRecipients": "test99@example.com"
}

    4. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea ForwardEvent tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: Sube un archivo

En este ejemplo, se sube un archivo.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción UploadFile 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": "Document1234.docx",   
"ParentId": "01VCU572N6Y2GOVW7725BZO354PWSELRRZ",   
"Content": "test"
}

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

     [{
"Id": "01VCU572JX6F3L3NKLQVB2BXETRHLEAUAY",   
"@test.context": "https://example.com/v1.0/$metadata#users('7954f490-5a43-083fc215362a')/drive/items('01VCU5BZO354PWSELRRZ')/test/$entity",   
"@example.downloadurl": "https://example.com/test/admin123/_layouts/15/download.aspx?UniqueId=bd76224r7-4........
"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 DownloadFile 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: 
    {
"FileId": "01VCU572LDCGQYZOSMHZDZGN5HCXS5P6EP"
}

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

    [{
"Status": "Success",
"FileData": "UEsDBBQAAAAIAEoTdVdSWj6GTAEAABoFAAATAAAAWNdLnhtbLWUTU7DMBCFr2J"
}]

Ejemplo: crea una carpeta

En este ejemplo, se crea una carpeta.

  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: 
    {
"ParentId": "01VCU572N6Y2GOVW7725BZO354PWSELRRZ",   
"FolderName": "outbox1234"
}

    4. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea CreateFolder tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: Enviar un correo electrónico

En este ejemplo, se envía un correo electrónico a los destinatarios especificados.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción SendMail 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: 
    {
"ToRecipients": "test097@example.com",   
"Content": "Testing",   
"Subject": "Test subject",   
"FileName": "Google"
}

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

    [{
"Status": "Success"
}]

Ejemplo: Cómo reenviar un correo electrónico

En este ejemplo, se reenvía un correo electrónico.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción ForwardMail 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: 
    {
"MessageId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-PKBwAhfASdetQfTpESzwWnAbAAA0sITVAAA=",   
"ToRecipients": "test097@example.com",   
"Comment": "forwarded message"
}

    4. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea ForwardMail tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: Descarga un correo electrónico

En este ejemplo, se descarga un correo electrónico.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DownloadEmail 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: 
    {
"MessageId": "fTZ3pESzwWnAbAAAAAAEJAAAhfASdetQfTZ3pESzwWnAbAAA0sITVAAA="
}

    4. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea DownloadEmail tendrá un valor similar al siguiente:

    [{
"Status": "Success",   
"FileData": "RnJvbTogRk5VIExOVSA8YWRtaW4xMjNANzNzY21nLm9ubWljcm9zb2Z0LmNvbT4NClRvOiB0ZXN0IDx0ZXN0.......
}]

Ejemplo: Descargar archivos adjuntos

En este ejemplo, se descargan archivos adjuntos.

  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: 
    {
{"MessageId": "PKBwAhfASdetQfTZ3pESzwWnAbAAAAAAEJAAAhfASdetQfTZ3pESzwWnAbAAA0sITWAAA=",   
"DownloadTo": "My files/Office355/reports/"}
}

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

    [{
"Id": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGTWAAABEgAQAF3EBDrnTc1Cj8akAYrJjdM=",
"Name": "demoattachment.docx",
"ContentBytes": "UEsDBBQAAAAIALskYlcppqeszQEAAHQJAAATAAAAWAAAI3RyYXNoXS8wMDAwLmRhdP........",
"LastmodifiedDatetime": "2023-11-21T10:09:09Z",
"ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"FileData": null,
"json:repeatelementorder#": null,
"size": "23575",
"isinline": "false
}]

Usar la conexión de Office365 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 Conectores en la integración de Apigee, consulta Tarea Conectores.
  • Para comprender cómo crear y usar la tarea Conectores en Application Integration, consulta la Tarea Conectores.

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?