Office365

Il connettore Office 365 consente di connettersi a un'istanza di Office 365 ed eseguire le operazioni supportate.

Prima di iniziare

Prima di utilizzare il connettore di Office 365, effettua le seguenti attività:

  • Nel tuo progetto Google Cloud:
    • Attiva i seguenti servizi:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Per informazioni su come attivare i servizi, consulta Abilitazione dei servizi.

    Se questi servizi o autorizzazioni non sono stati attivati in precedenza per il tuo progetto, ti verrà chiesto di attivarli durante la configurazione del connettore.

Configura il connettore

Per configurare il connettore devi creare una connessione all'origine dati (sistema di backend). Una connessione è specifica per un'origine dati. it significa che se hai molte origini dati, devi creare una connessione separata per ogni origine dati. Per creare una connessione:

  1. Nella console Cloud, vai alla pagina Connettori di integrazione > Connessioni, quindi seleziona o crea un progetto Google Cloud.

    Vai alla pagina Connessioni

  2. Fai clic su + Crea nuova per aprire la pagina Crea connessione.
  3. Nella sezione Località, scegli la località della connessione.
    1. Regione: seleziona una località dall'elenco a discesa.

      Le regioni supportate per i connettori includono:

      Per l'elenco di tutte le aree geografiche supportate, consulta la sezione Località.

    2. Fai clic su Avanti.
  4. Nella sezione Dettagli connessione, completa i seguenti passaggi:
    1. Connettore: seleziona Office365 dall'elenco a discesa dei connettori disponibili.
    2. Versione connettore: seleziona la versione del connettore dall'elenco a discesa delle versioni disponibili.
    3. Nel campo Nome connessione, inserisci un nome per l'istanza di connessione.

      I nomi delle connessioni devono soddisfare i seguenti criteri:

      • I nomi delle connessioni possono contenere lettere, numeri o trattini.
      • Le lettere devono essere minuscole.
      • I nomi delle connessioni devono iniziare con una lettera e terminare con una lettera o un numero.
      • I nomi delle connessioni non possono contenere più di 49 caratteri.
    4. (Facoltativo) Inserisci una Descrizione per l'istanza di connessione.
    5. Se vuoi, attiva Cloud Logging e poi seleziona un livello di log. Per impostazione predefinita, il livello di log è impostato su Error.
    6. Account di servizio: seleziona un account di servizio con i ruoli richiesti.
    7. Facoltativamente, configura le impostazioni del nodo di connessione:

      • Numero minimo di nodi: inserisci il numero minimo di nodi di connessione.
      • Numero massimo di nodi: inserisci il numero massimo di nodi di connessione.

      Un nodo è un'unità (o una replica) di una connessione che elabora le transazioni. Sono necessari più nodi per elaborare più transazioni per una connessione e, per elaborare meno transazioni. Per capire in che modo i nodi influiscono sui prezzi dei connettori, consulta Prezzi per i nodi di connessione. Se non inserisci alcun valore, per impostazione predefinita il numero minimo di nodi è impostato su 2 (per una maggiore disponibilità) e il numero massimo di nodi è impostato su 50.

    8. Tantant Azure: il tenant Microsoft Online utilizzato per accedere ai dati. Se non specificato, verrà utilizzato il tenant predefinito.
    9. Se vuoi, fai clic su + Aggiungi etichetta per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
    10. Fai clic su Avanti.
  5. Nella sezione Autenticazione, inserisci i dettagli di autenticazione.
    1. Seleziona un Tipo di autenticazione e inserisci i dettagli pertinenti.

      La connessione Office 365 supporta i seguenti tipi di autenticazione:

      • Concessione del codice di autorizzazione OAuth 2.0

      2. Per informazioni su come configurare questi tipi di autenticazione, consulta l'articolo Configurare l'autenticazione.

    2. Fai clic su Avanti.
  6. Rivedi: controlla i dettagli di connessione e autenticazione.
  7. Fai clic su Crea.

Configura autenticazione

