HubSpot

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

Unterstützte Versionen

Dieser Connector unterstützt die folgenden HubSpot API-Versionen:

• HubSpot
• HubSpotV3
• HubSpotV4

Hinweise

Führen Sie vor der Verwendung des HubSpot-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.

      Unterstützte Regionen für Connectors:

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

   2. Klicken Sie auf Weiter.
4. Führen Sie im Abschnitt Connection Details (Verbindungsdetails) die folgenden Schritte aus:
   1. Connector: Wählen Sie HubSpot 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. Wenn Sie die Verbindung für Ereignisabos verwenden möchten, wählen Sie Ereignisabo aktivieren aus. Wenn Sie diese Option auswählen, werden die folgenden Optionen angezeigt:
      • Ereignisabo mit Entität und Aktionen aktivieren: Wählen Sie diese Option aus, um die Verbindung sowohl für Ereignisabos als auch für Connector-Vorgänge (Entitäten und Aktionen) zu verwenden.
      • Nur Ereignisabo aktivieren: Wählen Sie diese Option aus, um die Verbindung nur für Ereignisabos zu verwenden.

      Bei beiden Optionen werden Sie in den nachfolgenden Schritten aufgefordert, die Ereignisdetails zu konfigurieren.

   7. Schema: Geben Sie die zu verwendende HubSpot API-Version an. HubSpotV4 ist die neue API.
   8. BrowsableSchemas Dieses Attribut schränkt die Schemas ein, die auf eine Teilmenge der verfügbaren Schemas gemeldet werden. Beispiel: BrowsableSchemas=SchemaA,SchemaB,SchemaC.
   9. Kontakteeigenschaften: Geben Sie die durch Kommas getrennten Feldnamen der Entität Contacts ein, die Sie aus dem Entitätsvorgang List auswählen möchten. Beispiel: fieldA, fieldB, fieldC
   10. Unternehmenseigenschaften: Geben Sie die durch Kommas getrennten Feldnamen der Entität Companies ein, die Sie aus dem Entitätsvorgang List auswählen möchten. Beispiel: fieldA, fieldB, fieldC
   11. Deals-Eigenschaften: Geben Sie die durch Kommas getrennten Feldnamen der Entität Deals ein, die Sie aus dem Entitätsvorgang List auswählen möchten. Beispiel: fieldA, fieldB, fieldC
   12. Proxy verwenden: Klicken Sie dieses Kästchen an, um einen Proxyserver für die Verbindung zu konfigurieren.
   13. Proxy-Authentifizierungsschema: Der Authentifizierungstyp, der für die Authentifizierung beim ProxyServer-Proxy verwendet wird.
   14. Proxy User: Ein Nutzername, der für die Authentifizierung beim ProxyServer-Proxy verwendet wird.
   15. Proxy-Passwort: Ein Passwort, das zur Authentifizierung beim ProxyServer-Proxy verwendet wird.
   16. Proxy-SSL-Typ: Der SSL-Typ, der beim Herstellen einer Verbindung zum ProxyServer-Proxy verwendet werden soll.
   17. 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.
   18. Klicken Sie optional auf + Label hinzufügen, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
   19. Klicken Sie auf Weiter.
5. Geben Sie im Abschnitt Ziele die Details zum Remote-Host (Backend-System) ein, zu dem Sie eine Verbindung herstellen möchten.
   1. Zieltyp: Sie können die Zieldetails entweder als Hostadresse oder als Dienstanhang angeben. Wählen Sie einen der folgenden Zieltypen aus:
      • Hostadresse: Wenn Sie den Hostnamen oder die IP-Adresse des Ziels angeben möchten.
      • Dienstanhang: Wenn Sie den privaten Endpunkt für Ihre internen IP-Adressen angeben möchten. Mit dem Dienstanhang können Sie Ihre internen IP-Adressen vor dem externen Netzwerk verbergen. Mit dem Private Service Connect-Feature haben Sie die Möglichkeit, in Google Cloud einen Dienstanhang zu erstellen. Informationen zum Konfigurieren von Private Service Connect finden Sie unter Verwaltete Dienste veröffentlichen.

      Geben Sie je nach ausgewähltem Zieltyp die Hostadresse oder den Namen des Dienstanhangs ein.

      Wenn Sie weitere Reiseziele eingeben möchten, klicken Sie auf + Ziel hinzufügen.

   2. Klicken Sie auf Weiter.
