SendGrid

Il connettore SendGrid consente di eseguire operazioni di inserimento, eliminazione, aggiornamento e lettura sul set di dati SendGrid.

Prima di iniziare

Prima di utilizzare il connettore SendGrid, esegui le seguenti attività:

• Nel tuo progetto Google Cloud:
  • Concedi il ruolo IAM roles/connectors.admin all'utente che configura il connettore.
  • Concedi i seguenti ruoli IAM all'account di servizio che vuoi utilizzare per il connettore:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Un account di servizio è un tipo speciale di Account Google destinato a rappresentare un utente non umano che deve autenticarsi ed essere autorizzato ad accedere ai dati nelle API di Google. Se non hai un account di servizio, devi crearne uno. Per maggiori informazioni, consulta la pagina Creazione di un account di servizio.

  • Abilita i seguenti servizi:
    • secretmanager.googleapis.com (API Secret Manager)
    • connectors.googleapis.com (API Connectors)

    Per informazioni su come abilitare i servizi, vedi Attivazione dei servizi.

  Se questi servizi o autorizzazioni non sono stati abilitati in precedenza per il tuo progetto, ti viene richiesto di abilitarli durante la configurazione del connettore.

Configura il connettore

Per configurare il connettore è necessario creare una connessione all'origine dati (sistema di backend). Una connessione è specifica per un'origine dati. Se disponi di molte origini dati, devi creare una connessione separata per ciascuna. 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 NUOVO per aprire la pagina Crea connessione.
3. Nella sezione Posizione, scegli la località per la connessione.
   1. Regione: seleziona una località dall'elenco a discesa.

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

   2. Fai clic su AVANTI.
4. Nella sezione Dettagli connessione, completa quanto segue:
   1. Connettore: seleziona SendGrid 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 63 caratteri.
   4. Facoltativamente, inserisci una descrizione per l'istanza di connessione.
   5. Account di servizio: seleziona un account di servizio con i ruoli richiesti.
   6. 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, al contrario, sono necessari meno nodi per elaborare un numero inferiore di transazioni. Per capire in che modo i nodi influiscono sui prezzi del connettore, consulta Prezzi dei nodi di connessione. Se non inserisci alcun valore, per impostazione predefinita il numero minimo di nodi viene impostato su 2 (per una migliore disponibilità) e il numero massimo di nodi viene impostato su 50.

   Nota: puoi personalizzare i valori del nodo di connessione solo se sei un cliente con pagamento a consumo.
   7. Facoltativamente, fai clic su + AGGIUNGI ETICHETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
   8. Fai clic su AVANTI.
5. Nella sezione Autenticazione, inserisci i dettagli di autenticazione. Per ulteriori informazioni, consulta Configurare l'autenticazione. |
6. Fai clic su AVANTI.
7. Verifica: controlla i dettagli della connessione e dell'autenticazione.
8. Fai clic su Crea.

Configura autenticazione

Autenticazione con chiave API

• Chiave API: seleziona il secret Secret Manager della chiave API.
• Versione secret: seleziona la versione del secret.

Nota: la chiave API che hai creato in Sendgrid deve avere l'ambito user.email.read.

Entità, operazioni e azioni

Tutti i connettori di integrazione forniscono un livello di astrazione per gli oggetti dell'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.

Nota: puoi visualizzare le entità, le operazioni e le azioni di un connettore nell'attività Connettori.

• Entità: un'entità può essere considerata come un oggetto o una raccolta di proprietà nell'applicazione o nel servizio collegato. La definizione di un'entità è diversa da un connettore a un connettore. Ad esempio, in un connettore di database le tabelle sono le entità, in un connettore file server le cartelle sono le entità, mentre in un connettore di sistema di messaggistica le code sono le entità.

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

• Operazione: un'operazione è l'attività che è possibile eseguire su un'entità. Su un'entità puoi eseguire una qualsiasi delle seguenti operazioni:
  • Elenca
  • Scarica
  • Crea
  • Aggiorna
  • Elimina

  Selezionando un'entità dall'elenco disponibile, viene generato un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta le operazioni sull'entità dell'attività Connectors. Tuttavia, se un connettore non supporta nessuna delle operazioni relative alle entità, le operazioni non supportate non saranno elencate nell'elenco Operations.

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