Inserisci i dettagli in base all'autenticazione che vuoi utilizzare.

  • Concessione del codice di autorizzazione OAuth 2.0
    • Token di accesso: il token di accesso utilizzato per autenticare le richieste con connessioni basate su auth-code-flow.
    • ID client: l'ID client utilizzato per richiedere i token di accesso.
    • Client secret: il client secret utilizzato per richiedere i token di accesso.

Entità, operazioni e azioni

Tutti i connettori di integrazione forniscono un livello di astrazione per gli oggetti l'applicazione connessa. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione ti viene esposta sotto forma di entità, operazioni e azioni.

  • Entità: un'entità può essere considerata un oggetto o un insieme di proprietà nel un'applicazione o un servizio connesso. La definizione di un'entità differisce da un connettore di rete. Ad esempio, in un connettore di database le tabelle sono le entità, in un connettore di file server le cartelle sono le entità e in un connettore di sistema di messaggistica le code sono le entità.

    Tuttavia, è possibile che un connettore non supporti o non abbia entità, nel qual caso l'elenco Entities sarà vuoto.

  • Operazione: un'operazione è l'attività che puoi eseguire su un'entità. Puoi eseguire su un'entità una delle seguenti operazioni:

    La selezione di un'entità dall'elenco disponibile genera un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta le operazioni sulle entità dell'attività Connettori. Tuttavia, se un connettore non supporta nessuna delle operazioni relative all'entità, come quelle non supportate operazioni non sono elencate nell'elenco Operations.

  • Azione: un'azione è una funzione di prima classe resa disponibile all'integrazione tramite l'interfaccia del connettore. Un'azione consente di apportare modifiche a una o più entità variano da connettore a connettore. In genere, un'azione avrà alcuni parametri di input e un parametro di output. Tuttavia, è possibile che un connettore non supporta alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Limitazioni del sistema

Il connettore Office 365 può elaborare una transazione al secondo per nodo e limita le transazioni oltre questo limite. Per impostazione predefinita, Integration Connectors alloca 2 nodi (per una maggiore disponibilità) per una connessione.

Per informazioni sui limiti applicabili a Integration Connectors, vedi Limiti.

Azioni

Questa sezione elenca le azioni supportate dal connettore. Per capire come configurare le azioni, consulta Esempi di azioni.

Azione CancelEvent

Questa azione ti consente di annullare un evento.

Parametri di input dell'azione CancelEvent

Nome parametro Tipo di dati Obbligatorio Descrizione
EventId Stringa Sì ID dell'evento.
ID utente Stringa No ID dell'utente.
UserPrincipalName Stringa No Il nome utente che deve essere assegnato alla licenza.
Commento Stringa No Un commento da includere.

Ad esempio, per scoprire come configurare l'azione CancelEvent, consulta Esempi di azioni.

Azione MoveMail

Questa azione ti consente di spostare un'email.

Parametri di input dell'azione SpostaEmail

Nome parametro Tipo di dati Obbligatorio Descrizione
MessageId Stringa Sì ID email.
DestinationId Stringa Sì ID della cartella di destinazione in cui verrà spostata l'email.

Ad esempio su come configurare l'azione MoveMail consulta gli esempi di azioni.

Azione AssegnaLicenza

Questa azione ti consente di assegnare una licenza.

Parametri di input dell'azioneAssignLicense

Nome parametro Tipo di dati Obbligatorio Descrizione
ID utente Stringa No L'ID dell'utente a cui deve essere assegnata la licenza.
UserPrincipalName Stringa No Il nome utente a cui deve essere assegnata la licenza.
AddLicenseSkuId Stringa No L'identificatore univoco dello SKU.
DisabledPlans Stringa No Una raccolta di identificatori univoci separati da virgole per i piani che sono state disattivate.
RemoveLicenses Stringa No Una raccolta di ID separati da virgole che identificano le licenze da rimuovere.

Ad esempio, per scoprire come configurare l'azione AssignLicense, consulta Esempi di azioni.

