SendGrid

Mit dem SendGrid-Connector können Sie Vorgänge zum Einfügen, Löschen, Aktualisieren und Lesen im SendGrid-Dataset ausführen.

Hinweis

Führen Sie vor der Verwendung des SendGrid-Connectors die folgenden Aufgaben aus:

  • In Ihrem Google Cloud-Projekt:
    • Prüfen Sie, ob eine Netzwerkverbindung eingerichtet ist. Informationen zu Netzwerkmustern finden Sie unter Netzwerkkonnektivität.
    • Weisen Sie dem Nutzer, der den Connector konfiguriert, die IAM-Rolle roles/connectors.admin zu.
    • Weisen Sie dem Dienstkonto, das Sie für den Connector verwenden möchten, die folgenden IAM-Rollen zu:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Ein Dienstkonto ist eine spezielle Art von Google-Konto, das einen nicht menschlichen Nutzer repräsentiert. Es muss authentifiziert und autorisiert werden, um Zugriff auf Daten in Google APIs zu erhalten. Wenn Sie kein Dienstkonto haben, müssen Sie eins erstellen. Weitere Informationen finden Sie unter Dienstkonto erstellen.

    • Aktivieren Sie die folgenden Dienste:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      Informationen zum Aktivieren von Diensten finden Sie unter Dienste aktivieren.

    Wenn diese Dienste oder Berechtigungen für Ihr Projekt zuvor nicht aktiviert wurden, werden Sie aufgefordert, sie beim Konfigurieren des Connectors zu aktivieren.

Authentifizierung mit einem API-Schlüssel einrichten

  1. Rufen Sie die Einstellungen auf und wählen Sie API-Schlüssel aus.
  2. Klicken Sie auf API-Schlüssel erstellen.
  3. Geben Sie einen Namen für Ihren API-Schlüssel ein.
  4. Wählen Sie eine der Optionen Voller Zugriff, Eingeschränkter Zugriff oder Abrechnungszugriff aus.
  5. Wählen Sie Eingeschränkter Zugriff oder Abrechnungszugriff aus und legen Sie die spezifischen Berechtigungen für jede Kategorie fest.
  6. Klicken Sie auf Erstellen und ansehen.
  7. Kopieren Sie den API-Schlüssel und speichern Sie ihn zur späteren Verwendung.

Connector konfigurieren

Eine Verbindung ist für eine Datenquelle spezifisch. Wenn Sie also viele Datenquellen haben, müssen Sie für jede Datenquelle eine separate Verbindung erstellen. So erstellen Sie eine Verbindung:

  1. Rufen Sie in der Cloud Console die Seite Integration Connectors > Verbindungen auf und wählen Sie ein Google Cloud-Projekt aus oder erstellen Sie eines.

    Zur Seite „Verbindungen“

  2. Klicken Sie auf + NEU ERSTELLEN, um die Seite Verbindung erstellen zu öffnen.
  3. Wählen Sie im Abschnitt Standort den Standort für die Verbindung aus.
    1. Region: Wählen Sie einen Standort aus der Drop-down-Liste aus.

      Eine Liste aller unterstützten Regionen finden Sie unter Standorte.

    2. Tippen Sie auf Weiter.
  4. Führen Sie im Abschnitt Verbindungsdetails folgende Schritte aus:
    1. Connector: Wählen Sie SendGrid aus der Drop-down-Liste der verfügbaren Connectors aus.
    2. Connector-Version: Wählen Sie die Connector-Version aus der Drop-down-Liste der verfügbaren Versionen aus.
    3. Geben Sie im Feld Verbindungsname einen Namen für die Verbindungsinstanz ein.

      Verbindungsnamen müssen die folgenden Kriterien erfüllen:

      • Verbindungsnamen können Buchstaben, Ziffern oder Bindestriche enthalten.
      • Buchstaben müssen Kleinbuchstaben sein.
      • Verbindungsnamen müssen mit einem Buchstaben beginnen und mit einem Buchstaben oder einer Ziffer enden.
      • Verbindungsnamen dürfen maximal 49 Zeichen haben.
    4. Geben Sie optional unter Beschreibung eine Beschreibung für die Verbindungsinstanz ein.
    5. Optional können Sie Cloud Logging aktivieren und dann eine Logebene auswählen. Die Logebene ist standardmäßig auf Error festgelegt.
    6. Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
    7. Konfigurieren Sie optional die Verbindungsknoteneinstellungen:

      • Mindestanzahl von Knoten: Geben Sie die Mindestanzahl von Verbindungsknoten ein.
      • Maximale Anzahl von Knoten: Geben Sie die maximale Anzahl von Verbindungsknoten ein.

      Ein Knoten ist eine Einheit (oder ein Replikat) einer Verbindung, die Transaktionen verarbeitet. Zur Verarbeitung von mehr Transaktionen für eine Verbindung sind mehr Knoten erforderlich. Umgekehrt sind weniger Knoten erforderlich, um weniger Transaktionen zu verarbeiten. Informationen zu den Auswirkungen der Knoten auf Ihre Connector-Preise finden Sie unter Preise für Verbindungsknoten. Wenn Sie keine Werte eingeben, ist die Mindestanzahl von Knoten standardmäßig auf 2 (für eine bessere Verfügbarkeit) und die maximale Knotenzahl auf 50 gesetzt.

    8. Klicken Sie optional auf + LABEL HINZUFÜGEN, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
    9. Tippen Sie auf Weiter.
  5. Geben Sie im Abschnitt Authentifizierung die Authentifizierungsdetails ein. Weitere Informationen finden Sie unter Authentifizierung konfigurieren. |
  6. Tippen Sie auf Weiter.
  7. Überprüfen: Prüfen Sie Ihre Verbindungs- und Authentifizierungsdetails.
  8. Klicken Sie auf Erstellen.