Nota : a tutte le entità e alle azioni è associato uno schema. Ad esempio, uno schema delle azioni contiene i dettagli dei parametri, come i nomi dei parametri e il tipo di dati corrispondente. Lo schema (metadati) per le entità e le azioni viene recuperato dalla connessione in fase di runtime dal tuo backend. Se sono presenti aggiornamenti allo schema, questi aggiornamenti non si rifletteranno automaticamente nelle connessioni esistenti. Devi aggiornare manualmente lo schema. Per aggiornare lo schema di una connessione, apri la pagina Dettagli connessione della connessione, quindi fai clic su Aggiorna schema di connessione.

Limitazioni di sistema

Il connettore SendGrid può elaborare 8 transazioni al secondo per nodo e limitare le transazioni che superano questo limite. Per impostazione predefinita, Integration Connectors alloca due nodi (per una migliore disponibilità) per una connessione.

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

Nota: il numero di nodi di Integration Connectors verrà scalato automaticamente in modo dinamico in base all'utilizzo. Tuttavia, se vuoi prenotare capacità per grandi volumi senza attendere la scalabilità automatica, puoi regolare il valore minimo del nodo per una connessione. Sono necessari più nodi per elaborare più transazioni per una connessione. Al contrario, sono necessari meno nodi se una connessione elabora meno transazioni. Per configurare i valori del nodo:

• Se sei un cliente con pagamento a consumo, configura il valore minimo e massimo dei nodi nella pagina Modifica connessione.
• Se sei un cliente con abbonamento, contatta l'assistenza.

Il numero massimo di transazioni che un nodo è in grado di gestire dipende da vari fattori. Pertanto, prima di regolare il numero minimo di nodi per migliorare la velocità effettiva, ti consigliamo di verificare se i tuoi sistemi di backend sono configurati in modo ottimale per gestire il traffico richiesto.

Azioni

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

Nota: i risultati di tutte le azioni saranno disponibili come risposta JSON nel parametro di risposta connectorOutputPayload dell'attività Connectors dopo aver eseguito l'integrazione.

Azione SendMail

Questa azione invia un'email insieme all'allegato.

Parametri di input dell'azione SendMail

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
Oggetto	String	Sì	L'oggetto dell'email da inviare.
ContentValue	String	No	Il contenuto del messaggio da inviare.
ContentType	String	No	Il tipo di contenuti da inviare. I valori supportati sono text/plain e text/html.
Contenuti	String	Sì	Il valore aggregato dell'oggetto Contenuti.
SendAt	String	No	La data e l'ora in cui vuoi che vengano recapitate le email. È vietato pianificare con più di 72 ore di anticipo.
FromEmail	String	Sì	L'indirizzo email del mittente.
FromName	String	No	Il nome del mittente.
ToEmail	String	No	Indirizzo email a cui inviare l'email.
ToName	String	No	Nomi corrispondenti degli indirizzi email a cui inviare l'email.
A	String	No	Il gruppo aggregato dei destinatari.
ToCCEmail	String	No	Indirizzo email dei destinatari che riceveranno una copia della tua email.
ToCCName	String	No	Il nome dei destinatari che riceveranno una copia della tua email.
ToBCCName	String	No	Nome dei destinatari che riceveranno una copia nascosta della tua email.
ToBCC	String	No	Il dato aggregato per i destinatari in Ccn.
ReplyToEmail	String	No	L'indirizzo email della persona a cui stai rispondendo.
ReplyToName	String	No	Il nome della persona a cui stai rispondendo.
AttachmentPaths	String	No	Percorso del file da allegare alla posta da inviare.
TemplateId	String	No	L'ID del modello che potresti voler inviare.
DynamicTemplateData	String	No	I dati del modello dinamico.
Personalizzazioni	String	Sì	Un array di messaggi e dei relativi metadati. Ogni oggetto all'interno delle personalizzazioni può essere considerato come una busta, che definisce chi deve ricevere un singolo messaggio e come deve essere gestito.

Parametri di output dell'azione SendMail

Questa azione restituisce un messaggio di conferma se il messaggio è stato inviato correttamente o meno di SendMail.

Esempi di azioni

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

Esempio - Inviare un'email

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione SendMail e fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value:

   {
   "Personalizations": "[{"subject": "Test Subject2",
   "send_at": 1698659820,
   "from": {"name": "hi","email": "[e-mail]"},
   "to": [{"email": "[e-mail]","name": "test"}]
   }]",   
   "FromName": "SampleName",   
   "FromEmail": "[e-mail]",   
   "Subject": "SubjectAdded",   
   "Content": "[{"value": "[e-mail]","type": "text/plain"}]', Attachments='[{"filename": "Test2.txt","content": "VGVzdCBBdHRhY2htZW50"}]" 
   }