6. Geben Sie im Abschnitt Authentifizierung die Authentifizierungsdetails ein.
   1. Wählen Sie einen Authentifizierungstyp aus und geben Sie die relevanten Details ein.

      Die folgenden Authentifizierungstypen werden von der HubSpot-Verbindung unterstützt:

      • Private App Access Token (Zugriffstoken für private App): Wählen Sie das Secret Manager-Secret aus, das das Zugriffstoken für die private App enthält.

        Mit privaten Apps können Sie die HubSpot-APIs verwenden, um auf bestimmte Daten aus Ihrem HubSpot-Konto zuzugreifen. Sie können festlegen, was jede private App in Ihrem Konto anfordern oder ändern darf. Dadurch wird ein Zugriffstoken generiert, das nur für Ihre private App gilt. Achten Sie in Ihrer privaten App darauf, dass Sie mindestens für die folgenden Bereiche die Leseberechtigung erteilt haben:

        • crm.schemas.line_items.read
        • crm.schemas.quotes.read
        • crm.schemas.deals.read
        • crm.schemas.companies.read
        • crm.schemas.custom.read
        • crm.schemas.contacts.read

        Weitere Informationen finden Sie unter Private Apps.

   2. Klicken Sie auf Weiter.
7. Wenn Sie das Ereignisabo aktiviert haben, wird der Abschnitt Event Subscription Details (Details zum Ereignisabo) auf der Seite zur Verbindungserstellung angezeigt. Geben Sie im Schritt Ereignisabodetails die Authentifizierungsdetails an, die zum Validieren der HubSpot-Token-Nutzlast verwendet werden:
   1. Clientschlüssel (optional): Wählen Sie das Secret Manager-Secret des Clientschlüssels Ihrer privaten App und die entsprechende Secret-Version aus dem Drop-down-Menü Secret-Version aus.

   Weitere Informationen finden Sie unter Private Apps.

   2. Wählen Sie für eine sichere Verbindung zwischen Ihrer Back-End-Anwendung und Ihrer Verbindung Private Verbindung aktivieren aus. Wenn Sie diese Option auswählen, müssen Sie nach dem Erstellen der Verbindung zusätzliche Konfigurationsschritte ausführen. Weitere Informationen finden Sie unter Private Verbindungen für Ereignisabos.
   3. Geben Sie die Konfiguration für unzustellbare Nachrichten ein. Wenn Sie unzustellbare Nachrichten konfigurieren, schreibt die Verbindung die nicht verarbeiteten Ereignisse in das angegebene Pub/Sub-Thema. Geben Sie die folgenden Informationen ein:
      1. Projekt-ID für unzustellbare Nachrichten : Die ID des Google Cloud-Projekts, in dem Sie das Pub/Sub-Thema für unzustellbare Nachrichten konfiguriert haben.
      2. Thema für unzustellbare Nachrichten: Das Pub/Sub-Thema, in das Sie die Details des nicht verarbeiteten Ereignisses schreiben möchten.
   4. Klicken Sie auf Weiter.
8. Überprüfen: Prüfen Sie Ihre Verbindungs- und Authentifizierungsdetails.
9. Klicken Sie auf Erstellen.

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.

Bekannte Probleme

