Zoho
Mit dem Zoho Books-Connector können Sie SQL-Vorgänge im Zoho Books-System ausführen.
Unterstützte Versionen
Der Connector nutzt die Zoho Books API V3, um den bidirektionalen Zugriff auf Zoho Books-Daten zu ermöglichen.
Hinweise
Führen Sie die folgenden Schritte aus, bevor Sie den Zoho Books-Connector verwenden:
- In Ihrem Google Cloud-Projekt:
- 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.
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 Next (Weiter).
- Region: Wählen Sie einen Standort aus der Drop-down-Liste aus.
- Führen Sie im Abschnitt Verbindungsdetails folgende Schritte aus:
- Connector: Wählen Sie Zoho Books 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.
- Konfigurieren Sie optional die Einstellungen für 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, wird die Mindestanzahl von Knoten standardmäßig auf 2 (für eine bessere Verfügbarkeit) und die maximale Anzahl von Knoten auf 50 festgelegt.
- Kontoserver: Die vollständige URL für den Kontoserver.
- Organisations-ID: ID, die der jeweiligen Zoho Books-Organisation zugeordnet ist
- Ausführlichkeitsstufe: Der Grad der Ausführlichkeit für die Verbindung (1–5) Bei einem höheren Ausführlichkeitsgrad werden alle Kommunikationsdetails (Anfrage,Antwort und SSL-Zertifikate) protokolliert.
- Sie können auch auf + Label hinzufügen klicken, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
- Klicken Sie auf Next (Weiter).
-
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 Zoho Books-Verbindung unterstützt:
- Gewähren von OAuth 2.0-Auth-Code
- Klicken Sie auf Next (Weiter).
Informationen zum Konfigurieren dieser Authentifizierungstypen finden Sie unter Authentifizierung konfigurieren.
- Wählen Sie einen Authentifizierungstyp aus und geben Sie die relevanten Details ein.
- Überprüfen: Prüfen Sie Ihre Verbindungs- und Authentifizierungsdetails.
- Klicken Sie auf Erstellen.
Authentifizierung konfigurieren
Geben Sie die Details basierend auf der zu verwendenden Authentifizierung ein.
-
Gewähren von OAuth 2.0-Auth-Code
- Client-ID: Die Client-ID, die vom Connector für die von Ihnen erstellte Anwendung bereitgestellt wird.
- Client-Secret: Secret Manager-Secret mit dem Clientschlüssel für die verbundene Anwendung, die Sie erstellt haben.
- Access Token (Zugriffstoken): Secret Manager-Secret mit dem OAuth-Zugriffstoken, das für die von Ihnen erstellte verbundene Anwendung bereitgestellt wurde.
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 keinen der 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. Es ist jedoch möglich, dass ein Connector keine Aktionen unterstützt. In diesem Fall ist die
Actions
-Liste leer.
Aktionen
In diesem Abschnitt sind einige der Aktionen aufgeführt, die von der Zoho Books-Verbindung unterstützt werden. Informationen zum Konfigurieren von Aktionen finden Sie unter Aktionsbeispiele.
Aktion „ImportCreditCardStatement“
Mit dieser Aktion können Sie Kreditkartenabrechnungen importieren.
Eingabeparameter der Aktion „ImportCreditCardStatement“
Parametername | Datentyp | Erforderlich | Beschreibung |
---|---|---|---|
AccountId | String | Nein | ID des Bank-/Kreditkartenkontos |
TransactionsTransactionDebitOrCredit | String | Nein | Gibt an, ob es sich bei der Transaktion um eine Debit- oder Kreditkarte handelt. |
TransactionsTransactionAmount | String | Nein | Der an der Transaktion beteiligte Betrag. |
TransactionsTransactionDescription | String | Nein | Transaktionsbeschreibung |
TransactionsTransactionDate | String | Nein | Datum der Transaktion. |
Informationen zum Konfigurieren der Aktion ImportCreditCardStatement
finden Sie unter Beispiele.
Aktionsbeispiele
In diesem Abschnitt wird beschrieben, wie Sie einige Aktionen in diesem Connector ausführen können.
Beispiel – Kreditkartenabrechnung importieren
In diesem Beispiel wird eine Kreditkartenabrechnung importiert.
- Klicken Sie im Dialogfeld
Configure connector task
aufActions
. - Wählen Sie die Aktion
ImportCreditCardStatement
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Task Input der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert wie den folgenden in das FeldDefault Value
ein:{ "AccountId": "1470449000000023015", "TransactionsTransactionDebitOrCredit": "credit", "TransactionsTransactionAmount": "200", "TransactionsTransactionDescription": "Transaction done from Google account", "TransactionsTransactionDate": "2023-05-05" }
Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload
der Aufgabe ImportCreditCardStatement
einen Wert wie dieser:
[{ "Status": "Your bank statement has been imported." }]
Beispiele für Entitätsvorgang
In diesem Abschnitt wird beschrieben, wie Sie einige Entitätsvorgänge in diesem Connector ausführen.
Beispiel – Alle Schätzungen auflisten
In diesem Beispiel werden alle Datensätze in der Entität Estimates
aufgelistet.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie
Estimates
aus der ListeEntity
aus. - Wählen Sie den Vorgang
List
aus und klicken Sie auf Fertig. - Optional können Sie im Bereich Aufgabeneingabe der Aufgabe Connectors die Ergebnisse filtern, indem Sie eine Filterklausel angeben. Mit logischen Operatoren können Sie auch mehrere Filterbedingungen angeben.
Beispiel – Kundenauftrag abrufen
In diesem Beispiel wird der angegebene Verkaufsauftrag von der Entität SalesOrder
abgerufen.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie
SalesOrder
aus der ListeEntity
aus. - Wählen Sie den Vorgang
Get
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf Entitäts-ID und geben Sie
1470449000000043003
in das Feld Standardwert ein.Hier ist
1470449000000043003
ein Primärschlüsselwert in derSalesOrder
-Entität.
Beispiel – Banktransaktion erstellen
In diesem Beispiel wird ein Datensatz für Banktransaktionen in der Entität BankTransactions
erstellt.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie
BankTransactions
aus der ListeEntity
aus. - Wählen Sie den Vorgang
Create
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Task Input der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert wie den folgenden in das FeldDefault Value
ein:{ "TransactionType": "transfer_fund", "FromAccountId": "1470449000000000459", "ToAccountId": "1470449000000110001", "Amount": 45.0, "CurrencyId": "1470449000000000064" }
Wenn die Integration erfolgreich ist, enthält das Feld
connectorOutputPayload
der Connector-Aufgabe einen Wert wie diesen:{ "TransactionId": "1470449000000231005" }
Beispiel – Kontaktdaten des Kunden aktualisieren
In diesem Beispiel wird der angegebene Kundendatensatz in der Entität CustomerContacts
aktualisiert.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie
CustomerContacts
aus der ListeEntity
aus. - Wählen Sie den Vorgang
Update
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Task Input der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert wie den folgenden in das FeldDefault Value
ein:{ "Department": "Development", "ContactId": "1470449000000038003" }
- Klicken Sie im Bereich Task Input (Aufgabeneingabe) der Aufgabe Connectors auf entityId und geben Sie
1470449000000038005
in das Feld Default Value (Standardwert) ein.
Wenn die Integration erfolgreich ist, enthält das Feld connectorOutputPayload
der Connector-Aufgabe einen Wert wie diesen:
{ "CustomerContactId": "1470449000000038005" }
Beispiel – Rechnungseintrag löschen
In diesem Beispiel wird der angegebene Rechnungsdatensatz in der Entität InvoiceDetails
gelöscht.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie
InvoiceDetails
aus der ListeEntity
aus. - Wählen Sie den Vorgang
Delete
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf entityId und geben Sie
1470449000000184001
in das Feld Standardwert ein.
Zoho Books-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 über die Connector-Aufgabe in einer Integration verwenden.
- Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in der Apigee-Integration finden Sie unter Connectors-Task.
- Informationen zum Erstellen und Verwenden der Aufgabe „Connectors“ 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
- Informationen zum Sperren und Fortsetzen einer Verbindung
- Informationen zum Überwachen der Connector-Nutzung
- Connector-Protokolle ansehen