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:
- Weisen Sie dem Nutzer die IAM-Rolle roles/connectors.admin zu. Connector konfigurieren.
- 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:
- 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.
- Klicken Sie auf + NEU ERSTELLEN, um die Seite Verbindung erstellen zu öffnen.
- Wählen Sie im Abschnitt Standort den Standort für die Verbindung aus.
- 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.
- Klicken Sie auf Weiter.
- Region: Wählen Sie einen Standort aus der Drop-down-Liste aus.
- Führen Sie im Abschnitt Connection Details (Verbindungsdetails) die folgenden Schritte aus:
<ph type="x-smartling-placeholder">
- </ph>
- Connector: Wählen Sie HubSpot aus der Drop-down-Liste der verfügbaren Connectors aus.
- Connector-Version: Wählen Sie die Connector-Version aus der Drop-down-Liste der verfügbaren Versionen aus.
- 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.
- Geben Sie optional unter Beschreibung eine Beschreibung für die Verbindungsinstanz ein.
- Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
- Wenn Sie die Verbindung für Ereignisabos verwenden möchten, wählen Sie Ereignisabo aktivieren aus. Wird ausgewählt
werden folgende Optionen angezeigt:
<ph type="x-smartling-placeholder">
- </ph>
- Ereignisabo mit Entität und Aktionen aktivieren: Wählen Sie diese Option aus, um Die Verbindung wird sowohl für Ereignisabo- als auch für Connector-Vorgänge (Entitäten und Aktionen) verwendet.
- Nur Ereignisabo aktivieren: Wählen Sie diese Option aus, um die Verbindung zu verwenden. nur für Ereignisabos. Wenn Sie diese Option auswählen, klicken Sie auf Weiter und dann auf Ereignisabo konfigurieren.
- Schema: Geben Sie die zu verwendende HubSpot API-Version an. HubSpotV4 ist die neue API.
- BrowsableSchemas: Dieses Attribut schränkt die Schemas ein, die auf eine Teilmenge der verfügbaren Schemas gemeldet werden. Beispiel: BrowsableSchemas=SchemaA,SchemaB,SchemaC.
-
Kontakteigenschaften: Geben Sie die durch Kommas getrennten Feldnamen der
Contacts
ein. Entität, die Sie aus demList
-Entitätsvorgang auswählen möchten. Beispiel:fieldA, fieldB, fieldC
-
Companies Properties (Eigenschaften des Unternehmens): Geben Sie die durch Kommas getrennten Feldnamen der
Companies
ein. Entität, die Sie aus demList
-Entitätsvorgang auswählen möchten. Beispiel:fieldA, fieldB, fieldC
-
Deals-Eigenschaften: Geben Sie die durch Kommas getrennten Feldnamen der
Deals
ein. Entität, die Sie aus demList
-Entitätsvorgang auswählen möchten. Beispiel:fieldA, fieldB, fieldC
- Proxy verwenden: Klicken Sie dieses Kästchen an, um einen Proxyserver für die Verbindung zu konfigurieren.
- Proxy-Authentifizierungsschema: Der Authentifizierungstyp, der für die Authentifizierung beim ProxyServer-Proxy verwendet wird.
- Proxy User: Ein Nutzername, der für die Authentifizierung beim ProxyServer-Proxy verwendet wird.
- Proxy-Passwort: Ein Passwort, das zur Authentifizierung beim ProxyServer-Proxy verwendet wird.
- Proxy-SSL-Typ: Der SSL-Typ, der beim Herstellen einer Verbindung zum ProxyServer-Proxy verwendet werden soll.
- 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.
- Klicken Sie optional auf + Label hinzufügen, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
- Klicken Sie auf Weiter.
- Geben Sie im Abschnitt Ziele die Details zum Remote-Host (Backend-System) ein, zu dem Sie eine Verbindung herstellen möchten.
- 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.
- Klicken Sie auf Weiter.
- Zieltyp: Sie können die Zieldetails entweder als Hostadresse oder als Dienstanhang angeben. Wählen Sie einen der folgenden Zieltypen aus:
-
Geben Sie im Abschnitt Authentifizierung die Authentifizierungsdetails ein.
- 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, generiert ein eindeutiges Zugriffstoken für Ihre private App. In der privaten App prüfen, ob Sie die Leseberechtigung mindestens für die folgenden Bereiche 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.
- 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.
- Klicken Sie auf Weiter.
- Wählen Sie einen Authentifizierungstyp aus und geben Sie die relevanten Details ein.
-
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 zur Validierung der HubSpot-Token-Nutzlast verwendet werden:
<ph type="x-smartling-placeholder">
- </ph>
- 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.
- Wählen Sie für eine sichere Verbindung zwischen Ihrer Back-End-Anwendung die Option Private Verbindung aktivieren aus. und Ihre Verbindung. Wenn Sie diese Option auswählen, müssen Sie zusätzliche Konfigurationsschritte ausführen nachdem Sie die Verbindung erstellt haben. Weitere Informationen finden Sie unter Private Verbindungen für Ereignisabos.
- Geben Sie die Konfiguration für unzustellbare Nachrichten ein. Wenn Sie unzustellbare Nachrichten konfigurieren, schreibt die Verbindung
die nicht verarbeiteten Ereignisse an das angegebene Pub/Sub-Thema. Geben Sie die folgenden Informationen ein:
<ph type="x-smartling-placeholder">
- </ph>
- 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.
- Thema für unzustellbare Nachrichten: Das Pub/Sub-Thema, in das Sie die Details des nicht verarbeiteten Ereignisses schreiben möchten.
- Klicken Sie auf Weiter.
Weitere Informationen finden Sie unter Private Apps.
- Überprüfen: Prüfen Sie Ihre Verbindungs- und Authentifizierungsdetails.
- 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.
- 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. Unterstützt ein Connector jedoch keine Entitätsvorgänge, Vorgänge sind 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 eine Ausgabe
. Es ist jedoch möglich, dass ein Connector keine Aktionen unterstützt. In diesem Fall ist die
Actions
-Liste leer.
Bekannte Probleme
- Der Aktualisierungsvorgang für einige der Entitäten gibt eine leere Antwort zurück, obwohl die Die Aktualisierung war erfolgreich. In solchen Fällen empfiehlt es sich, die Aktualisierung im Ihre HubSpot-Instanz.
- In HubSpot können Sie möglicherweise viele benutzerdefinierte Felder für die folgenden Entitäten haben:
<ph type="x-smartling-placeholder">
- </ph>
- Kontakte
- Unternehmen
- Angebote
Für diese Entitäten wählen Sie im Entitätsvorgang
List
alle Felder gleichzeitig aus: kann der HubSpot-Connector einen Fehler zurückgeben. In den Szenarien, in denen Sie Begrenzen Sie die Anzahl der benutzerdefinierten Felder aus demList
-Vorgang, Geben Sie die Pflichtfeldnamen (als kommagetrennte Werte) im HubSpot-Connector an. Konfiguration. Um beispielsweise die Felder der EntitätContacts
zu begrenzen, die erforderlichen Feldnamen in der Connector-KonfigurationContacts Properties
. Geben Sie ähnlich für die EntitätCompanies
Folgendes an: die Pflichtfeldnamen im FeldCompanies Properties
und geben Sie für die EntitätDeals
an die erforderlichen Feldnamen im FeldDeals Properties
.Sie können die Felder beim Schritt der Verbindungserstellung angeben. Wenn Sie jedoch bereits bestehende Verbindung haben, müssen Sie die Verbindung bearbeiten und dann die erforderlichen Felder angeben.
- Bei einer sehr großen Ergebnismenge ist der
List
kann aufgrund einer Zeitüberschreitung bei der Verbindung fehlschlagen. In einem solchen Fall können Sie Ihre Ergebnismenge durch Angabe von Filterklausel für den Listenvorgang
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.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wähle
Contacts
aus derEntity
-Liste aus. - Wählen Sie den Vorgang
LIST
aus und klicken Sie auf Fertig.
Beispiel – Datensatz für einen Deal abrufen
In diesem Beispiel wird von der Entität Deals
ein Datensatz mit der ID 45
abgerufen.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wähle
Deals
aus derEntity
-Liste aus. - Wählen Sie den Vorgang
GET
aus und klicken Sie auf Fertig. - 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ätDeals
.
Beispiel – Ticket erstellen
In diesem Beispiel wird ein Ticket in der Entität Ticket
erstellt.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wähle
Tickets
aus derEntity
-Liste aus. - Wählen Sie den Vorgang
Create
aus und klicken Sie auf Fertig. - Klicken Sie im Abschnitt Task Input der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das Feld FeldDefault Value
:{ "Name": "Test735362767", "Label": "Test735362767", "Type": "String", "FieldType": "Insert ticket1", "GroupName": "ticketinformation", "Description": "Test ticket" }
Ist die Integration erfolgreich, enthält das Feld
connectorOutputPayload
der Connector-Aufgabe , der in etwa so aussieht:{ "Name": "Test1695971640609" }
Beispiel – Angebotseintrag aktualisieren
In diesem Beispiel wird der Datensatz mit der ID 97 in der Entität Contacts
aktualisiert.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wähle
Deals
aus derEntity
-Liste aus. - Wählen Sie den Vorgang
Update
aus und klicken Sie auf Fertig. - Klicken Sie im Abschnitt Task Input der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das Feld FeldDefault Value
:{ "Description": "New description" }
- Klicken Sie auf entityId und geben Sie im Feld Default Value (Standardwert)
97
ein.Statt die entityId anzugeben, können Sie auch die filterClause auf
97
.
Beispiel – Formular löschen
In diesem Beispiel wird der Datensatz mit der ID 78 in der Entität Forms
gelöscht.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wähle
Forms
aus derEntity
-Liste aus. - Wählen Sie den Vorgang
Delete
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Task Input der Aufgabe Connectors auf entityId und
Geben Sie dann
78
in das Feld Default Value (Standardwert) ein.
Verbindungen mit Terraform erstellen
Mit dem Terraform-Code Ressource, um eine neue Verbindung zu erstellen.Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle.
Eine Beispiel-Terraform-Vorlage für die Verbindungserstellung finden Sie unter Beispielvorlage.
Wenn Sie diese Verbindung mithilfe von Terraform erstellen, müssen Sie in der Terraform-Konfigurationsdatei die folgenden Variablen 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 aus 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 beiden Apigee-Integration und Anwendungsintegration Sie können die Verbindung über die Connectors-Aufgabe in einer Integration.
- 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 Tasks für 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