Xero

Mit diesem Connector haben Sie SQL-Zugriff auf Ihr Xero-Backend.

Hinweise

Führen Sie vor der Verwendung des Xero-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. Der Connector und das Dienstkonto müssen zum selben Projekt gehören. 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.

Xero-Konfiguration

Die folgenden Aufgaben sind erforderlich, um Xero zu konfigurieren:

Xero-Konto und Xero-Demounternehmen einrichten

  1. Rufen Sie Xero-Konto auf, um sich für ein kostenloses Xero-Konto zu registrieren.
  2. Rufen Sie Xero Demo Company auf, um das Xero-Demounternehmen zu aktivieren.

OAuth 2.0-Client-Authentifizierungsdetails generieren

  1. Melden Sie sich im Xero-Entwicklerkonto an.
  2. Klicken Sie auf Registrieren und folgen Sie der Anleitung. Wenn Sie bereits ein Konto haben, melden Sie sich mit Ihren Anmeldedaten an.

    3. Nach der Anmeldung werden Sie zum Xero-Entwickler-Dashboard weitergeleitet.

  3. Rufen Sie im Entwickler-Dashboard im Bereich Meine Apps das Xero-Entwicklerportal auf.
  4. Klicken Sie auf Neue App oder Neue App erstellen, um eine neue App zu erstellen.
  5. Geben Sie die erforderlichen Details für Ihre App ein, z. B. den App-Namen, die Beschreibung, die Unternehmens-URL, die URL der Datenschutzerklärung, die URL der Nutzungsbedingungen und die Callback-URL.
  6. Achten Sie darauf, den richtigen App-Typ und die für die Integration mit dem Demounternehmen von Xero erforderlichen Berechtigungen auszuwählen.

    7. Nachdem Sie Ihre App erstellt haben, erhalten Sie die OAuth-Anmeldedaten, einschließlich einer Client-ID und eines Clientschlüssels.

  7. Bewahren Sie die Client-ID und den Clientschlüssel für die spätere Verwendung an einem sicheren Ort auf.

    8. Wenn Sie Ihre Integration erstellen, wählen Sie die erforderlichen Bereiche für jedes Schema sorgfältig aus, damit Ihre Anwendung die entsprechenden Berechtigungen für den Zugriff auf die erforderlichen Dienstprogramme und deren Nutzung hat.

    Informationen zur Authentifizierung und zum Abrufen von Client-ID und Clientschlüssel finden Sie unter Client-ID und Clientschlüssel abrufen.

Schemadetails einrichten

Sie können das Schema basierend auf dem Modul auswählen. Die verfügbaren Schemas sind ACCOUNTING, ASSETS, PAYROLLAUS, FILES und PROJECTS. Da es fünf verschiedene Module gibt, müssen Sie für jedes Modul eine separate Verbindung erstellen.

Informationen zu Bereichen, die Sie beim Erstellen einer Verbindung angeben können, finden Sie unter Bereiche.

Autorisierungsdetails einrichten

Informationen zum Einrichten der Autorisierungs-URL finden Sie unter Autorisierungs-URL einrichten.

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.

      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 Verbindungsdetails folgende Schritte aus:
    1. Connector: Wählen Sie Xero 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. Schema: Die Xero API, auf die Sie als Datenbankschema zugreifen möchten.
    9. Mandant: Legt die Xero-Organisation fest, mit der eine Verbindung hergestellt werden soll. Kann ein Name oder eine Mandanten-ID sein.
    10. Ausführlichkeitsgrad: Ausführlichkeitsgrad für die Verbindung, variiert zwischen 1 und 5. Bei einem höheren Ausführlichkeitsgrad werden alle Kommunikationsdetails (Anfrage,Antwort und SSL-Zertifikate) protokolliert.
    11. Klicken Sie optional auf + Label hinzufügen, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
    12. Klicken Sie auf Weiter.
  5. 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 Xero-Verbindung unterstützt:

      • Anmeldedaten des OAuth 2.0-Clients
      • OAuth 2.0-Autorisierungscode-Zuweisung

      2. Informationen zum Konfigurieren dieser Authentifizierungstypen finden Sie unter Authentifizierung konfigurieren.

    2. Klicken Sie auf Next (Weiter).
  6. Überprüfen: Prüfen Sie Ihre Verbindungs- und Authentifizierungsdetails.
  7. Klicken Sie auf Erstellen.