Questa azione restituisce un messaggio di conferma di SendMail. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività avrà un valore simile al seguente:

[{
"Status": "True"
}]

Esempi di operazioni con entità

Questa sezione mostra come eseguire alcune delle operazioni relative alle entità in questo connettore.

Esempio: elencare tutti i contatti

In questo esempio sono elencati tutti i contatti nell'entità NMCContacts.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona NMCContacts dall'elenco Entity.
3. Seleziona l'operazione List e fai clic su Fine.
4. Facoltativamente, nella sezione Input attività dell'attività Connettori, puoi filtrare il set di risultati specificando una clausola di filtro. Ad esempio: City='Bangalore'. Puoi anche specificare più condizioni di filtro utilizzando gli operatori logici. Ad esempio, City='Bangalore' and region='asia-south2'.

Esempio: registrare un record

Questo esempio ottiene un record con l'ID specificato dall'entità NMCSegments.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona NMCSegments dall'elenco Entity.
3. Seleziona l'operazione Get e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su EntityId (ID entità), quindi inserisci 0d44bb3f-d28e-4bcf-aba2-c77be831ad46 nel campo Valore predefinito.

   In questo caso, 0d44bb3f-d28e-4bcf-aba2-c77be831ad46 è un valore di chiave primaria nell'entità NMCSegments.

Esempio: creare un record

Questo esempio crea un record nell'entità NMCSenders.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona NMCSenders dall'elenco Entity.
3. Seleziona l'operazione Create e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value:

   {
   "Nickname": "Test",
   "FromEmail": "[e-mail]",
   "FromName": "testuser",   
   "ReplytoEmail": "[e-mail]",  
   "Address": "NA", 
   "City": "NA", 
   "Country": "India"}

   Se l'integrazione ha esito positivo, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

   {
   "Id": 5360940.0
   }

Esempio: creare un record

Questo esempio crea un record nell'entità NMCLists.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona NMCLists dall'elenco Entity.
3. Seleziona l'operazione Create e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value:

   {
   "Name": "TEST_CON_LIST1699262238224",
   "ContactCount": 3.0}

   Se l'integrazione ha esito positivo, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

   {
   "Id": "d927f128-b718-447a-affe-417f1a8b3abd"}

Esempio: aggiornare un record

Questo esempio aggiorna un record nell'entità NMCSenders.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona NMCSenders dall'elenco Entity.
3. Seleziona l'operazione Update e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value:

   {
   "Nickname": "Test",
   "FromEmail": "[e-mail]",
   "FromName": "testuser",   
   "ReplytoEmail": "[e-mail]",  
   "Address": "NA", 
   "City": "NA", 
   "Country": "India"}

5. Fai clic su entityId e inserisci 5360940.0 nel campo Default Value (Valore predefinito).

   Se l'integrazione ha esito positivo, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

   {
   "Id":"5360940.0"
   }

Esempio: eliminare un record

Questo esempio elimina il record con l'ID specificato nell'entità NMCSegments.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona NMCSegments dall'elenco Entity.
3. Seleziona l'operazione Delete e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su entityId, quindi inserisci c58b9151-7279-428a-bac2-12b4bf2b48b0 nel campo Valore predefinito.

Nota: se l'entità ha una chiave primaria composita, puoi specificare una clausola di filtro.

Utilizzare Terraform per creare connessioni

Puoi utilizzare la risorsa Terraform per creare una nuova connessione.

Per scoprire come applicare o rimuovere una configurazione Terraform, vedi Comandi Terraform di base.

Per visualizzare un modello Terraform di esempio per la creazione di connessioni, vedi il modello di esempio.

Quando crei questa connessione utilizzando Terraform, devi impostare le seguenti variabili nel file di configurazione di Terraform:

Nome parametro	Tipo di dati	Obbligatorio	Descrizione

Utilizzare la connessione SendGrid in un'integrazione

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

• Per capire come creare e utilizzare l'attività Connectors in Apigee Integration, vedi Attività connettori.
• Per capire come creare e utilizzare l'attività Connettori in Application Integration, vedi Attività connettori.

Ricevi assistenza dalla community Google Cloud

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

Passaggi successivi

• Scopri come sospendere e ripristinare una connessione.
• Scopri come monitorare l'utilizzo dei connettori.
• Scopri come visualizzare i log del connettore.