SendGrid

Le connecteur SendGrid vous permet d'effectuer des opérations d'insertion, de suppression, de mise à jour et de lecture sur l'ensemble de données SendGrid.

Avant de commencer

Avant d'utiliser le connecteur SendGrid, effectuez les tâches suivantes :

  • Dans votre projet Google Cloud :
    • Accorder à l'utilisateur le rôle IAM roles/connectors.admin configuration du connecteur.
    • Attribuez les rôles IAM suivants au compte de service que vous souhaitez utiliser pour le connecteur :
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Un compte de service est un compte Google spécial destiné à représenter un utilisateur non humain qui doit s'authentifier et obtenir les autorisations permettant d'accéder aux données des API Google. Si vous ne possédez pas de compte de service, vous devez en créer un. Pour plus d'informations, consultez la section Créer un compte de service.

    • Activez les services suivants :
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Pour savoir comment activer des services, consultez la page Activer des services.

    Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer lors de la configuration du connecteur.

Configurer l'authentification à l'aide d'une clé API

  1. Accédez à Paramètres, puis sélectionnez Clés API.
  2. Cliquez sur Créer une clé API.
  3. Saisissez un nom pour votre clé API
  4. Sélectionnez l'option Accès complet, Accès limité ou Accès à la facturation.
  5. Sélectionnez Accès limité ou Accès à la facturation, puis les autorisations spécifiques pour chaque catégorie.
  6. Cliquez sur Créer et afficher.
  7. Copiez la clé API et enregistrez-la pour une utilisation ultérieure.

Configurer le connecteur

