SendGrid

Il connettore SendGrid ti 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. configurazione del 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 eseguire l'autenticazione ed essere autorizzato ad accedere ai dati nelle API Google. Se non hai un account di servizio, devi crearne uno. Per maggiori informazioni, consulta Creare un account di servizio.

    • Attiva 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 attivati in precedenza per il tuo progetto, ti verrà chiesto di attivarli durante la configurazione del connettore.

Configurare l'autenticazione utilizzando la chiave API

  1. Vai a Settings (Impostazioni) e seleziona API Keys (Chiavi API).
  2. Fai clic su Crea chiave API.
  3. Inserisci un nome per la chiave API
  4. Seleziona una delle opzioni Accesso completo, Accesso limitato o Accesso per la fatturazione
  5. Seleziona Accesso limitato o Accesso fatturazione e seleziona le autorizzazioni specifiche per ciascuna categoria.
  6. Fai clic su Crea e visualizza.
  7. Copia la chiave API e salvala per utilizzarla in un secondo momento.

Configura il connettore

Per configurare il connettore è necessario creare una connessione al tuo origine dati (sistema di backend). Una connessione è specifica per un'origine dati. Ciò significa che se hai molte origini dati, devi creare una connessione distinta per ciascuna. Per creare una connessione:

  1. Nella console Cloud, vai a Connettori di integrazione > Pagina Connessioni e poi selezionare o creare un progetto Google Cloud.

    Vai alla pagina Connessioni

  2. Fai clic su + CREA NUOVO per aprire la pagina Crea connessione.
  3. Nella sezione Località, scegli la località della 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 i seguenti passaggi:
    1. Connettore: seleziona SendGrid dall'elenco a discesa dei connettori disponibili.
    2. Versione del 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. Facoltativamente, fai clic su + AGGIUNGI ETICHETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
    9. 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. Rivedi: controlla i dettagli di connessione e autenticazione.
  8. Fai clic su Crea.

