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 :
- Assurez-vous que la connectivité réseau est configurée. Pour en savoir plus sur les schémas de réseau, consultez Connectivité réseau.
- Attribuez le rôle IAM roles/connectors.admin à l'utilisateur qui configure le 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 type spécial de compte Google 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 en savoir plus, consultez 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 Activer des services.
Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer au moment de configurer le connecteur.
Configurer l'authentification à l'aide d'une clé API
- Accédez à Paramètres, puis sélectionnez Clés API.
- Cliquez sur Créer une clé API.
- Saisissez un nom pour votre clé API.
- Sélectionnez l'une des options suivantes : Accès complet, Accès limité ou Accès à la facturation.
- Sélectionnez Accès limité ou Accès à la facturation, puis sélectionnez les autorisations spécifiques pour chaque catégorie.
- Cliquez sur Créer et afficher.
- Copiez la clé API et enregistrez-la pour une utilisation ultérieure.
Configurer le connecteur
Une connexion est propre à 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 :
- Dans la console Cloud, accédez à la page Connecteurs d'intégration > Connexions, puis sélectionnez ou créez un projet Google Cloud.
- Cliquez sur + CRÉER pour ouvrir la page Créer une connexion.
- Dans la section Emplacement, choisissez l'emplacement de la connexion.
- Région : sélectionnez un emplacement dans la liste déroulante.
Pour obtenir la liste de toutes les régions disponibles, consultez Emplacements.
- Cliquez sur SUIVANT.
- Région : sélectionnez un emplacement dans la liste déroulante.
- Dans la section Détails de connexion, procédez comme suit :
- Connecteur : sélectionnez SendGrid dans la liste déroulante des connecteurs disponibles.
- Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
- Dans le champ Nom de connexion, indiquez le nom de l'instance de connexion.
Les noms de connexion doivent répondre aux critères suivants :
- Ils peuvent contenir des lettres, des chiffres ou des traits d'union.
- Les lettres doivent être en minuscules.
- Ils doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
- Ils ne peuvent pas dépasser 49 caractères.
- (Facultatif) Saisissez une description de l'instance de connexion.
- (Facultatif) Activez Cloud Logging, puis sélectionnez un niveau de journalisation. Par défaut, le niveau de journalisation est défini sur
Error
. - Compte de service : sélectionnez un compte de service disposant des rôles requis.
- (Facultatif) Configurez les paramètres des nœuds 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 davantage de transactions pour une connexion, vous devez disposer de plus de nœuds. À l'inverse, moins de nœuds sont nécessaires si une connexion traite moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez 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 améliorer la disponibilité) et le nombre maximal de nœuds sur 50.
- (Facultatif) Cliquez sur + AJOUTER UNE ÉTIQUETTE pour ajouter une étiquette à la connexion sous la forme d'une paire clé/valeur.
- Cliquez sur SUIVANT.
- Dans la section Authentification, saisissez les informations d'authentification. Pour en savoir plus, consultez Configurer l'authentification. |
- Cliquez sur SUIVANT.
- Vérifier : vérifiez vos informations de connexion et d'authentification.
- Cliquez sur Créer.
Configurer l'authentification
- 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 présente des exemples de valeurs pour les différents champs que vous configurez lorsque vous créez 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 du 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 par le biais de 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és. 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, alors que dans un connecteur de serveur de fichiers, ce sont les dossiers, et dans un connecteur de système de messagerie, ce sont les files d'attente.
Toutefois, il est possible qu'un connecteur n'accepte 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é. Voici les opérations possibles :
Lorsque vous sélectionnez une entité dans la liste proposée, cela 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 "Connecteurs". Cependant, si un connecteur n'accepte pas l'une des opérations d'entité, cette opération non compatible ne figure pas dans la liste
Operations
. - Action : une action est une fonction de première classe mise à la disposition de l'intégration par le biais de 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 n'accepte aucune action, auquel cas la liste
Actions
est vide.
Limites du système
Le connecteur SendGrid peut traiter huit transactions par seconde et par nœud, et limite les transactions au-delà de ce seuil. Par défaut, Integration Connectors alloue deux nœuds (pour améliorer la disponibilité) à une connexion.
Pour en savoir plus sur les limites applicables à Integration Connectors, consultez Limites.
Actions
Dans cette section, vous trouverez une liste non exhaustive des actions prises en charge par le connecteur. Pour savoir comment configurer les actions, consultez Exemples d'actions.
Action SendMail2
Cette action envoie un e-mail avec une pièce jointe.
Paramètres d'entrée de l'action "Envoyer un e-mail"
Nom du paramètre | Type de données | Obligatoire | Description |
---|---|---|---|
Objet | Chaîne | Oui | Objet de l'e-mail à envoyer. |
ContentValue | Chaîne | Non | Contenu de l'e-mail à envoyer. |
ContentType | STRING | Non | Type de contenu à envoyer. Les valeurs acceptées sont text/plain et text/html. |
Contenu | Chaîne | Oui | Agrégat pour l'objet "Contenu". |
SendAt | Chaîne | Non | Date et heure auxquelles vous souhaitez que votre e-mail soit envoyé. Il est interdit de planifier des diffusions 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 respectifs des adresses e-mail auxquelles envoyer l'e-mail. |
À | Chaîne | Non | Agrégat pour les destinataires. |
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 cachée de votre e-mail. |
ToBCC | Chaîne | Non | Agrégat pour les destinataires en copie cachée. |
ReplyToEmail | Chaîne | Non | Adresse e-mail de la personne à laquelle vous répondez. |
ReplyToName | Chaîne | Non | Nom de la personne à laquelle vous répondez. |
AttachmentPaths | Chaîne | Non | Chemin d'accès au fichier à joindre à l'e-mail à envoyer. |
TemplateId | Chaîne | Oui | ID 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 de leurs métadonnées. Chaque objet de personnalisation 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 "Envoyer un e-mail"
Cette action renvoie un message de confirmation indiquant si l'e-mail a bien été envoyé.
Exemples d'actions
Cette section explique comment effectuer certaines actions dans ce connecteur.
Exemple : Envoyer un e-mail
- Dans la boîte de dialogue
Configure connector task
, cliquez surActions
. - Sélectionnez l'action
SendMail2
, puis cliquez sur OK. - 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 champDefault 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\"}]" }
Cette action renvoie un message de confirmation. Si l'action aboutit, le paramètre de réponse connectorOutputPayload
de la tâche aura une valeur semblable à la suivante :
[{ "Success": "True" }]
Exemples d'opérations d'entité
Cette section explique comment effectuer certaines opérations d'entité dans ce connecteur.
Exemple : Lister tous les contacts
Cet exemple liste tous les contacts de l'entité NMCContacts
.
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez
NMCContacts
dans la listeEntity
. - Sélectionnez l'opération
List
, puis cliquez sur OK. - (Facultatif) Dans la section Entrée de la tâche de la tâche Connecteurs, vous pouvez filtrer votre ensemble de résultats en spécifiant une clause de filtre.
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 : Récupérer un enregistrement
Cet exemple récupère un enregistrement ayant l'ID spécifié à partir de l'entité NMCSegments
.
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez
NMCSegments
dans la listeEntity
. - Sélectionnez l'opération
Get
, puis cliquez sur OK. - Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur EntityId, puis saisissez
0d44bb3f-d28e-4bcf-aba2-c77be831ad46
dans le champ 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
.
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez
NMCSenders
dans la listeEntity
. - Sélectionnez l'opération
Create
, puis cliquez sur OK. - 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 champDefault 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 la tâche "Connecteurs" aura une valeur semblable à la suivante :{ "Id": 5360940.0 }
Exemple : Créer un enregistrement
Cet exemple crée un enregistrement dans l'entité NMCLists
.
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez
NMCLists
dans la listeEntity
. - Sélectionnez l'opération
Create
, puis cliquez sur OK. - 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 champDefault Value
:{ "Name": "TEST_CON_LIST1699262238224", "ContactCount": 3.0}
Si l'intégration aboutit, le champ
connectorOutputPayload
de la tâche "Connecteurs" aura une valeur semblable à la suivante :{ "Id": "d927f128-b718-447a-affe-417f1a8b3abd"}
Exemple : Mettre à jour un enregistrement
Cet exemple met à jour un enregistrement dans l'entité NMCSenders
.
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez
NMCSenders
dans la listeEntity
. - Sélectionnez l'opération
Update
, puis cliquez sur OK. - 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 champDefault Value
:{ "Nickname": "Test", "FromEmail": "test2@examplepetstore.com", "FromName": "testuser", "ReplytoEmail": "test2@examplepetstore.com", "Address": "NA", "City": "NA", "Country": "India"}
- Cliquez sur entityId, puis saisissez
5360940.0
dans le champ Valeur par défaut.Si l'intégration aboutit, le champ
connectorOutputPayload
de la tâche "Connecteurs" aura une valeur semblable à la suivante :{ "Id":"5360940.0" }
Exemple : Supprimer un enregistrement
Cet exemple supprime l'enregistrement ayant l'ID spécifié dans l'entité NMCSegments
.
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez
NMCSegments
dans la listeEntity
. - Sélectionnez l'opération
Delete
, puis cliquez sur OK. - Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez
c58b9151-7279-428a-bac2-12b4bf2b48b0
dans le champ Valeur par défaut.
Créer des connexions à l'aide de Terraform
Vous pouvez utiliser la ressource Terraform pour créer une connexion.
Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez Commandes Terraform de base.
Pour afficher un exemple de modèle Terraform permettant de créer une connexion, consultez 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 | Obligatoire | Description |
---|
Utiliser la connexion SendGrid dans une intégration
Une fois la connexion créée, elle devient disponible dans Apigee Integration et Application Integration. Vous pouvez utiliser la connexion dans une intégration au moyen de la tâche "Connecteurs".
- Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez Tâche "Connecteurs".
- Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Application Integration, consultez Tâche "Connecteurs".
Demander de l'aide à la communauté Google Cloud
Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.Étapes suivantes
- Découvrez comment suspendre et reprendre une connexion.
- Découvrez comment surveiller l'utilisation des connecteurs.
- Découvrez comment afficher les journaux des connecteurs.