• Der Aktualisierungsvorgang für einige der Entitäten gibt eine leere Antwort zurück, obwohl die Aktualisierung erfolgreich war. In solchen Fällen wird empfohlen, die Aktualisierung in Ihrer HubSpot-Instanz zu prüfen.
• In HubSpot können Sie möglicherweise viele benutzerdefinierte Felder für die folgenden Entitäten haben:
  • Kontakte
  • Unternehmen
  • Angebote

  Wenn bei diesen Entitäten im Entitätsvorgang List alle Felder gleichzeitig ausgewählt werden, gibt der HubSpot-Connector möglicherweise einen Fehler zurück. Wenn Sie die Anzahl der benutzerdefinierten Felder aus dem List-Vorgang begrenzen möchten, geben Sie die erforderlichen Feldnamen (als kommagetrennte Werte) in der Konfiguration des HubSpot-Connectors an. Wenn Sie beispielsweise die Felder der Entität Contacts begrenzen möchten, geben Sie die erforderlichen Feldnamen im Feld Contacts Properties der Connector-Konfiguration an. Analog dazu geben Sie für die Entität Companies die erforderlichen Feldnamen im Feld Companies Properties und für die Entität Deals die Pflichtfeldnamen im Feld Deals Properties an.

  Sie können die Felder beim Schritt der Verbindungserstellung angeben. Wenn Sie jedoch bereits eine Verbindung haben, müssen Sie die Verbindung bearbeiten und dann die Pflichtfelder angeben.

• Bei einer sehr großen Ergebnismenge kann der List-Vorgang aufgrund einer Verbindungszeitüberschreitung fehlschlagen. In einem solchen Szenario können Sie die Option zum Eingrenzen der Ergebnisse testen, indem Sie die Filterklausel für den List-Vorgang festlegen.

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 Datensätze in der Entität Contacts aufgelistet.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wähle Contacts aus der Entity-Liste aus.
3. Wählen Sie den Vorgang LIST aus und klicken Sie dann auf Fertig.

Beispiel – Dealdatensatz abrufen

In diesem Beispiel wird von der Entität Deals ein Datensatz mit der ID 45 abgerufen.

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

   Hier ist 45 ein Primärschlüssel/Wert in der Entität Deals.

Beispiel – Ticket erstellen

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

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wähle Tickets 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": "Test735362767",
   "Label": "Test735362767",
   "Type": "String",
   "FieldType": "Insert ticket1",
   "GroupName": "ticketinformation",
   "Description": "Test ticket"
   }

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

   {
   "Name": "Test1695971640609"
   }

Beispiel – Angebotseintrag aktualisieren

In diesem Beispiel wird der Datensatz mit der ID 97 in der Entität Contacts aktualisiert.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wähle Deals 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:

   {
   "Description": "New description"
   }

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

   Statt die entityId anzugeben, können Sie die filterClause auch auf 97 setzen.

Beispiel – Formular löschen

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

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wähle Forms 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) 78 ein.

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
schema	ENUM	Wahr	Geben Sie die zu verwendende HubSpot API-Version an. HubSpotV4 ist die neue API. Unterstützte Werte: HubSpot, HubSpotV3, HubSpotV4
browsable_schemas	STRING	Falsch	Bei dieser Property sind die gemeldeten Schemas auf einen Teil der verfügbaren Schemas beschränkt. Beispiel: BrowsableSchemas=SchemaA,SchemaB,SchemaC.
contacts_columns	STRING	Falsch	Durch Kommas getrennte Liste von Properties, die in HubSpot für die Entität „Kontakte“ ausgewählt werden können.
companies_columns	STRING	Falsch	Durch Kommas getrennte Liste von Properties, die in HubSpot für die Entität „Companies“ ausgewählt werden können.
deals_columns	STRING	Falsch	Durch Kommas getrennte Liste von Properties, die in HubSpot für die Entität „Deals“ ausgewählt werden können.
proxy_enabled	BOOLEAN	Falsch	Wählen Sie dieses Kontrollkästchen aus, um einen Proxyserver für die Verbindung zu konfigurieren.
proxy_auth_scheme	ENUM	Falsch	Der für die Authentifizierung beim ProxyServer-Proxy zu verwendende Authentifizierungstyp. Unterstützte Werte: BASIC, DIGEST, NONE
proxy_user	STRING	Falsch	Ein Nutzername, der für die Authentifizierung beim ProxyServer-Proxy verwendet werden soll.
proxy_password	SECRET	Falsch	Ein Passwort, das zur Authentifizierung beim ProxyServer-Proxy verwendet wird.
proxy_ssltype	ENUM	Falsch	Der SSL-Typ, der beim Herstellen einer Verbindung zum ProxyServer-Proxy verwendet werden soll. Unterstützte Werte sind: AUTO, ALWAYS, NEVER, TUNNEL

HubSpot-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