Azione ForwardEvent

Questa azione ti consente di inoltrare un evento.

Parametri di input dell'azione ForwardEvent

Nome parametro Tipo di dati Obbligatorio Descrizione
EventId Stringa Sì L'ID dell'evento.
ID utente Stringa No ID dell'utente.
UserPrincipalName Stringa No Il nome utente a cui deve essere assegnata la licenza.
Commento Stringa No Un commento da includere.
ToRecipients Stringa Sì Un elenco di indirizzi email dei destinatari, separati da punto e virgola.

Ad esempio su come configurare l'azione ForwardEvent consulta gli esempi di azioni.

Azione UploadFile

Questa azione ti consente di caricare un file.

Parametri di input dell'azione UploadFile

Nome parametro Tipo di dati Obbligatorio Descrizione
FileName Stringa No Nome del file su cui devi caricare i contenuti.
LocalFile Stringa No File locale contenente i contenuti da caricare.
ContentStream Stringa No I contenuti come stream di input da caricare quando non è specificato localpath o folderpath.
ParentId Stringa Sì ID della cartella in cui si trova l'elemento corrente.
Contenuti Stringa No Contenuti del file da caricare.

Ad esempio su come configurare l'azione UploadFile consulta gli esempi di azioni.

Azione DownloadFile

Questa azione ti consente di scaricare un file.

Parametri di input dell'azione DownloadFile

Nome parametro Tipo di dati Obbligatorio Descrizione
FileId Stringa Sì L'ID del file che vuoi scaricare.
DownloadTo Stringa No Dove archiviare il file.
Codifica Stringa No Il tipo di codifica dell'input FileData. I valori consentiti sono NONE, BASE64 e il valore predefinito è BASE64.
FileStream Stringa No Un'istanza di uno stream di output in cui vengono scritti i dati del file. Viene utilizzato solo se DownloadTo non è specificato.

Ad esempio su come configurare l'azione DownloadFile consulta gli esempi di azioni.

Azione CreateCartella

Questa azione consente di creare una cartella.

Parametri di input dell'azione CreateCartella

Nome parametro Tipo di dati Obbligatorio Descrizione
ParentId Stringa No L'ID della cartella in cui si trova l'elemento corrente.
FolderName Stringa Sì Nome della cartella da creare.

Ad esempio, su come configurare CreateFolder; consulta gli esempi di azioni.

Azione SendMail

Questa azione ti consente di inviare un'email.

Parametri di input dell'azione SendMail

Nome parametro Tipo di dati Obbligatorio Descrizione
ToRecipients Stringa No I destinatari per i quali deve essere inviata l'email.
Contenuti Stringa No Contenuti dell'email.
Oggetto Stringa No L'oggetto dell'email.
ID Stringa No L'ID del messaggio da inviare (facoltativo). L'utente può utilizzare un ID email esistente o inviare una nuova email compilando facoltativamente gli altri campi.
Allegati Stringa No Gli allegati dei file. Specifica i file allegati nel seguente formato:

filename1,filecontent1;filename2,filecontent2. Il contenuto di ogni file può essere un dato BASE64 o il percorso di un file locale preceduto dal carattere @.
FileName Stringa No Destinatari Specifica i destinatari nel seguente ordine.
LocalFile Stringa No Il file contenente i contenuti dell'allegato.
ContentBytes Stringa No Contenuto dell'allegato codificato in BASE64.
CCRecipients Stringa No I valori dei destinatari in Cc separati da un punto e virgola.
SenderEmail Stringa No Deve essere inviato l'indirizzo email per conto del destinatario. Imposta questa opzione se vuoi inviare email per conto dell'account di un altro utente.
FromEmail Stringa No L'indirizzo email dell'utente da cui deve essere inviata l'email. Imposta questa opzione se vuoi inviare email dall'account di un altro utente.
ContentType Stringa No Il tipo di contenuto del corpo dell'email.I valori consentiti sono testo e html. Il valore predefinito è text.