Authentifizierung konfigurieren

Geben Sie die Details basierend auf der zu verwendenden Authentifizierung ein.

  • OAuth 2.0-Clientanmeldedaten
    • 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.
  • OAuth 2.0-Autorisierungs-Code-Prozess
    • Zugriffstoken: Das Zugriffstoken, das zur Authentifizierung von Anfragen mit auth-code-flow-basierten Verbindungen verwendet wird.
    • Client-ID: Die Client-ID, die zum Anfordern von Zugriffstokens verwendet wird.
    • Clientschlüssel: Der Clientschlüssel, der zum Anfordern von Zugriffstokens verwendet wird.

Verbindung konfigurieren

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

Typ der Verbindung zum Abrechnungsserver

Feldname Details
Region us-central1
Connector Xero
Connector-Version 1
Verbindungsname google-cloud-xero-accounting-connection
Dienstkonto SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Schema ABRECHNUNG
Ausführlichkeitsgrad 5
Mindestanzahl von Knoten 2
Maximale Anzahl von Knoten 50
Authentifizierung OAuth 2.0-Autorisierungscode
Client-ID CLIENT_ID
Bereiche offline_access openid profile email accounting.transactions, accounting.reports.read, accounting.attachments, accounting.journals.read, accounting.settings, accounting.contacts, accounting.budgets.read
Clientschlüssel CLIENT_SECRET
Secret-Version 1
Autorisierungs-URL https://login.xero.com/identity/connect/authorize

Typ der Serververbindung für Assets

Feldname Details
Region us-central1
Connector Xero
Connector-Version 1
Verbindungsname google-cloud-xero-assets-connection
Dienstkonto SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Schema ASSETS
Ausführlichkeitsgrad 5
Mindestanzahl von Knoten 2
Maximale Anzahl von Knoten 50
Authentifizierung OAuth 2.0-Autorisierungscode
Client-ID CLIENT_ID
Bereiche assets.read, assets
Clientschlüssel CLIENT_SECRET
Secret-Version 1
Autorisierungs-URL https://login.xero.com/identity/connect/authorize

Typ der Verbindung zum Dateiserver

Feldname Details
Region us-central1
Connector Xero
Connector-Version 1
Verbindungsname google-cloud-xero-files-connection
Dienstkonto SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Schema DATEIEN
Ausführlichkeitsgrad 5
Mindestanzahl von Knoten 2
Maximale Anzahl von Knoten 50
Authentifizierung OAuth 2.0-Autorisierungscode
Client-ID CLIENT_ID
Bereiche files, files.read
Clientschlüssel CLIENT_SECRET
Secret-Version 1
Autorisierungs-URL https://login.xero.com/identity/connect/authorize

Typ der Payrollaus-Serververbindung

Feldname Details
Region us-central1
Connector Xero
Connector-Version 1
Verbindungsname google-cloud-xero-payroll-connection
Dienstkonto SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Schema PAYROLLAUS
Ausführlichkeitsgrad 5
Mindestanzahl von Knoten 2
Maximale Anzahl von Knoten 50
Authentifizierung OAuth 2.0-Autorisierungscode
Client-ID CLIENT_ID
Bereiche payroll.employees, payroll.payruns, payroll.payslip, payroll.timesheets, payroll.settings
Clientschlüssel CLIENT_SECRET
Secret-Version 1
Autorisierungs-URL https://login.xero.com/identity/connect/authorize

Typ der Serververbindung für Projekte

Feldname Details
Region us-central1
Connector Xero
Connector-Version 1
Verbindungsname google-cloud-xero-projects-connection
Dienstkonto SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Schema PROJEKTE
Ausführlichkeitsgrad 5
Mindestanzahl von Knoten 2
Maximale Anzahl von Knoten 50
Authentifizierung OAuth 2.0-Autorisierungscode
Client-ID CLIENT_ID
Bereiche projects, projects.read
Clientschlüssel CLIENT_SECRET
Secret-Version 1
Autorisierungs-URL https://login.xero.com/identity/connect/authorize

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 solche 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.

Xero-Verbindung in einer Integration verwenden

Systembeschränkungen

Der Xero-Connector kann 5 Transaktionen pro Sekunde und Knoten verarbeiten und drosselt alle Transaktionen, die dieses Limit überschreiten. Die Anzahl der Transaktionen, die der Xero-Connector verarbeiten kann, hängt jedoch auch von den Einschränkungen der Xero-Instanz ab. Weitere Informationen finden Sie unter Xero API rate limits. 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.

