Gmail

Le connecteur Gmail vous permet d'effectuer des opérations de lecture et de suppression sur Gmail.

Versions compatibles

Ce connecteur est compatible avec les API REST Gmail.

Avant de commencer

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

  • Dans votre projet Google Cloud :
    • 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 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 :

  1. Dans la console Cloud, accédez à la page Integration Connectors > 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, procédez comme suit :
    1. Région : sélectionnez un emplacement dans la liste déroulante.

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

    2. Cliquez sur Suivant.
  4. Dans la section Détails de la connexion, procédez comme suit :
    1. Connecteur : sélectionnez Gmail dans la liste des connecteurs disponibles.
    2. Version du connecteur : sélectionnez la version du connecteur dans la liste des versions disponibles.
    3. Dans le champ Nom de connexion, indiquez le nom de l'instance de connexion. Le nom de la connexion peut contenir des lettres minuscules, des chiffres ou des traits d'union. Il doit commencer par une lettre et se terminer par une lettre ou un chiffre. Il ne doit pas dépasser 49 caractères.
    4. Description : saisissez une description de l'instance de connexion.
    5. (Facultatif) Activez 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. (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.

    8. + AJOUTER UNE ÉTIQUETTE : cliquez sur cette option pour ajouter une étiquette à la connexion sous la forme d'une paire clé/valeur.
    9. Cliquez sur Suivant.
  5. Dans la section Authentification, saisissez les informations d'authentification.
    1. Sélectionnez un type d'authentification, puis saisissez les informations appropriées.

      Les types d'authentification suivants sont compatibles avec la connexion Gmail :

      • Authentification par compte de service
      • Jeton de support JWT OAuth 2.0
      • Code d'autorisation OAuth 2.0

      Pour savoir comment configurer ce type d'authentification, consultez Configurer l'authentification.

    2. Cliquez sur Suivant.
  6. Vérifier : vérifiez vos informations de connexion et d'authentification.
  7. Cliquez sur Créer.

Configurer l'authentification

Saisissez les informations en fonction de l'authentification que vous souhaitez utiliser.

  • Authentification par compte de service : aucune configuration supplémentaire n'est requise pour ce type d'authentification. Le compte de service que vous avez sélectionné dans la section Informations de connexion sera utilisé pour l'authentification.
  • Jeton de support JWT OAuth 2.0
    • Certificat JWT : sélectionnez le certificat à utiliser pour l'authentification JWT.
    • Version du secret : saisissez la version secrète du certificat JWT.
    • Sujet JWT : saisissez le sujet JWT.
    • Enable Authentication Override (Activer le remplacement de l'authentification) : activez cette option pour remplacer l'authentification.
  • Code d'autorisation OAuth 2.0
    • ID client : saisissez l'ID client à utiliser pour l'authentification OAuth.
    • Niveaux d'accès : saisissez une liste des niveaux d'accès souhaités.
    • Code secret du client : code secret du client à utiliser pour l'authentification OAuth.
    • Version du secret : saisissez la version du secret du code secret du client.
    • Enable Authentication Override (Activer le remplacement de l'authentification) : activez cette option pour remplacer l'authentification.

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.

Type de connexion avec un jeton de support JWT OAuth 2.0

Nom du champ Détails
Emplacement asia-east1
Connecteur Gmail
Version du connecteur 1
Nom de connexion gmail-jwt-conn
Activer Cloud Logging vrai
Compte de service mon-compte-service@mon-projet.iam.gserviceaccount.com
Nombre minimal de nœuds 2
Nombre maximal de nœuds 50
Authentification Jeton de support JWT OAuth 2.0
Certificat JWT Certificat JWT
Version du secret 1

Type de connexion avec un code d'autorisation OAuth 2.0

Nom du champ Détails
Emplacement us-central1
Connecteur Gmail
Version du connecteur 1
Nom de connexion gmail-auth-conn
Activer Cloud Logging Oui
Compte de service mon-compte-service@mon-projet.iam.gserviceaccount.com
Nombre minimal de nœuds 2
Nombre maximal de nœuds 50
Authentification Code d'autorisation OAuth 2.0
ID client 60875425788659-mt0cm1tguyiagvst468fvaw7.apps.googleusercontent.com
Niveaux d'accès https://mail.google.com/
Code secret du client ygdruoX-Rtyah9gzkdZc-7CB0Eng9hyaufD0VD
Version du secret 1

Limites du système

Le connecteur Gmail peut traiter au maximum une transaction 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.

Utiliser la connexion Gmail 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 de 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".

Actions

Cette section explique comment effectuer certaines actions dans ce connecteur.

Action SendMailMessages

Cette action envoie un message Gmail.

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

Nom du paramètre Type de données Obligatoire Description
À Chaîne Oui Adresse e-mail du destinataire principal. Pour plusieurs destinataires, utilisez une liste d'éléments séparés par une virgule.
AttachmentHasBytes Chaîne Non Définissez cette valeur sur "true" si le contenu de la pièce jointe est fourni dans AttachmentContentBytes (encodé en Base64), ou sur "false" si le contenu est fourni sous forme de chaîne dans AttachmentContent. Valeur par défaut : "false".
AttachmentFileName Chaîne Non Nom du fichier à joindre. Ce paramètre est utilisé lorsque AttachmentHasBytes est défini sur "false" ou n'est pas fourni.
Objet Chaîne Oui Objet de l'e-mail.
AttachmentContent Chaîne Non Contenu de la chaîne du fichier à joindre. Ce paramètre est utilisé lorsque AttachmentHasBytes est défini sur "false" ou n'est pas fourni.
BCC Chaîne Non Adresse e-mail du destinataire en copie cachée. Pour plusieurs destinataires, utilisez une liste d'éléments séparés par une virgule.
AttachmentContentBytes Chaîne Non Contenu du fichier à joindre sous forme d'octets encodés en base64. Ce paramètre est utilisé lorsque AttachmentHasBytes est défini sur "true".
CC Chaîne Non Adresse e-mail du destinataire en copie. Pour plusieurs destinataires, utilisez une liste d'éléments séparés par une virgule.
Contenu Chaîne Oui Contenu principal de l'e-mail.
AttachmentPath STRING Non Liste de chemins d'accès locaux aux fichiers à joindre à l'e-mail, séparés par une virgule.

Pour obtenir un exemple de configuration de l'action SendMailMessages, consultez Exemples.

Action DownloadAttachment

Cette action télécharge une pièce jointe depuis Gmail.

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

Nom du paramètre Type de données Obligatoire Description
MessageId STRING Oui ID de l'e-mail.
DownloadLocation Chaîne Non Emplacement où la pièce jointe sera enregistrée.
FileStream STRING Non Instance d'un flux de sortie dans lequel les données de fichier sont écrites.
AttachmentId STRING Non ID de la pièce jointe. Il doit être fourni si FileStream est spécifié.

Pour obtenir un exemple de configuration de l'action DownloadAttachment, consultez Exemples.

Exemples d'actions

Cette section explique comment effectuer certaines actions dans ce connecteur.

Exemple : Envoyer un message Gmail

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action SendMailMessages, 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 :
    {
      "To": "testbristleconeemail@gmail.com",
      "Subject": "Data MapperCheck",
      "Content": "Gmail",
    }
    
  4. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    [{
    "Id": "199334f660ff462a"
    }]
    

Exemple : Envoyer un message Gmail avec une pièce jointe au format JPG

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action SendMailMessages, 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 :
     {
    "To": "testbristleconeemail@gmail.com",
    "Subject": "Data Mapper Email Sep10 JPG",
    "Content": "Gmail",
    "AttachmentFileName": "TestSep10.jpg",
    "AttachmentContentBytes": "/9j/4AAQSkZJRgABAQEBLAEsAAD/2wBDAAIBAQEBAQIBAQECAgICAgQDAgICAgUEBAMEBgUGBgYFBgYGBwkIBgcJBwYGCAsICQoKCgoKBggLDAsKDAkKCgr/2wBDAQICAgICAgUDAwUKBwYHCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgr/wAARCANUBdwDAREAAhEBAxEB/8QAHgABAAAGAwEAAAAAAAAAAAAAAAEDBAcICQIFBgr/xABsEAABAwMCBAMFBQQHAwUJACMBAgMEAAURBgcIEiExCRNBChQiUWEVIzJxgUJSkaEWFzNicrHBJEPRNFOCkqIYJTlEY4O14fDxJmRzdXZ3k7PCNTY4haOytLYZN1RVV8NIVmV0eJSWpNLT4v/EAB0BAQABBAMBAAAAAAAAAAAAAAAHAQQFBgIDCAn/xABXEQABAwURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIv/Z",
    "AttachmentHasBytes": true
    }
    
  4. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    [{
      "Id": "199334f660ff462a"
    }]
    

Exemple : Envoyer un message Gmail avec une pièce jointe au format PDF

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action SendMailMessages, 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 :
    {
      "To": "testbristleconeemail@gmail.com",
      "Subject": "Data Mapper Email Sep10",
      "Content": "Gmail",
      "AttachmentFileName": "TestSep10.pdf",
      "AttachmentContent": "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nD2OywoCMQxF9/mKu3YRk7bptDAIDuh+oOAP+AAXgrOZ37etjmSTe3ISIljpDYGwwrKxRwrKGcsNlx1e31mt5UFTIYucMFiqcrlif1ZobP0do6g48eIPKE+ydk6aM0roJG/RegwcNhDr5tChd+z+miTJnWqoT/3oUabOToVmmvEBy5IoCgplbmRzdHJlYW0KZW5kb2JqCgozIDAgb2JqCjEzNAplbmRvYmoKCjUgMCBvYmoKPDwvTGVuZ3RoIDYgMCBSL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGgxIDIzMTY0Pj4Kc3RyZWFtCnic7Xx5fFvVlf+59z0tdrzIu7xFz1G8Kl7i2HEWE8vxQlI3iRM71A6ksSwrsYptKZYUE9omYStgloZhaSlMMbTsbSPLAZwEGgNlusxQ0mHa0k4Z8muhlJb8ynQoZVpi/b736nkjgWlnfn/8Pp9fpNx3zz33bPecc899T4oVHA55KIEOkUJO96DLvyQxM5WI/omIpbr3BbU/3J61FPBpItOa3f49g1948t/vI4rLIzL8dM/A/t3vn77ZSpT0LlH8e/0eV98jn3k0mSj7bchY2Q/EpdNXm4hyIIOW9g8Gr+gyrq3EeAPGVQM+t+uw5VrQ51yBcc6g6wr/DywvGAHegbE25Br0bFR/ezPGR4kq6/y+QPCnVBYl2ijka/5hjz95S8kmok8kEFl8wDG8xQtjZhRjrqgGo8kcF7+I/r98GY5TnmwPU55aRIhb9PWZNu2Nvi7mRM9/C2flx5r+itA36KeshGk0wf5MWfQ+y2bLaSOp9CdkyxE6S3dSOnXSXSyVllImbaeNTAWNg25m90T3Rd+ii+jv6IHoU+zq6GOY/yL9A70PC/5NZVRHm0G/nTz0lvIGdUe/Qma6nhbRWtrGMslFP8H7j7DhdrqDvs0+F30fWtPpasirp0ZqjD4b/YDK6Gb1sOGVuCfoNjrBjFF31EuLaQmNckf0J9HXqIi66Wv0DdjkYFPqBiqgy+k6+jLLVv4B0J30dZpmCXy",
      "AttachmentHasBytes": true
    }
    
  4. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    [{
      "Id": "1993341d558d7b07"
    }]
    

Exemple : Envoyer un message Gmail avec une pièce jointe TXT

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action SendMailMessages, 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 :
    {
      "To": "testbristleconeemail@gmail.com",
      "Subject": "Data Mapper Email Sep10",
      "Content": "Gmail",
      "AttachmentFileName": "TestSep10.txt",
      "AttachmentContent": "TestingwithAttachment",
      "AttachmentHasBytes": true
    }
    
  4. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    [{
        "Id": "1993341d558d7b07"
    }]
    

Exemple : Télécharger une pièce jointe depuis Gmail

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action DownloadAttachment, 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 :
    {
      "MessageId": "198acdcde5c09ce5"
    }
    
  4. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    [{
        "Success": "true",
        "MessageId": "198acdcde5c09ce5",
        "AttachmentId": "1",
        "Size": "58005",
        "Data": "JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9UaXRsZSAoYWJvdXQ6YmxhbmspCi9DcmVhdG9yIChNb3ppbGxhLzUuMCBcKFgxMTsgTGludXggeDg2XzY0XCkgQXBwbGVXZWJLaXQvNTM3LjM2IFwoS0hUTUwsIGxpa2UgR2Vja29cKSBIZWFkbGVzc0Nocm9tZS8xMzguMC4wLjAgU2FmYXJpLzUzNy4zNikKL1Byb2R1Y2VyIChTa2lhL1BERiBtMTM4KQovQ3JlYXRpb25EYXRlIChEOjIwMjUwODE1MDgwMDE2KzAwJzAwJykKL01vZERhdGUgKEQ6MjAyNTA4MTUwODAwMTYrMDAnMDAnKT4-CmVuZG9iagozIDAgb2JqCjw8L2NhIDEKL0JNIC9Ob3JtYWw-PgplbmRvYmo",
        "Filename": "My_Store_404672162.pdf",
        "@isoutervalue": null
    }]
    

Exemples d'opérations d'entité

Cette section explique comment effectuer certaines opérations d'entité dans ce connecteur.

Exemple : Lister tous les messages Gmail

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Messages dans la liste Entity.
  3. Sélectionnez l'opération List, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, vous pouvez définir la filterClause en fonction des exigences du client.
  5. Vous devez placer la valeur d'une filterClause entre des guillemets simples ('). Vous pouvez utiliser filterClause pour filtrer les enregistrements en fonction des colonnes.

Exemple : Obtenir les détails d'un message Gmail dans la boîte de réception

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Inbox dans la liste Entity.
  3. Sélectionnez l'opération Get, puis cliquez sur OK.
  4. Définissez entityId sur 1, qui est la clé à transmettre. Pour définir l'entityId, dans la section Data Mapper de la tâche Mappage de données, cliquez sur Ouvrir l'éditeur de mappage de données, puis saisissez 1 dans le champ Valeur d'entrée et choisissez "entityId" comme variable locale.
  5. La valeur de entityId doit être transmise directement, par exemple "1". Ici, "1" est la valeur de clé primaire unique, qui est transmise.

    Dans certains cas, la transmission d'un seul entityId peut entraîner une erreur, car l'entité comporte deux clés composites. Dans ce cas, vous pouvez utiliser filterClause et transmettre la valeur, par exemple id='1'.

Exemple : Supprimer un message Gmail

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Messages dans la liste Entity.
  3. Sélectionnez l'opération Delete, puis cliquez sur OK.
  4. Définissez entityId sur 1, qui est la clé à transmettre.
  5. Pour définir entityId, dans la section Data Mapper de Mappage de données, cliquez sur Ouvrir l'éditeur de mappage de données, puis saisissez 1 dans le champ Valeur d'entrée et choisissez entityId comme variable locale.

    Si l'entité comporte deux clés métier ou clés primaires composites, vous pouvez définir la filterClause sur id='1' au lieu de spécifier l'entityId.

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