Ad esempio, su come configurare SendMail; consulta gli esempi di azioni.

Azione ForwardMail

Questa azione ti consente di inoltrare un'email.

Parametri di input dell'azione InoltraEmail

Nome parametro Tipo di dati Obbligatorio Descrizione
MessageId Stringa Sì ID dell'email.
ToRecipients Stringa Sì Un elenco di indirizzi email dei destinatari separati da punto e virgola.
Commento Stringa No Contenuti aggiuntivi rispetto al messaggio originale.

Ad esempio, per scoprire come configurare l'azioneForwardMail, consulta Esempi di azioni.

Azione DownloadEmail

Questa azione ti consente di scaricare un'email.

Parametri di input dell'azione DownloadEmail

Nome parametro Tipo di dati Obbligatorio Descrizione
MessageId Stringa Sì ID del messaggio che vuoi scaricare.
Codifica Stringa No Il tipo di codifica dell'input dei dati del file.
DownloadTo Stringa No Dove archiviare il file.
FileStream Stringa No Un'istanza di un flusso di output in cui devono essere scritti i dati di un file. Questo valore viene utilizzato solo se non viene fornito DownloadTo.

Ad esempio, per scoprire come configurare l'azioneDownloadMail, consulta Esempi di azioni.

Azione DownloadAttachments

Questa azione ti consente di scaricare gli allegati di un'email.

Parametri di input dell'azione DownloadAttachments

Nome parametro Tipo di dati Obbligatorio Descrizione
MessageId Stringa Sì L'ID dell'email da cui vuoi recuperare gli allegati.
Codifica Stringa No Il tipo di codifica dell'input FileData. I valori consentiti sono NONE, BASE64.
DownloadTo Stringa No Dove archiviare gli allegati. Se non specificato, restituisce i byte dei contenuti dell'allegato. Questo valore è obbligatorio se è specificato MessageId.
AttachmentId Stringa No ID dell'allegato da scaricare. Restituisce tutti gli allegati dell'email se non specificati.
ID utente Stringa No ID dell'utente. Questa opzione funziona solo se l'utente autenticato dispone delle autorizzazioni di amministratore.
FileStream Stringa No Un'istanza di un flusso di output in cui vengono scritti i dati di un file. Utilizzato solo se non viene fornito DownloadTo.

Ad esempio, per scoprire come configurare l'azione DownloadAttachments, consulta Esempi di azioni.

Esempi di azioni

In questa sezione viene descritto come eseguire alcune azioni in questo connettore.

Esempio: annullare un evento

In questo esempio viene annullato un evento con l'ID specificato.

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione CancelEvent e fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload, quindi inserisci un valore simile al seguente nella Campo Default Value: 
    {
"EventId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-GAAA=",   
"Comment": "Canceled due to rain"
}

    4. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload della task CancelEvent avrà un valore simile al seguente:

    [{
"Status": "Success"
}]

Esempio: assegnare e rimuovere una licenza

In questo esempio vengono assegnate e rimosse le licenze per l'utente specificato.

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione AssignLicense e poi fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value: 
    {
"UserID": "ee58217f-b22e-4300-a876-53db3c71a87b",   
"AddLicenseSkuId": "c42b9cae-ea4f-4ab7-9717-81576235ccac",   
"RemoveLicenses": "c42b9cae-ea4f-4ab7-9717-81576235ccac"
}

    4. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload della task AssignLicense avrà un valore simile al seguente:

    [{
"Status": "Success"
}]

Esempio: inoltro di un evento

Questo esempio inoltra un evento.

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione ForwardEvent e fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload, quindi inserisci un valore simile al seguente nella Campo Default Value: 
    {
"EventId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-PKBwAhfASdetQfTZ3pESzwWnAbAAAAAAENAAAhfASdetQfTZ3pESzwWnAbAAA_CxGjAAA=",   
"Comment": "forwarded due to rain",   
"ToRecipients": "test99@example.com"
}

    4. Se l'azione viene eseguita correttamente, Risposta connectorOutputPayload dell'attività ForwardEvent avrà un valore simile al seguente:

    [{
"Status": "Success"
}]

