SendGrid

Mit dem SendGrid-Connector können Sie Einfüge-, Lösch-, Aktualisierungs- und Lesevorgänge für ein SendGrid-Dataset ausführen.

Hinweise

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

• In Ihrem Google Cloud-Projekt:
  • Gewähren Sie dem Nutzer, der den Connector konfiguriert, die IAM-Rolle roles/connectors.admin.
  • 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.

Connector konfigurieren

Für die Konfiguration des Connectors müssen Sie eine Verbindung zu Ihrer Datenquelle (Backend-System) erstellen. 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 63 Zeichen haben.
   4. Geben Sie optional unter Beschreibung eine Beschreibung für die Verbindungsinstanz ein.
   5. Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
   6. Konfigurieren Sie optional die Einstellungen für den Verbindungsknoten:
      • 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.

   Hinweis: Sie können die Verbindungsknotenwerte nur anpassen, wenn Sie ein „Pay as you go”-Kunde sind.
   7. Klicken Sie optional auf + LABEL HINZUFÜGEN, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
   8. 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

API-Schlüsselauthentifizierung

• API key (API-Schlüssel): Wählen Sie das Secret Manager-Secret des API-Schlüssels aus.
• Secret-Version: Wählen Sie die Secret-Version aus.

Hinweis : Der API-Schlüssel, den Sie in SendGrid erstellt haben, sollte den Bereich user.email.read haben.

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.

Hinweis: Sie können die Entitäten, Vorgänge und Aktionen eines Connectors in der Connectors-Aufgabe aufrufen.

• 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:
  • Auflisten
  • Abrufen
  • Erstellen
  • Aktualisieren
  • Löschen

  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 Entitätsvorgänge unterstützt, werden solche nicht unterstützten Vorgänge nicht in der Liste Operations 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 umfasst 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.

Hinweis : Allen Entitäten und Aktionen ist ein Schema zugeordnet. Ein Aktionsschema enthält beispielsweise Parameterdetails wie die Parameternamen und den entsprechenden Datentyp. Das Schema (Metadaten) für Entitäten und Aktionen wird von der Verbindung zur Laufzeit aus Ihrem Back-End abgerufen. Wenn das Schema aktualisiert wurde, werden diese Aktualisierungen nicht automatisch in Ihren bestehenden Verbindungen berücksichtigt. Sie müssen das Schema manuell aktualisieren. Öffnen Sie zum Aktualisieren des Schemas für eine Verbindung die Seite Verbindungsdetails der Verbindung und klicken Sie dann auf Verbindungsschema aktualisieren.

Systembeschränkungen

Der SendGrid-Connector kann 8 Transaktionen pro Sekunde und Knoten verarbeiten und drosselt alle Transaktionen über dieses Limit hinaus. Standardmäßig weist Integration Connectors einer Verbindung 2 Knoten (zur besseren Verfügbarkeit) zu.

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

Hinweis: Die Anzahl der Integration Connectors-Knoten wird je nach Ihrer Nutzung automatisch skaliert. Wenn Sie jedoch Kapazität für große Volumes reservieren möchten, ohne auf das Autoscaling zu warten, können Sie den Mindestknotenwert für eine Verbindung anpassen. Es sind mehr Knoten erforderlich, um mehr Transaktionen für eine Verbindung zu verarbeiten. Umgekehrt sind weniger Knoten erforderlich, wenn über eine Verbindung weniger Transaktionen verarbeitet werden. So konfigurieren Sie die Knotenwerte:

• Wenn Sie „Pay as you go“-Kunde sind, konfigurieren Sie den minimalen und maximalen Knotenwert auf der Seite „Verbindung bearbeiten“.
• Wenn Sie abobasiert sind, wenden Sie sich an den Support.

Die maximale Anzahl von Transaktionen, die ein Knoten verarbeiten kann, hängt von verschiedenen Faktoren ab. Bevor Sie die Mindestanzahl von Knoten für einen besseren Durchsatz anpassen, sollten Sie daher prüfen, ob Ihre Back-End-Systeme optimal für die Verarbeitung des erforderlichen Traffics eingerichtet sind.

Aktionen

In diesem Abschnitt sind einige der vom Connector unterstützten Aktionen aufgeführt. Informationen zum Konfigurieren der Aktionen finden Sie unter Aktionsbeispiele.

Hinweis:Die Ergebnisse aller Aktionen sind nach der Einbindung als JSON-Antwort im Antwortparameter connectorOutputPayload der Aufgabe Connectors verfügbar.

Aktion "SendMail"

Dadurch wird eine E-Mail mit einem Anhang gesendet.

Eingabeparameter der SendMail-Aktion

Parametername	Datentyp	Erforderlich	Beschreibung
Betreff	String	Yes	Der Betreff der zu sendenden E-Mail.
ContentValue	String	Nein	Der Inhalt der zu sendenden E-Mail.
ContentType	String	Nein	Der Inhaltstyp, der gesendet werden soll. Unterstützte Werte sind "Text/Nur-Text" und "Text/HTML".
Inhalt	String	Yes	Der Aggregattyp für das Content-Objekt.
SendAt	String	Nein	Datum und Uhrzeit für die Zustellung Ihrer E-Mail. Eine Planung, die mehr als 72 Stunden im Voraus erfolgt, ist verboten.
FromEmail	String	Yes	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 Namen der E-Mail-Adressen, an die die E-Mail gesendet werden soll.
Bis	String	Nein	Die Zusammenfassung für „An“-Empfänger.
ToCCEmail	String	Nein	E-Mail-Adressen der Empfänger, die eine Kopie Ihrer E-Mail erhalten sollen.
ToCCName	String	Nein	Namen der Empfänger, die eine Kopie Ihrer E-Mail erhalten werden.
ToBCCName	String	Nein	Namen der Empfänger, die eine Blindkopie Ihrer E-Mail erhalten.
ToBCC	String	Nein	Zusammenfassung für Empfänger von ToBCC.
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	Nein	Die ID der Vorlage, die Sie senden möchten.
DynamicTemplateData	String	Nein	Die Daten der dynamischen Vorlage.
Personalisierungen	String	Yes	Ein Array von Nachrichten und ihren Metadaten. Jedes Objekt innerhalb der Personalisierungen kann als Hülle betrachtet werden. Es definiert, wer eine einzelne Nachricht erhalten soll und wie diese Nachricht behandelt werden soll.