Configura autenticazione

  • Autenticazione della chiave API
    • Chiave API: seleziona l'API secret di Secret Manager della chiave API.
    • Versione secret: seleziona la versione del secret.
  • Esempi di configurazione della connessione

    Questa sezione elenca i valori di esempio per i vari campi che configuri durante la creazione della connessione SendGrid.

    Tipo di connessione web

    Nome campo Dettagli
    Località us-central1
    Connettore SendGrid
    Versione del connettore 1
    Nome collegamento sendgrid-google-cloud-conn
    Account di servizio SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
    Numero minimo di nodi 2
    Numero massimo di nodi 50
    Chiave API API_KEY
    Versione secret 1

    Entità, operazioni e azioni

    Tutti gli Integration Connectors forniscono un livello di astrazione per gli oggetti dell'applicazione collegata. 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 disponga di entità. In questo 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 sulle entità, queste operazioni non supportate 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 ti consente di apportare modifiche a una o più entità e varia da un connettore all'altro. Normalmente, un'azione ha alcuni parametri di input e un output . Tuttavia, è possibile che un connettore non supporti alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

    Limitazioni del sistema

    Il connettore SendGrid può elaborare 8 transazioni al secondo per nodo e limita le transazioni oltre 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.

    Azioni

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

    Azione SendMail

    Questa azione invia un'email insieme all'allegato.

    Parametri di input dell'azione SendMail

    Nome parametro Tipo di dati Obbligatorio Descrizione
    Oggetto Stringa L'oggetto della posta da inviare.
    ContentValue Stringa No I contenuti della posta da inviare.
    ContentType Stringa No Il tipo di contenuti da inviare. I valori supportati sono text/plain e text/html.
    Contenuti Stringa L'aggregato per l'oggetto Content.
    InviaA Stringa No La data e l'ora in cui vuoi che l'email venga inviata. La programmazione con più di 72 ore di anticipo è vietata.
    FromEmail Stringa L'indirizzo email del mittente.
    FromName Stringa No Il nome del mittente.
    ToEmail Stringa No Indirizzo email a cui inviare la posta.
    ToName Stringa No Nomi corrispondenti delle email a cui inviare l'email.
    A Stringa No Il valore aggregato per i destinatari diretti.
    ToCCEmail Stringa No Indirizzo email dei destinatari che riceveranno una copia della tua email.
    ToCCName Stringa No Nome dei destinatari che riceveranno una copia della tua email.
    ToBCCName Stringa No Nome dei destinatari che riceveranno una copia nascosta della tua email.
    ToBCC Stringa No Il valore aggregato per i destinatari Ccn.
    ReplyToEmail Stringa No L'indirizzo email della persona a cui stai rispondendo.
    ReplyToName Stringa No Il nome della persona a cui stai rispondendo.
    AttachmentPaths Stringa No Percorso del file da allegare alla posta da inviare.
    TemplateId Stringa L'ID del modello che potresti voler inviare.
    DynamicTemplateData Stringa No I dati del modello dinamico.
    Personalizzazioni Stringa Un array di messaggi e relativi metadati. Ogni oggetto all'interno delle personalizzazioni può essere considerato una busta: 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 che indica se l'invio della posta è andato a buon fine o meno.

    Esempi di azioni

    Questa sezione descrive come eseguire alcune delle 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 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:
      {
          "FromName": "Name",
          "FromEmail": "cloudysanfrancisco@gmail.com",
          "Subject": "[{\"value\": \"cymbalgroup.com\",\"type\": \"text/plain\"}]",
          "TemplateId": "d-c4bc730a0b094a3a9d9cabb7347b5edc",
          "Personalizations": "[{\"subject\": \"Test Subject3\",\"send_at\": 1698659820,\"from\": {\"name\": \"hi\",\"email\": \"email@gmail\"},\"to\":      
          [{\"email\": \"email@gmail.com\",\"name\": \"test\"}\n ]}]",
          "Content": "[{\"value\": \"abc@cdata.com\",\"type\": \"text/plain\"}]"
      }
    4. Questa azione restituisce il messaggio di conferma di SendMail. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività avrà un valore simile al seguente:

      [{
      "Success": "True"
      }]

    Esempi di operazioni sulle entità

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

    Esempio: elenca 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 filtra 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: ottieni un record

    Questo esempio recupera 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 e quindi inserisci 0d44bb3f-d28e-4bcf-aba2-c77be831ad46 nel campo Valore predefinito.

      Qui, 0d44bb3f-d28e-4bcf-aba2-c77be831ad46 è un valore della 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, quindi inserisci un valore simile al seguente nella Campo Default Value:
      {
      "Nickname": "Test",
      "FromEmail": "test1@examplepetstore.com",
      "FromName": "testuser",   
      "ReplytoEmail": "test1@examplepetstore.com",  
      "Address": "NA", 
      "City": "NA", 
      "Country": "India"}

      Se l'integrazione è andata a buon fine, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

      {
      "Id": 5360940.0
      }

    Esempio: crea 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, quindi inserisci un valore simile al seguente nella Campo Default Value:
      {
      "Name": "TEST_CON_LIST1699262238224",
      "ContactCount": 3.0}

      Se l'integrazione è andata a buon fine, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

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

    Esempio: aggiorna 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, quindi inserisci un valore simile al seguente nella Campo Default Value:
      {
      "Nickname": "Test",
      "FromEmail": "test2@examplepetstore.com",
      "FromName": "testuser",   
      "ReplytoEmail": "test2@examplepetstore.com",  
      "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 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 e quindi inserisci c58b9151-7279-428a-bac2-12b4bf2b48b0 nel campo Valore predefinito.

    Utilizzare Terraform per creare connessioni

    Puoi utilizzare la risorsa Terraform per creare una nuova connessione.

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

    Per visualizzare un modello Terraform di esempio per la creazione di una connessione, consulta il modello di esempio.

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

    Nome parametro Tipo di dati Obbligatorio Descrizione

    Utilizzare la connessione SendGrid 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 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 ai forum Cloud.

    Passaggi successivi