Esempio - Carica un file

In questo esempio viene caricato un file.

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione UploadFile e poi fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value: 
    {
"FileName": "Document1234.docx",   
"ParentId": "01VCU572N6Y2GOVW7725BZO354PWSELRRZ",   
"Content": "test"
}

    4. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload della task UploadFile avrà un valore simile al seguente:

     [{
"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"
}]

Esempio: scaricare un file

Questo esempio scarica un file.

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione DownloadFile e fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload, quindi inserisci un valore simile al seguente nella Campo Default Value: 
    {
"FileId": "01VCU572LDCGQYZOSMHZDZGN5HCXS5P6EP"
}

    4. Se l'azione viene eseguita correttamente, Risposta connectorOutputPayload dell'attività DownloadFile avrà un valore simile al seguente:

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

Esempio: creare una cartella

In questo esempio viene creata una cartella.

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione CreateFolder e poi fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value: 
    {
"ParentId": "01VCU572N6Y2GOVW7725BZO354PWSELRRZ",   
"FolderName": "outbox1234"
}

    4. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload della task CreateFolder avrà un valore simile al seguente:

    [{
"Status": "Success"
}]

Esempio: invia un'email

Questo esempio invia un'email ai destinatari specificati.

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione SendMail e poi fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload, quindi inserisci un valore simile al seguente nella Campo Default Value: 
    {
"ToRecipients": "test097@example.com",   
"Content": "Testing",   
"Subject": "Test subject",   
"FileName": "Google"
}

    4. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload della task SendMail avrà un valore simile al seguente:

    [{
"Status": "Success"
}]

Esempio: inoltrare un'email

Questo esempio inoltra un'email.

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione ForwardMail e poi fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value: 
    {
"MessageId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-PKBwAhfASdetQfTpESzwWnAbAAA0sITVAAA=",   
"ToRecipients": "test097@example.com",   
"Comment": "forwarded message"
}

    4. Se l'azione viene eseguita correttamente, Risposta connectorOutputPayload dell'attività ForwardMail avrà un valore simile al seguente:

    [{
"Status": "Success"
}]

Esempio: scarica un'email

Questo esempio scarica un'email.

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione DownloadEmail e poi fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload, quindi inserisci un valore simile al seguente nella Campo Default Value: 
    {
"MessageId": "fTZ3pESzwWnAbAAAAAAEJAAAhfASdetQfTZ3pESzwWnAbAAA0sITVAAA="
}

    4. Se l'azione viene eseguita correttamente, Risposta connectorOutputPayload dell'attività DownloadEmail avrà un valore simile al seguente:

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

Esempio: download di allegati

In questo esempio vengono scaricati gli allegati.

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione DownloadAttachments e fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload, quindi inserisci un valore simile al seguente nella Campo Default Value: 
    {
{"MessageId": "PKBwAhfASdetQfTZ3pESzwWnAbAAAAAAEJAAAhfASdetQfTZ3pESzwWnAbAAA0sITWAAA=",   
"DownloadTo": "My files/Office355/reports/"}
}

    4. Se l'azione viene eseguita correttamente, Risposta connectorOutputPayload dell'attività DownloadAttachments avrà un valore simile al seguente:

    [{
"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
}]

Utilizzare la connessione Office 365 in un'integrazione

Dopo aver creato la connessione, questa diventa disponibile in Apigee Integration e Application Integration. Puoi usare la connessione in un'integrazione tramite l'attività Connettori.

  • Per informazioni su come creare e utilizzare l'attività Connectors in Apigee Integration, consulta Attività Connectors.
  • Per informazioni su come creare e utilizzare l'attività Connettori in Application Integration, consulta Attività Connettori.

Ricevere assistenza dalla community Google Cloud

Puoi pubblicare le tue domande e discutere di questo connettore in Google Cloud nei forum di Cloud.

Passaggi successivi