Ausgabeparameter der SendMail-Aktion

Diese Aktion gibt eine Bestätigungsnachricht zurück, unabhängig davon, ob die E-Mail von SendMail erfolgreich gesendet wurde.

Aktionsbeispiele

In diesem Abschnitt wird beschrieben, wie Sie einige 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 SendMail aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert wie den folgenden ein:

   {
   "Personalizations": "[{"subject": "Test Subject2",
   "send_at": 1698659820,
   "from": {"name": "hi","email": "[e-mail]"},
   "to": [{"email": "[e-mail]","name": "test"}]
   }]",   
   "FromName": "SampleName",   
   "FromEmail": "[e-mail]",   
   "Subject": "SubjectAdded",   
   "Content": "[{"value": "[e-mail]","type": "text/plain"}]', Attachments='[{"filename": "Test2.txt","content": "VGVzdCBBdHRhY2htZW50"}]" 
   }

Diese Aktion gibt eine Bestätigungsnachricht von SendMail zurück. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Aufgabe einen Wert ähnlich dem folgenden:

[{
"Status": "True"
}]

Beispiele für Entitätsvorgänge

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

Beispiel – Alle Kontakte auflisten

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

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wähle NMCContacts aus der Entity-Liste 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 die Ergebnisse filtern, indem Sie eine Filterklausel angeben. Beispiel: City='Bangalore' Sie können auch mehrere Filterbedingungen angeben, indem Sie die logischen Operatoren verwenden. Zum Beispiel: City='Bangalore' and region='asia-south2'.

Beispiel – Datensatz abrufen

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

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

   Hier ist 0d44bb3f-d28e-4bcf-aba2-c77be831ad46 ein Primärschlüssel/Wert in der Entität NMCSegments.

Beispiel – Datensatz 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ähle NMCSenders aus der Entity-Liste aus.
3. Wählen Sie den Vorgang Create aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert wie den folgenden ein:

   {
   "Nickname": "Test",
   "FromEmail": "[e-mail]",
   "FromName": "testuser",   
   "ReplytoEmail": "[e-mail]",  
   "Address": "NA", 
   "City": "NA", 
   "Country": "India"}

   Ist die Integration erfolgreich, hat das Feld connectorOutputPayload der Connector-Aufgabe einen Wert ähnlich dem folgenden:

   {
   "Id": 5360940.0
   }

Beispiel – Datensatz 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ähle NMCLists aus der Entity-Liste aus.
3. Wählen Sie den Vorgang Create aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert wie den folgenden ein:

   {
   "Name": "TEST_CON_LIST1699262238224",
   "ContactCount": 3.0}

   Ist die Integration erfolgreich, hat das Feld connectorOutputPayload der Connector-Aufgabe einen Wert ähnlich dem folgenden:

   {
   "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ähle NMCSenders aus der Entity-Liste aus.
3. Wählen Sie den Vorgang Update aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert wie den folgenden ein:

   {
   "Nickname": "Test",
   "FromEmail": "[e-mail]",
   "FromName": "testuser",   
   "ReplytoEmail": "[e-mail]",  
   "Address": "NA", 
   "City": "NA", 
   "Country": "India"}

5. Klicken Sie auf entityId und geben Sie im Feld Default Value (Standardwert) 5360940.0 ein.

   Ist die Integration erfolgreich, hat das Feld connectorOutputPayload der Connector-Aufgabe einen Wert ähnlich dem folgenden:

   {
   "Id":"5360940.0"
   }

Beispiel – Datensatz 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ähle NMCSegments aus der Entity-Liste aus.
3. Wählen Sie den Vorgang Delete aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Task Input der Aufgabe Connectors auf entityId und geben Sie im Feld Default Value (Standardwert) c58b9151-7279-428a-bac2-12b4bf2b48b0 ein.

Hinweis : Wenn Ihre Entität einen zusammengesetzten Primärschlüssel hat, können Sie eine Filterklausel angeben.

Verbindungen mit Terraform erstellen

Sie können mit der Terraform-Ressource eine neue Verbindung erstellen.

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

Eine Beispiel-Terraform-Vorlage zum Erstellen von Verbindungen finden Sie unter Beispielvorlage.

Wenn Sie diese Verbindung mithilfe von Terraform erstellen, müssen Sie die folgenden Variablen in der Terraform-Konfigurationsdatei festlegen:

Parametername	Datentyp	Erforderlich	Beschreibung

SendGrid-Verbindung in einer Integration verwenden

Nachdem Sie die Verbindung erstellt haben, ist sie in Apigee Integration und Application Integration verfügbar. Sie können die Verbindung in einer Integration über die Connectors-Aufgabe verwenden.

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

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

• Informationen zum Anhalten und Fortsetzen einer Verbindung
• Informationen zum Überwachen der Connector-Nutzung
• Weitere Informationen zum Aufrufen von Connector-Logs