DownloadAttachment-Aktion

Durch diese Aktion wird ein Anhang heruntergeladen.

Eingabeparameter der Aktion „DownloadAttachment“

Parametername Datentyp Erforderlich Beschreibung
Dateiname String Nein Name des herunterzuladenden Anhangs.
Tabelle String Nein Der Name der Tabelle, aus der das Attachment heruntergeladen werden muss.
ObjectId String Nein ObjectId des Anhangs.

Ausgabeparameter der Aktion „DownloadAttachment“

Bei einem erfolgreichen Download wird der Status 200 (OK) zurückgegeben.

Informationen zum Konfigurieren der Aktion DownloadAttachment finden Sie unter Beispiele für Aktionen.

Aktion „UploadAttachment“

Mit dieser Aktion können Sie einen Anhang hochladen.

Eingabeparameter der Aktion „UploadAttachment“

Parametername Datentyp Erforderlich Beschreibung
Dateiname String Nein Name des hochzuladenden Anhangs.
ObjectId String Nein ObjectId des Anhangs.
ContentType String Nein Inhaltstyp des Anhangs.
Tabelle String Nein Der Name der Tabelle, in die das Attachment hochgeladen werden soll.
Inhalt String Nein Inhalt des Anhangs

Ausgabeparameter der Aktion „UploadAttachment“

Diese Aktion gibt den Status 200 (OK) zurück, wenn der Objekt-Upload erfolgreich war.

Informationen zum Konfigurieren der Aktion UploadAttachment finden Sie unter Beispiele für Aktionen.

ListAttachment-Aktion

Mit dieser Aktion können Sie alle Anhänge einer Tabelle auflisten.

Eingabeparameter der Aktion „ListAttachment“

Parametername Datentyp Erforderlich Beschreibung
ObjectId String Nein Objekt-ID des Anhangs.
Tabelle String Nein Name der Tabelle, aus der die Anhänge aufgelistet werden müssen.

Ausgabeparameter der ListAttachment-Aktion

Bei erfolgreichem Löschen wird der Status 200 (OK) zurückgegeben.

Informationen zum Konfigurieren der ListAttachment-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „SendInvoiceMail“

Mit dieser Aktion können Sie E-Mails an einen Rechnungssteller senden.

Eingabeparameter der Aktion „SendInvoiceMail“

Parametername Datentyp Erforderlich Beschreibung
InvoiceId String Nein ID der Rechnung, für die die E‑Mail gesendet werden soll.

Ausgabeparameter der Aktion „SendInvoiceMail“

Bei erfolgreicher Verschiebung wird der Status 200 (OK) zurückgegeben.

Informationen zum Konfigurieren der SendInvoiceMail-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „UploadFile“

Mit dieser Aktion können Sie eine Datei hochladen.

Eingabeparameter der Aktion „UploadFile“

Parametername Datentyp Erforderlich Beschreibung
Name String Nein Name der Datei, die hochgeladen werden soll.
Inhalt String Nein Dateiinhalte, die hochgeladen werden sollen.

Ausgabeparameter der Aktion „UploadFile“

Diese Aktion gibt den Status 200 (OK) zurück, wenn der Objekt-Upload erfolgreich war.

Informationen zum Konfigurieren der UploadFile-Aktion finden Sie unter Beispiele für Aktionen.

Beispiele für Aktionen

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

Beispiel: Anhang herunterladen

In diesem Beispiel wird ein Anhang heruntergeladen.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion DownloadAttachment 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: 
    {
"Filename": "Xero_Test.txt",
"Table": "Contacts",
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41"
}

    4. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des DownloadAttachment-Vorgangs einen Wert, der dem folgenden ähnelt:

    [{
"Success": "True",
"Content": "Test content"
}]

Beispiel: Anhang hochladen