Authentifizierung konfigurieren

  • Authentifizierung von API-Schlüsseln
    • API-Schlüssel: Wählen Sie das Secret Manager-Secret des API-Schlüssels aus.
    • Secret-Version: Wählen Sie die Secret-Version aus.
  • Beispiele für Verbindungskonfigurationen

    In diesem Abschnitt werden die Beispielwerte für die verschiedenen Felder aufgeführt, die Sie beim Erstellen der SendGrid-Verbindung konfigurieren.

    Webverbindungstyp

    Feldname Details
    Standort us-central1
    Connector Sendgrid
    Connector-Version 1
    Verbindungsname sendgrid-google-cloud-conn
    Dienstkonto SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
    Mindestanzahl von Knoten 2
    Maximale Anzahl von Knoten 50
    API-Schlüssel API_KEY
    Secret-Version 1

    Entitäten, Vorgänge und Aktionen

    Alle Integration Connectors bieten eine Abstraktionsebene für die Objekte der verbundenen Anwendung. Sie können nur über diese Abstraktion auf die Objekte einer Anwendung zugreifen. Die Abstraktion wird Ihnen als Entitäten, Vorgänge und Aktionen zur Verfügung gestellt.

    • Entität: Eine Entität kann als Objekt oder Sammlung von Attributen in der verbundenen Anwendung oder im verbundenen Dienst verstanden werden. Die Definition einer Entität unterscheidet sich von Connector zu Connector. Beispiel: In einem Datenbank-Connector sind Tabellen die Entitäten, in einem Dateiserver-Connector sind Ordner die Entitäten und in einem Nachrichtensystem-Connector sind Warteschlangen die Entitäten.

      Es ist jedoch möglich, dass ein Connector keine Entitäten unterstützt oder keine Entitäten enthält. In diesem Fall ist die Liste Entities leer.

    • Vorgang: Ein Vorgang ist die Aktivität, die Sie für eine Entität ausführen können. Sie können einen der folgenden Vorgänge für eine Entität ausführen:

      Durch Auswahl einer Entität aus der verfügbaren Liste wird eine Liste der Vorgänge generiert, die für die Entität verfügbar sind. Eine detaillierte Beschreibung der Vorgänge finden Sie in den Entitätsvorgängen der Connectors-Aufgabe. Wenn ein Connector jedoch keine der Entitätsvorgänge unterstützt, werden diese nicht unterstützten Vorgänge nicht in der Operations-Liste aufgeführt.

    • Aktion: Eine Aktion ist eine Funktion erster Klasse, die über die Connector-Benutzeroberfläche für die Integration verfügbar gemacht wird. Mit einer Aktion können Sie Änderungen an einer oder mehreren Entitäten vornehmen, die von Connector zu Connector unterschiedlich sind. Normalerweise hat eine Aktion einige Eingabeparameter und einen Ausgabeparameter. Es ist jedoch möglich, dass ein Connector keine Aktionen unterstützt. In diesem Fall ist die Actions-Liste leer.

    Systembeschränkungen

    Der SendGrid-Connector kann 8 Transaktionen pro Sekunde und Knoten verarbeiten und drosselt alle Transaktionen, die dieses Limit überschreiten. Standardmäßig werden für eine Verbindung zwei Knoten (für eine bessere Verfügbarkeit) zugewiesen.

    Informationen zu den für Integration Connectors geltenden Limits finden Sie unter Limits.

    Aktionen

    In diesem Abschnitt werden einige der vom Connector unterstützten Aktionen aufgeführt. Informationen zum Konfigurieren der Aktionen finden Sie unter Beispiele für Aktionen.

    Aktion „SendMail2“

    Bei dieser Aktion wird eine E-Mail mit einem Anhang gesendet.

    Eingabeparameter der Aktion „E-Mail senden“

    Parametername Datentyp Erforderlich Beschreibung
    Betreff String Ja Der Betreff der E‑Mail, die gesendet werden soll.
    ContentValue String Nein Der Inhalt der zu sendenden E‑Mail.
    ContentType String Nein Der Typ des zu sendenden Inhalts. Unterstützte Werte sind „text/plain“ und „text/html“.
    Inhalt String Ja Das Aggregat für das Content-Objekt.
    SendAt String Nein Das Datum und die Uhrzeit, zu denen Ihre E‑Mail zugestellt werden soll. Die Planung von Streams mehr als 72 Stunden im Voraus ist nicht zulässig.
    FromEmail String Ja Die E‑Mail-Adresse des Absenders.
    FromName String Nein Der Name des Absenders.
    ToEmail String Nein E‑Mail-Adresse, an die die E‑Mail gesendet werden soll.
    ToName String Nein Die entsprechenden Namen der E-Mail-Adressen, an die die E-Mail gesendet werden soll.
    An String Nein Die Aggregation für „An“-Empfänger.
    ToCCEmail String Nein E-Mail-Adresse der Empfänger, die eine Kopie Ihrer E‑Mail erhalten.
    ToCCName String Nein Name der Empfänger, die eine Kopie Ihrer E-Mail erhalten.
    ToBCCName String Nein Name der Empfänger, die eine Blindkopie Ihrer E-Mail erhalten.
    ToBCC String Nein Die Aggregation für BCC-Empfänger.
    ReplyToEmail String Nein Die E‑Mail-Adresse der Person, der Sie antworten.
    ReplyToName String Nein Der Name der Person, der Sie antworten.
    AttachmentPaths String Nein Pfad der Datei, die an die zu sendende E-Mail angehängt werden soll.
    TemplateId String Ja Die ID der Vorlage, die Sie möglicherweise senden möchten.
    DynamicTemplateData String Nein Die Daten der dynamischen Vorlage.
    Personalisierungen String Ja Ein Array von Nachrichten und ihren Metadaten. Jedes Objekt in der Personalisierung kann als Umschlag betrachtet werden. Es definiert, wer eine individuelle Nachricht erhalten soll und wie diese Nachricht behandelt werden soll.

    Ausgabeparameter der Aktion „E‑Mail senden“

    Diese Aktion gibt eine Bestätigungsmeldung zurück, die angibt, ob die E‑Mail gesendet wurde.

    Beispiele für Aktionen

    In diesem Abschnitt wird beschrieben, wie Sie einige der Aktionen in diesem Connector ausführen.

    Beispiel: E‑Mail senden

    1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
    2. Wählen Sie die Aktion SendMail2 aus und klicken Sie auf Fertig.
    3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:
      {
          "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. Durch diese Aktion wird eine Bestätigungsmeldung zurückgegeben. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Aufgabe einen Wert, der dem folgenden ähnelt:

      [{
      "Success": "True"
      }]

    Beispiele für Entitätsvorgänge

    In diesem Abschnitt wird beschrieben, wie Sie einige Entitätsvorgänge in diesem Connector ausführen.

    Beispiel: Alle Kontakte auflisten

    In diesem Beispiel werden alle Kontakte in der NMCContacts-Entität aufgelistet.

    1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
    2. Wählen Sie NMCContacts aus der Liste Entity aus.
    3. Wählen Sie den Vorgang List aus und klicken Sie auf Fertig.
    4. Optional können Sie im Bereich Aufgabeneingabe der Aufgabe Connectors das Ergebnisset filtern, indem Sie eine Filterklausel angeben. Beispiel: City='Bangalore' Mit den Logikoperatoren können Sie auch mehrere Filterbedingungen angeben. Zum Beispiel: City='Bangalore' and region='asia-south2'.

    Beispiel: Datensatz abrufen

    In diesem Beispiel wird ein Datensatz mit der angegebenen ID aus der NMCSegments-Entität abgerufen.

    1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
    2. Wählen Sie NMCSegments aus der Liste Entity aus.
    3. Wählen Sie den Vorgang Get aus und klicken Sie auf Fertig.
    4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf EntityId und geben Sie dann 0d44bb3f-d28e-4bcf-aba2-c77be831ad46 in das Feld Standardwert ein.

      Dabei ist 0d44bb3f-d28e-4bcf-aba2-c77be831ad46 ein Primärschlüsselwert in der Entität NMCSegments.

    Beispiel: Eintrag erstellen

    In diesem Beispiel wird ein Datensatz in der Entität NMCSenders erstellt.

    1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
    2. Wählen Sie NMCSenders aus der Liste Entity aus.
    3. Wählen Sie den Vorgang Create aus und klicken Sie auf Fertig.
    4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:
      {
      "Nickname": "Test",
      "FromEmail": "test1@examplepetstore.com",
      "FromName": "testuser",   
      "ReplytoEmail": "test1@examplepetstore.com",  
      "Address": "NA", 
      "City": "NA", 
      "Country": "India"}

      Wenn die Integration erfolgreich ist, hat das Feld connectorOutputPayload der Connector-Aufgabe einen Wert, der dem folgenden ähnelt:

      {
      "Id": 5360940.0
      }

    Beispiel: Eintrag erstellen

    In diesem Beispiel wird ein Datensatz in der Entität NMCLists erstellt.

    1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
    2. Wählen Sie NMCLists aus der Liste Entity aus.
    3. Wählen Sie den Vorgang Create aus und klicken Sie auf Fertig.
    4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:
      {
      "Name": "TEST_CON_LIST1699262238224",
      "ContactCount": 3.0}

      Wenn die Integration erfolgreich ist, hat das Feld connectorOutputPayload der Connector-Aufgabe einen Wert, der dem folgenden ähnelt:

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

    Beispiel: Datensatz aktualisieren

    In diesem Beispiel wird ein Datensatz in der Entität NMCSenders aktualisiert.

    1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
    2. Wählen Sie NMCSenders aus der Liste Entity aus.
    3. Wählen Sie den Vorgang Update aus und klicken Sie auf Fertig.
    4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:
      {
      "Nickname": "Test",
      "FromEmail": "test2@examplepetstore.com",
      "FromName": "testuser",   
      "ReplytoEmail": "test2@examplepetstore.com",  
      "Address": "NA", 
      "City": "NA", 
      "Country": "India"}
    5. Klicken Sie auf entityId und geben Sie dann 5360940.0 in das Feld Standardwert ein.

      Wenn die Integration erfolgreich ist, hat das Feld connectorOutputPayload der Connector-Aufgabe einen Wert, der dem folgenden ähnelt:

      {
      "Id":"5360940.0"
      }

    Beispiel: Eintrag löschen

    In diesem Beispiel wird der Datensatz mit der angegebenen ID in der Entität NMCSegments gelöscht.

    1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
    2. Wählen Sie NMCSegments aus der Liste Entity aus.
    3. Wählen Sie den Vorgang Delete aus und klicken Sie auf Fertig.
    4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf entityId und geben Sie dann c58b9151-7279-428a-bac2-12b4bf2b48b0 in das Feld Standardwert ein.

    Verbindungen mit Terraform erstellen

    Sie können die Terraform-Ressource verwenden, um eine neue Verbindung zu erstellen.

    Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle.

    Ein Beispiel für eine Terraform-Vorlage zum Erstellen einer Verbindung finden Sie hier.

    Wenn Sie diese Verbindung mit Terraform erstellen, müssen Sie die folgenden Variablen in Ihrer Terraform-Konfigurationsdatei festlegen:

    Parametername Datentyp Erforderlich Beschreibung

    SendGrid-Verbindung in einer Integration verwenden

    Nachdem Sie die Verbindung erstellt haben, ist sie sowohl in Apigee Integration als auch in Application Integration verfügbar. Sie können die Verbindung in einer Integration über die Aufgabe „Connectors“ verwenden.

    • Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Apigee Integration finden Sie unter Connectors-Aufgabe.
    • Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Application Integration finden Sie unter Connectors-Aufgabe.

    Hilfe von der Google Cloud-Community erhalten

    Sie können Ihre Fragen und Anregungen zu diesem Connector in der Google Cloud-Community unter Cloud-Foren posten.

    Nächste Schritte