Pour configurer le connecteur, vous devez créer une connexion à votre source de données (système backend). Une connexion est spécifique à une source de données. Cela signifie que si vous disposez de nombreuses sources de données, vous devez créer une connexion distincte pour chacune d'elles. Pour créer une connexion, procédez comme suit :

  1. Dans la console Cloud, accédez à la page Integration Connectors > Connections (Connecteurs d'intégration > Connexions), puis sélectionnez ou créez un projet Google Cloud.

    Accéder à la page "Connexions"

  2. Cliquez sur + CRÉER pour ouvrir la page Créer une connexion.
  3. Dans la section Emplacement, choisissez l'emplacement de la connexion.
    1. Région : sélectionnez un emplacement dans la liste déroulante.

      Pour obtenir la liste de toutes les régions disponibles, consultez la page Emplacements.

    2. Cliquez sur NEXT (Suivant).
  4. Dans la section Détails de connexion, procédez comme suit :
    1. Connecteur : sélectionnez SendGrid dans la liste déroulante des connecteurs disponibles.
    2. Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
    3. Dans le champ Nom de connexion, saisissez un nom pour l'instance de connexion.

      Les noms de connexion doivent répondre aux critères suivants :

      • Les noms de connexion peuvent contenir des lettres, des chiffres ou des traits d'union.
      • Les lettres doivent être en minuscules.
      • Les noms de connexion doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
      • Les noms de connexion ne peuvent pas dépasser 49 caractères.
    4. Saisissez éventuellement une Description pour l'instance de connexion.
    5. Vous pouvez également activer Cloud Logging. puis sélectionnez un niveau de journalisation. Par défaut, le niveau de journalisation est défini sur Error.
    6. Compte de service : sélectionnez un compte de service disposant des rôles requis.
    7. Vous pouvez également configurer les paramètres du nœud de connexion :

      • Nombre minimal de nœuds : saisissez le nombre minimal de nœuds de connexion.
      • Nombre maximal de nœuds : saisissez le nombre maximal de nœuds de connexion.

      Un nœud est une unité (ou instance répliquée) de connexion qui traite des transactions. Pour traiter plus de transactions pour une connexion, plus de nœuds sont nécessaires. À l'inverse, moins de nœuds sont nécessaires pour traiter moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez la section Tarifs des nœuds de connexion. Si vous ne saisissez aucune valeur, le nombre minimal de nœuds est défini par défaut sur 2 (pour une meilleure disponibilité) et le nombre maximal sur 50.

    8. Vous pouvez également cliquer sur + AJOUTER UN LIBELLÉ pour ajouter un libellé à la connexion sous la forme d'une paire clé/valeur.
    9. Cliquez sur NEXT (Suivant).
  5. Dans la section Authentification, saisissez les informations d'authentification. Pour en savoir plus, consultez la section Configurer l'authentification. |
  6. Cliquez sur SUIVANT.
  7. Vérifiez vos informations de connexion et d'authentification.
  8. Cliquez sur Créer.

Configurer l'authentification

  • Authentification par clé API
    • Clé API: sélectionnez le secret Secret Manager de la clé API.
    • Version du secret : sélectionnez la version du secret.
    •

    Exemples de configuration de connexion

    Cette section répertorie des exemples de valeurs pour les différents champs que vous configurez lors de la création de la connexion SendGrid.

    Type de connexion Web

    Nom du champ Détails
    Emplacement us-central1
    Connecteur Sendgrid
    Version du connecteur 1
    Nom de connexion sendgrid-google-cloud-conn
    Compte de service SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
    Nombre minimal de nœuds 2
    Nombre maximal de nœuds 50
    Clé API API_KEY
    Version de secret 1

    Entités, opérations et actions

    Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que via cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

    • Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connecté. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, dans un connecteur de serveur de fichiers, les dossiers sont les entités et, dans un connecteur de système de messagerie, les files d'attente sont les entités.

      Toutefois, il est possible qu'un connecteur ne soit pas compatible ou ne possède aucune entité. Dans ce cas, la liste Entities est vide.

    • Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Vous pouvez effectuer l'une des opérations suivantes sur une entité :

      La sélection d'une entité dans la liste disponible génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche de connecteur. Toutefois, si un connecteur n'est pas compatible avec l'une des opérations d'entité, ces opérations non compatibles ne sont pas listées dans la liste Operations.

    • Action : une action est une fonction de première classe mise à la disposition de l'intégration via l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et un paramètre de sortie. Toutefois, il est possible qu'un connecteur ne prenne en charge aucune action, auquel cas la liste Actions est vide.

    Limites du système

    Le connecteur SendGrid peut traiter 8 transactions par seconde, par nœud, et throttles toutes les transactions au-delà de cette limite. Par défaut, Integration Connectors alloue deux nœuds (pour une meilleure disponibilité) à une connexion.

    Pour en savoir plus sur les limites applicables à Integration Connectors, consultez la section Limites.

    Actions

    Cette section répertorie certaines actions possibles avec le connecteur. Pour comprendre comment configurer consultez la section Exemples d'actions.

    Action SendMail

    Cette action envoie un e-mail avec une pièce jointe.

    Paramètres d'entrée de l'action SendMail

    Nom du paramètre Type de données Requis Description
    Objet Chaîne Oui Objet de l'e-mail à envoyer.
    ContentValue Chaîne Non Contenu de l'e-mail à envoyer.
    ContentType Chaîne Non Type de contenu à envoyer. Les valeurs acceptées sont text/plain et text/html.
    Contenu Chaîne Oui Agrégation pour l'objet "Contenu".
    SendAt Chaîne Non Date et heure auxquelles vous souhaitez que l'e-mail soit distribué. Il est interdit de planifier plus de 72 heures à l'avance.
    FromEmail Chaîne Oui Adresse e-mail de l'expéditeur.
    FromName Chaîne Non Nom de l'expéditeur.
    ToEmail Chaîne Non Adresse e-mail à laquelle envoyer l'e-mail.
    ToName Chaîne Non Noms des adresses e-mail auxquelles envoyer l'e-mail.
    À Chaîne Non Total pour les destinataires de l'adresse "À".
    ToCCEmail Chaîne Non Adresse e-mail des destinataires qui recevront une copie de votre e-mail.
    ToCCName Chaîne Non Nom des destinataires qui recevront une copie de votre e-mail
    ToBCCName Chaîne Non Nom des destinataires qui recevront une copie carbone invisible de votre e-mail
    ToBCC Chaîne Non Agrégation pour les destinataires ToBCC.
    ReplyToEmail Chaîne Non Adresse e-mail de la personne à laquelle vous répondez.
    ReplyToName Chaîne Non Le nom de la personne à laquelle vous répondez
    AttachmentPaths Chaîne Non Chemin d'accès du fichier à joindre au message à envoyer.
    TemplateId Chaîne Oui Identifiant du modèle que vous souhaitez envoyer.
    DynamicTemplateData Chaîne Non Données du modèle dynamique.
    Personnalisations Chaîne Oui Tableau de messages et leurs métadonnées. Chaque objet des personnalisations peut être considéré comme une enveloppe. Il définit qui doit recevoir un message individuel et comment ce message doit être traité.

    Paramètres de sortie de l'action SendMail

    Cette action renvoie un message de confirmation indiquant que l'e-mail a bien été envoyé par SendMail.

    Exemples d'actions

    Cette section explique comment effectuer certaines actions dans ce connecteur.

    Exemple : Envoyer un e-mail

    1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
    2. Sélectionnez l'action SendMail, puis cliquez sur OK.
    3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ 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. Cette action renvoie un message de confirmation du SendMail. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche aura une valeur semblable à celle-ci :

      [{
"Success": "True"
}]

    Exemples d'opérations sur les entités

    Cette section explique comment effectuer certaines opérations sur les entités dans ce connecteur.

    Exemple : Répertorier tous les contacts

    Cet exemple répertorie tous les contacts de l'entité NMCContacts.

    1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
    2. Sélectionnez NMCContacts dans la liste Entity.
    3. Sélectionnez l'opération List, puis cliquez sur OK.
    4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), vous pouvez filtrer votre ensemble de résultats en spécifiant une clause de filtre. Par exemple, City='Bangalore'. Vous pouvez également spécifier plusieurs conditions de filtre à l'aide des opérateurs logiques. Par exemple, City='Bangalore' and region='asia-south2'.

    Exemple : Obtenir un enregistrement

    Cet exemple récupère un enregistrement avec l'ID spécifié à partir de l'entité NMCSegments.

    1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
    2. Sélectionnez NMCSegments dans la liste Entity.
    3. Sélectionnez l'opération Get, puis cliquez sur OK.
    4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur EntityId (ID d'entité). puis saisissez 0d44bb3f-d28e-4bcf-aba2-c77be831ad46 dans le champ Default Value (Valeur par défaut).

      Ici, 0d44bb3f-d28e-4bcf-aba2-c77be831ad46 est une valeur de clé primaire dans l'entité NMCSegments.

    Exemple : Créer un enregistrement

    Cet exemple crée un enregistrement dans l'entité NMCSenders.

    1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
    2. Sélectionnez NMCSenders dans la liste Entity.
    3. Sélectionnez l'opération Create, puis cliquez sur OK.
    4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value : 
      {
"Nickname": "Test",
"FromEmail": "test1@examplepetstore.com",
"FromName": "testuser",   
"ReplytoEmail": "test1@examplepetstore.com",  
"Address": "NA", 
"City": "NA", 
"Country": "India"}

      Si l'intégration aboutit, le champ connectorOutputPayload de votre tâche de connecteur aura une valeur semblable à celle-ci :

      {
"Id": 5360940.0
}

    Exemple : Créer un enregistrement

    Cet exemple crée un enregistrement dans l'entité NMCLists.

    1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
    2. Sélectionnez NMCLists dans la liste Entity.
    3. Sélectionnez l'opération Create, puis cliquez sur OK.
    4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value : 
      {
"Name": "TEST_CON_LIST1699262238224",
"ContactCount": 3.0}

      Si l'intégration réussit, le champ connectorOutputPayload de votre tâche de connecteur comportera un semblable à celle-ci:

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

    Exemple : Mettre à jour un enregistrement

    Cet exemple met à jour un enregistrement dans l'entité NMCSenders.

    1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
    2. Sélectionnez NMCSenders dans la liste Entity.
    3. Sélectionnez l'opération Update, puis cliquez sur OK.
    4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value : 
      {
"Nickname": "Test",
"FromEmail": "test2@examplepetstore.com",
"FromName": "testuser",   
"ReplytoEmail": "test2@examplepetstore.com",  
"Address": "NA", 
"City": "NA", 
"Country": "India"}
    5. Cliquez sur entityId, puis saisissez 5360940.0 dans le champ Default Value (Valeur par défaut).

      Si l'intégration aboutit, le champ connectorOutputPayload de votre tâche de connecteur aura une valeur semblable à celle-ci :

      {
"Id":"5360940.0"
}

    Exemple : Supprimer un enregistrement

    Cet exemple supprime l'enregistrement avec l'ID spécifié dans l'entité NMCSegments.

    1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
    2. Sélectionnez NMCSegments dans la liste Entity.
    3. Sélectionnez l'opération Delete, puis cliquez sur OK.
    4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur entityId, puis saisissez c58b9151-7279-428a-bac2-12b4bf2b48b0 dans le champ Default Value (Valeur par défaut).

    Utiliser Terraform pour créer des connexions

    Vous pouvez utiliser la ressource Terraform pour créer une connexion.

    Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez la page Commandes Terraform de base.

    Pour afficher un exemple de modèle Terraform pour la création de connexions, consultez cet exemple de modèle.

    Lorsque vous créez cette connexion à l'aide de Terraform, vous devez définir les variables suivantes dans votre fichier de configuration Terraform:

    Nom du paramètre Type de données Requis Description

    Utiliser la connexion SendGrid dans une intégration

    Une fois la connexion créée, elle devient disponible à la fois dans Apigee Integration et Application Integration. Vous pouvez utiliser la connexion dans une intégration via la tâche Connecteurs.

    • Pour comprendre comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez la section Tâche Connecteurs.
    • Pour découvrir comment créer et utiliser la tâche Connecteurs dans Application Integration, consultez la section Tâche Connecteurs.

    Obtenir de l'aide auprès de la communauté Google Cloud

    Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.

    Étape suivante