In diesem Beispiel wird ein Anhang hochgeladen.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion UploadAttachment 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: 
    {
"Filename": "Xero_Test.txt",
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
"ContentType": "txt",
"Table": "Contacts",
"Content": "Test content upload attachment"
}

    4. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des UploadAttachment-Vorgangs einen Wert, der dem folgenden ähnelt:

    [{
"Success": null,
"AttachmentId": "5ba982a6-9294-45a7-bdda-5f134b0d69d5",
"FileName": "Xero_Test.txt",
"URL": "https://api.xero.com/api.xro/2.0/Contacts/6a92a3ab-87cf-4f2f-8bwb-fcb4f8ae4d41/Attachments/Xero_Test.txt",
"MimeType": "text/plain",
"ContentLength": "27",
"IncludeOnline": null,
"_": ""
}, {
"Success": null,
"AttachmentId": null,
"FileName": null,
"URL": null,
"MimeType": null,
"ContentLength": null,
"IncludeOnline": null,
"_": null
}]

Beispiel – Anhänge auflisten

In diesem Beispiel werden die Anhänge der angegebenen Tabelle aufgeführt.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion ListAttachment 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: 
    {
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
"Table": "Contacts"
}

    4. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des ListAttachment-Vorgangs einen Wert, der dem folgenden ähnelt:

    [{
"AttachmentId": "5ba982a6-9294-45a7-bdda-5f134b0d69d5",
"FileName": "Xero_Limit_Testing.txt",
"URL": "https://api.xero.com/api.xro/2.0/Contacts/6a92a3ab-87cf-4f2f-8bwb-fcb4f8ae4d41/Attachments/Xero_Test.txt",
"MimeType": "text/plain",
"ContentLength": "27"
}]

Beispiel: E‑Mail mit Rechnung senden

In diesem Beispiel wird eine E‑Mail für die angegebene Rechnung gesendet.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion SendInvoiceMail 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: 
    {
"InvoiceId": "016a64c7-be0b-45a2-acae-13057fdf1566"
}

    4. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des SendInvoiceMail-Vorgangs einen Wert, der dem folgenden ähnelt:

    [{
"Success": "true"
}]

Beispiel: Datei hochladen

In diesem Beispiel wird eine Datei hochgeladen.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion UploadFile 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: 
    {
"Name": "Sample1.txt",
"Content": "This is a sample file"
}

    4. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des UploadFile-Vorgangs einen Wert, der dem folgenden ähnelt:

    [{
"Success": "true",
"FileId": "09039c7b-35a2-473d-aa79-16fe00b8d460",
"Name": "Sample1.txt",
"FolderId": "36e5115d-a9b6-4c22-baf3-40a8b28ee71d",
"MimeType": "text/plain",
"Size": 26.0,
"User_Id": "c1e33cc9-eb61-45cb-9e46-3ea4121cbdc6",
"User_Name": "test_user_1@test.com",
"User_FirstName": "John",
"User_LastName": "Smith",
"User_FullName": "John Smith",
"Created": "2023-12-18 17:38:53.01",
"Updated": "2023-12-18 17:38:53.01"
}]

Beispiele für Entitätsvorgänge

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

Beispiel: Alle Datensätze auflisten

In diesem Beispiel werden alle Datensätze in der Entität Accounts aufgelistet.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie Accounts 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: Rechnung erhalten

In diesem Beispiel wird eine Rechnung mit der angegebenen ID aus der Invoices-Entität abgerufen.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie Invoices 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 1|016a64c7-be0b-45a2-acae-13057fdf1566 in das Feld Standardwert ein.

    Dabei ist 1|016a64c7-be0b-45a2-acae-13057fdf1566 ein Primärschlüsselwert in der Entität Invoices.

Beispiel: Rechnung erstellen

In diesem Beispiel wird eine Rechnung in der Invoices-Einheit erstellt.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie Invoices 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: 
    {
"Type": "ACCPAY",
"ContactName": "ContactName1",
"LineItem_Description": "LineItemDescription"
}

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

    {
"Id": "1|7b29efe9-dacd-47bb-85a6-0c0640ce25de"
}

Beispiel: Datensatz aktualisieren

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

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie AssetTypes 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: 
    {
"BookDepreciationSetting_DepreciationRate": 10.0
}
  5. Klicken Sie auf entityId und geben Sie dann f8d43548-25b0-4cc3-8f59-d97106974fe8 in das Feld Standardwert ein.

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

    {
"AssetTypeId": "f8d43548-25b0-4cc3-8f59-d97106974fe8"
}

Beispiel: Datei löschen

In diesem Beispiel wird die Datei mit der angegebenen ID aus der Files-Einheit gelöscht.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie Files 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 421c82f0-38fb-4074-a679-63b04c0d8832 in das Feld Standardwert ein.

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