Quadrat

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

Unterstützte Versionen

Dieser Connector unterstützt Square Version 1.0.

Hinweise

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

  • 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

Eine Verbindung gilt für eine Datenquelle. 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 Square aus der Liste der verfügbaren Connectors aus.
    2. Connector-Version: Wählen Sie die Connector-Version aus der 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. Beschreibung: Geben Sie 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. Schema: Geben Sie das Schema für die Verbindung an, z. B. v1 oder v2.
    8. Sandbox verwenden: Gibt an, ob die Sandbox-Umgebung für die Verbindung verwendet werden soll.
    9. Standort-ID: Geben Sie die Standort-ID für die Verbindung an.
    10. 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.

    11. + LABEL HINZUFÜGEN: Klicken Sie hier, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
    12. Tippen 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 Square-Verbindung unterstützt:

      • OAuth 2.0-Autorisierungscode
      • Persönliches Zugriffstoken

      Informationen zum Konfigurieren dieser Authentifizierungstypen finden Sie unter Authentifizierung konfigurieren.

    2. Tippen Sie auf 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-Autorisierungscode
    • Client-ID: Geben Sie die Client-ID ein, die für die Verbindung verwendet werden soll.
    • Bereiche: Geben Sie eine durch Kommas getrennte Liste der gewünschten Bereiche ein.
    • Clientschlüssel: Geben Sie den Clientschlüssel ein, der für die Square-Verbindung verwendet werden soll.
    • Secret-Version: Wählen Sie die Secret-Version für das oben ausgewählte Secret aus.
    • Autorisierungs-URL: Geben Sie die Autorisierungs-URL ein, die beim Erstellen des Clients generiert wurde.
    • Authentifizierungsüberschreibung aktivieren: Geben Sie an, ob die Authentifizierungsüberschreibung für die Verbindung aktiviert werden soll.
  • Persönliches Zugriffstoken
    • Persönliches Zugriffstoken: Geben Sie das persönliche Zugriffstoken ein, das für die Verbindung verwendet werden soll.
    • Secret-Version: Wählen Sie die Secret-Version für das oben ausgewählte Secret aus.
    • Authentifizierungsüberschreibung aktivieren: Geben Sie an, ob die Authentifizierungsüberschreibung für die Verbindung aktiviert werden soll.

Beispiele für Verbindungskonfigurationen

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

OAuth 2.0-Verbindungstyp mit Autorisierungscode

Feldname Details
Standort us-central1
Connector Quadrat
Connector-Version 1
Verbindungsname square-oauth-ai
Cloud Logging aktivieren wahr
Dienstkonto my-service-account@my-project.iam.gserviceaccount.com
Schema v2
Mindestanzahl von Knoten 2
Maximale Anzahl von Knoten 50
Authentifizierung OAuth 2.0-Autorisierungscode
Client-ID CLIENT_ID
Bereiche BANK_ACCOUNTS_READ, CASH_DRAWER_READ, CUSTOMERS_READ, CUSTOMERS_WRITE, DEVICE_CREDENTIAL_MANAGEMENT, EMPLOYEES_READ, EMPLOYEES_WRITE, INVENTORY_READ, INVENTORY_WRITE, ITEMS_READ, ITEMS_WRITE, LOYALTY_READ, LOYALTY_WRITE, MERCHANT_PROFILE_READ, ORDERS_READ, ORDERS_WRITE, PAYMENTS_READ, PAYMENTS_WRITE, PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS, PAYMENTS_WRITE_IN_PERSON, SETTLEMENTS_READ, TIMECARDS_READ, TIMECARDS_WRITE, TIMECARDS_SETTINGS_READ, TIMECARDS_SETTINGS_WRITE, APPOINTMENTS_READ, APPOINTMENTS_WRITE, APPOINTMENTS_BUSINESS_SETTINGS_READ, INVOICES_READ, INVOICES_WRITE, SUBSCRIPTIONS_READ, SUBSCRIPTIONS_WRITE, DISPUTES_READ, DISPUTES_WRITE, GIFTCARDS_READ, GIFTCARDS_WRITE, ONLINE_STORE_SNIPPETS_WRITE, ONLINE_STORE_SNIPPETS_READ, ONLINE_STORE_SITE_READ, PAYMENTS_WRITE_SHARED_ONFILE, APPOINTMENTS_ALL_READ, APPOINTMENTS_ALL_WRITE, MERCHANT_PROFILE_WRITE, VENDOR_READ, VENDOR_WRITE, PAYOUTS_READ, DEVICES_READ
Clientschlüssel CLIENT_SECRET
Secret-Version 1
Autorisierungs-URL https://connect.squareup.com/oauth2/authorize

Verbindungstyp für persönliches Zugriffstoken

Feldname Details
Standort asia-east1
Connector Quadrat
Connector-Version 1
Verbindungsname square-pat-prod-conn
Cloud Logging aktivieren wahr
Dienstkonto my-service-account@my-project.iam.gserviceaccount.com
Schema v2
Sandbox verwenden wahr
Mindestanzahl von Knoten 2
Maximale Anzahl von Knoten 50
Authentifizierung Persönliches Zugriffstoken
Persönliches Zugriffstoken PERSONAL_ACCESS_TOKEN
Secret-Version 1

Systembeschränkungen

Der Square-Connector kann maximal 16 Transaktionen pro Sekunde und Knoten verarbeiten. Alle Transaktionen, die dieses Limit überschreiten, werden gedrosselt. 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.

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

Aktionen

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

Aktion „CancelPayment“

Durch diese Aktion wird eine Zahlung storniert.

Eingabeparameter der Aktion „CancelPayment“

Parametername Datentyp Erforderlich Beschreibung
PaymentId String Wahr Die ID der Zahlung, die storniert werden soll.

Ein Beispiel für die Konfiguration der Aktion CancelPayment finden Sie unter Beispiele.

„CompletePayment“-Aktion

Durch diese Aktion wird eine Zahlung abgeschlossen.

Eingabeparameter der Aktion „CompletePayment“

Parametername Datentyp Erforderlich Beschreibung
PaymentId String Wahr Die ID der abzuschließenden Zahlung.

Ein Beispiel für die Konfiguration der Aktion CompletePayment finden Sie unter Beispiele.

CancelPaymentByIdempotencyKey-Aktion

Mit dieser Aktion wird eine Zahlung mit ihrem Idempotenzschlüssel storniert.

Eingabeparameter der Aktion „CancelPaymentByIdempotencyKey“

Parametername Datentyp Erforderlich Beschreibung
IdempotencyKey String Wahr Der Idempotenzschlüssel, mit dem die zu stornierende Zahlung identifiziert wird.

Ein Beispiel für die Konfiguration der Aktion CancelPaymentByIdempotencyKey finden Sie unter Beispiele.

Aktion „CancelInvoice“

Durch diese Aktion wird eine Rechnung storniert.

Eingabeparameter der Aktion „CancelInvoice“

Parametername Datentyp Erforderlich Beschreibung
InvoiceId String Wahr Die ID der Rechnung, die storniert werden soll.
InvoiceVersion String Wahr Die Version der Rechnung, die storniert werden soll.

Ein Beispiel für die Konfiguration der Aktion CancelInvoice finden Sie unter Beispiele.

PublishInvoice-Aktion

Dadurch wird eine Rechnung veröffentlicht.

Eingabeparameter der Aktion „PublishInvoice“

Parametername Datentyp Erforderlich Beschreibung
InvoiceId String Wahr Die ID der zu veröffentlichenden Rechnung.
InvoiceVersion Int32 Wahr Die Version der Rechnung, die veröffentlicht werden soll. Diese muss mit der aktuellen Version der Rechnung übereinstimmen. Andernfalls wird die Anfrage abgelehnt.

Ein Beispiel für die Konfiguration der Aktion PublishInvoice finden Sie unter Beispiele.

DeleteInvoiceAttachment-Aktion

Durch diese Aktion wird ein Rechnungsanhang gelöscht.

Eingabeparameter der Aktion „DeleteInvoiceAttachment“

Parametername Datentyp Erforderlich Beschreibung
InvoiceId String Wahr Die ID der Rechnung, die die zu löschende Anlage enthält.
AttachmentId String Wahr Die ID des zu löschenden Anhangs.

Ein Beispiel für die Konfiguration der Aktion DeleteInvoiceAttachment finden Sie unter Beispiele.

Aktion „CancelSubscriptions“

Durch diese Aktion wird ein Abo gekündigt.

Eingabeparameter der Aktion „CancelSubscriptions“

Parametername Datentyp Erforderlich Beschreibung
ID String Wahr Die ID des zu kündigenden Abos.

Ein Beispiel für die Konfiguration der Aktion CancelSubscriptions finden Sie unter Beispiele.

Beispiele für Aktionen

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

Beispiel: Zahlung stornieren

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion CancelPayment 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: 
    {
  "PaymentId": "P7eOGiuAYV8CfcLxSXHuUsedBRMZY"
}

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

    [
  {
    "Success": true
  }
]

Beispiel: Zahlung abschließen

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion CompletePayment 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: 
    {
  "PaymentId": "JiZRuypGuu4B7OOoPhL3kYg9YZaZY"
}

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

    [{
"Success": true
}]

Beispiel: Zahlung mit einem Idempotenzschlüssel stornieren

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion CancelPaymentByIdempotencyKey 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: 
    {
  "IdempotencyKey": "8b3e387b-a4d8-480c-a871-1c5fdcfd82cd"
}

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

    [{
"Success": true
}]

Beispiel: Rechnung stornieren

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion CancelInvoice 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": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
"InvoiceVersion": "2"
}

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

    [
  {
    "invoice_id": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
    "invoice_version": "3",
    "invoice_location_id": "LSHW80WV4KB06",
    "invoice_order_id": "dfChzstnmPfPGdEIFQ6ulRFdOf4F",
    "invoice_payment_requests_uid": "28ff79b1-16de-4c82-bb88-3f4e02be68c5",
    "invoice_payment_requests_request_type": "BALANCE",
    "invoice_payment_requests_due_date": "2025-11-26",
    "invoice_payment_requests_tipping_enabled": "true",
    "invoice_payment_requests_computed_amount_money_amount": "60",
    "invoice_payment_requests_computed_amount_money_currency": "USD",
    "invoice_payment_requests_total_completed_amount_money_amount": "0",
    "invoice_payment_requests_total_completed_amount_money_currency": "USD",
    "invoice_payment_requests_reminders_uid": "ae64a254-d516-4014-aea2-5fee42ec7457",
    "invoice_payment_requests_reminders_relative_scheduled_days": "1",
    "invoice_payment_requests_reminders_message": "Your invoice is almost due",
    "invoice_payment_requests_reminders_status": "NOT_APPLICABLE",
    "invoice_payment_requests_automatic_payment_source": "NONE",
    "invoice_primary_recipient_customer_id": "5BH2SYXX0G87A7NBYZKKJJTDVG",
    "invoice_primary_recipient_given_name": "Postman",
    "invoice_primary_recipient_family_name": "Test",
    "invoice_primary_recipient_email_address": "Charlie.Cruz@altostrat.com",
    "invoice_primary_recipient_phone_number": "1-212-555-4240",
    "invoice_primary_recipient_company_name": "Square",
    "invoice_primary_recipient_address_address_line_1": "500 Electric Ave",
    "invoice_primary_recipient_address_address_line_2": "Suite 600",
    "invoice_primary_recipient_address_locality": "New York",
    "invoice_primary_recipient_address_administrative_district_level_1": "NY",
    "invoice_primary_recipient_address_postal_code": "10003",
    "invoice_primary_recipient_address_country": "US",
    "invoice_invoice_number": "00000001",
    "invoice_title": "Invoice Update",
    "invoice_description": "Updating invoice",
    "invoice_public_url": "https://app.squareupsandbox.com/pay-invoice/invtmp:8779596a-2c13-4cf0-ab21-05eb6a1d03ef",
    "invoice_status": "CANCELED",
    "invoice_timezone": "UTC",
    "invoice_created_at": "2025-06-11T09:19:10Z",
    "invoice_updated_at": "2025-06-11T09:57:24Z",
    "invoice_accepted_payment_methods_card": "true",
    "invoice_accepted_payment_methods_square_gift_card": "true",
    "invoice_accepted_payment_methods_bank_account": "true",
    "invoice_accepted_payment_methods_buy_now_pay_later": "true",
    "invoice_accepted_payment_methods_cash_app_pay": "true",
    "invoice_delivery_method": "EMAIL",
    "invoice_store_payment_method_enabled": "true",
    "success": true
  }
]

Beispiel: Rechnung veröffentlichen

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion PublishInvoice 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": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
  "InvoiceVersion": 1
}

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

    [
  {
    "invoice_id": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
    "invoice_version": "2",
    "invoice_location_id": "LSHW80WV4KB06",
    "invoice_order_id": "dfChzstnmPfPGdEIFQ6ulRFdOf4F",
    "invoice_payment_requests_uid": "28ff79b1-16de-4c82-bb88-3f4e02be68c5",
    "invoice_payment_requests_request_type": "BALANCE",
    "invoice_payment_requests_due_date": "2025-11-26",
    "invoice_payment_requests_tipping_enabled": "true",
    "invoice_payment_requests_computed_amount_money_amount": "60",
    "invoice_payment_requests_computed_amount_money_currency": "USD",
    "invoice_payment_requests_total_completed_amount_money_amount": "0",
    "invoice_payment_requests_total_completed_amount_money_currency": "USD",
    "invoice_payment_requests_reminders_uid": "ae64a254-d516-4014-aea2-5fee42ec7457",
    "invoice_payment_requests_reminders_relative_scheduled_days": "1",
    "invoice_payment_requests_reminders_message": "Your invoice is almost due",
    "invoice_payment_requests_reminders_status": "PENDING",
    "invoice_payment_requests_automatic_payment_source": "NONE",
    "invoice_primary_recipient_customer_id": "5BH2SYXX0G87A7NBYZKKJJTDVG",
    "invoice_primary_recipient_given_name": "Postman",
    "invoice_primary_recipient_family_name": "Test",
    "invoice_primary_recipient_email_address": "Charlie.Cruz@altostrat.com",
    "invoice_primary_recipient_phone_number": "1-212-555-4240",
    "invoice_primary_recipient_company_name": "Square",
    "invoice_primary_recipient_address_address_line_1": "500 Electric Ave",
    "invoice_primary_recipient_address_address_line_2": "Suite 600",
    "invoice_primary_recipient_address_locality": "New York",
    "invoice_primary_recipient_address_administrative_district_level_1": "NY",
    "invoice_primary_recipient_address_postal_code": "10003",
    "invoice_primary_recipient_address_country": "US",
    "invoice_invoice_number": "00000001",
    "invoice_title": "Invoice Update",
    "invoice_description": "Updating invoice",
    "invoice_public_url": "https://app.squareupsandbox.com/pay-invoice/invtmp:8779596a-2c13-4cf0-ab21-05eb6a1d03ef",
    "invoice_next_payment_amount_money_amount": "60",
    "invoice_next_payment_amount_money_currency": "USD",
    "invoice_status": "UNPAID",
    "invoice_timezone": "UTC",
    "invoice_created_at": "2025-06-11T09:19:10Z",
    "invoice_updated_at": "2025-06-11T09:52:13Z",
    "invoice_accepted_payment_methods_card": "true",
    "invoice_accepted_payment_methods_square_gift_card": "true",
    "invoice_accepted_payment_methods_bank_account": "true",
    "invoice_accepted_payment_methods_buy_now_pay_later": "true",
    "invoice_accepted_payment_methods_cash_app_pay": "true",
    "invoice_delivery_method": "EMAIL",
    "invoice_store_payment_method_enabled": "true",
    "success": true
  }
]

Beispiel: Rechnungsanhang löschen

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion DeleteInvoiceAttachment 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": "inv:0-ChBGMewfnhndQBmYdpW0sp3uEPgO",
  "AttachmentId": "inva:0-ChBsWWogZxWt0bRCqCdHkJJO"
}

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

    [{
"Success": true
}]

Beispiel: Abo kündigen

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion CancelSubscriptions 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: 
    {
  "Id": "40da986b-08e4-45bf-9ba2-d11cf9f589fb"
}

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

    [{
"Success": true,
"Status": "CANCELED"

}]

Beispiele für Entitätsvorgänge

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

Beispiel: Alle Zahlungen auflisten

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie Payments aus der Liste Entity aus.
  3. Wählen Sie den Vorgang List aus und klicken Sie auf Fertig.
  4. Im Bereich Aufgabeneingabe der Aufgabe Connectors können Sie die filterClause entsprechend Ihren Filteranforderungen festlegen.

    5. Der Wert für eine filterClause muss in einfache Anführungszeichen (') gesetzt sein. Mit filterClause können Sie Datensätze anhand der Spalten filtern.

Beispiel: Zahlungsdetails abrufen

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie Payments aus der Liste Entity aus.
  3. Wählen Sie den Vorgang Get aus und klicken Sie auf Fertig.
  4. Legen Sie entityId auf "bb4756c7-38c0-426b-97aa-03b6443e7f16" fest. Dies ist der Schlüssel, der übergeben werden soll.
  5. Klicken Sie zum Festlegen der entityId im Bereich Data Mapper des Data Mapping auf Open Data Mapping Editor (Datenabgleichs-Editor öffnen), geben Sie "bb4756c7-38c0-426b-97aa-03b6443e7f16" in das Feld Input Value (Eingabewert) ein und wählen Sie entityId als lokale Variable aus.

    6. Der Wert für entityId muss direkt übergeben werden, z. B. "bb4756c7-38c0-426b-97aa-03b6443e7f16". Dabei ist "bb4756c7-38c0-426b-97aa-03b6443e7f16" der eindeutige Primärschlüsselwert.

    Wenn beim Übergeben einer einzelnen entityId aufgrund des Vorhandenseins von zwei zusammengesetzten Schlüsseln ein Fehler auftritt, können Sie den Wert mit der filterClause übergeben.

Beispiel: Zahlung löschen

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie Payments aus der Liste Entity aus.
  3. Wählen Sie den Vorgang Delete aus und klicken Sie auf Fertig.
  4. Legen Sie entityId auf "62008bbe-effa-4341-9d29-eac7f67b84fe" fest. Dies ist der Schlüssel, der übergeben werden soll.
  5. Klicken Sie zum Festlegen der entityId im Bereich Data Mapper (Datenzuordnung) von Data Mapping (Datenabgleich) auf Open Data Mapping Editor (Datenabgleichs-Editor öffnen). Geben Sie dann "62008bbe-effa-4341-9d29-eac7f67b84fe" in das Feld Input Value (Eingabewert) ein und wählen Sie entityId als lokale Variable aus.

    6. Wenn die Entität zwei zusammengesetzte Geschäfts- oder Primärschlüssel hat, können Sie anstelle der entityId auch die filterClause auf id='62008bbe-effa-4341-9d29-eac7f67b84fe' festlegen.

Beispiel: Zahlung erstellen

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie Payments aus der Liste Entity aus.
  3. Wählen Sie den Vorgang Create aus und klicken Sie auf Fertig.
  4. Klicken Sie im Bereich Data Mapper der Aufgabe Data Mapping auf Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Input Value ein. Wählen Sie entityId oder connectorInputPayload als lokale Variable aus. 
    {
  "ShippingAddressLine1": "Paris",
  "BillingAddressFirstName": "Charlie",
  "SourceId": "cnon:card-nonce-ok",
  "BankName": "Altostrat bank",
  "MoneyAmount": 7,
  "MoneyCurrency": "USD",
  "IdempotencyKey": "ab5c8c43-eaba-474e-935c-268ea3ae453a"
}

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

    {
  "Id": "BY8GnuLixAdrbr93m8nYHDgONxZZY"
}

Beispiel: Erstattung erstellen

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie Refunds aus der Liste Entity aus.
  3. Wählen Sie den Vorgang Create aus und klicken Sie auf Fertig.
  4. Klicken Sie im Bereich Data Mapper der Aufgabe Data Mapping auf Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Input Value ein. Wählen Sie entityId oder connectorInputPayload als lokale Variable aus. 
    {
  "PaymentId": "50yXsd0oousMgYUv0372RkIdJnRZY",
  "RefundedMoneyAmount": 72,
  "RefundedMoneyCurrency": "USD"
}

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

    {
  "Success": true
}

Beispiel: Abo erstellen

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie Subscriptions aus der Liste Entity aus.
  3. Wählen Sie den Vorgang Create aus und klicken Sie auf Fertig.
  4. Klicken Sie im Bereich Data Mapper der Aufgabe Data Mapping auf Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Input Value ein. Wählen Sie entityId oder connectorInputPayload als lokale Variable aus. 
    {
  "LocationId": "LSHW80WV4KB06",
  "CustomerId": "TE9VCZMC369HVA2RVBCEKTDQ6G",
  "PlanId": "OEVRZUHD5C42W7VQUT22WURN",
  "Ordinal": 0,
  "OrderTemplateId": "d9ZVzcjiHVc2Ugd0bzlE7yZT9g4F"
}

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

    {
  "Id": "40da986b-08e4-45bf-9ba2-d11cf9f589fb"
}

Beispiel: Kundenkonto erstellen

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie Customers aus der Liste Entity aus.
  3. Wählen Sie den Vorgang Create aus und klicken Sie auf Fertig.
  4. Klicken Sie im Bereich Data Mapper der Aufgabe Data Mapping auf Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Input Value ein. Wählen Sie entityId oder connectorInputPayload als lokale Variable aus. 
    {
  "FamilyName": "LastName",
  "GivenName": "FirstName"
}

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

    {
  "Id": "X8883DFR5M4AXGEKRSCFE3F2M9"
}

Beispiel: Geschenkkarte erstellen

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie GiftCards aus der Liste Entity aus.
  3. Wählen Sie den Vorgang Create aus und klicken Sie auf Fertig.
  4. Klicken Sie im Bereich Data Mapper der Aufgabe Data Mapping auf Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Input Value ein. Wählen Sie entityId oder connectorInputPayload als lokale Variable aus. 
    
{
  "Type": "DIGITAL",
  "LocationId": "LSHW80WV4KB06"
}

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

    {
  "Id": "X8883DFR5M4AXGEKRSCFE3F2M0"
}

Beispiel: Rechnung aktualisieren

  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 Update aus und klicken Sie auf Fertig.
  4. Klicken Sie im Bereich Data Mapper der Aufgabe Data Mapping auf Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Input Value ein. Wählen Sie entityId, connectorInputPayload oder filterClause als lokale Variable aus. 
    {
  "Title": "Invoice Update",
  "Description": "Update Invoice",
  "Version": 0
}
  5. Legen Sie die entityId im Data Mapper auf die Entität der Rechnungen fest.
  6. Klicken Sie zum Festlegen der entityId auf Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Input Value ein. Wählen Sie entityId, connectorInputPayload oder filterClause als lokale Variable aus.

    Anstelle der entityId können Sie auch die filterClause auf 'inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO' festlegen.

    Wenn Sie dieses Beispiel ausführen, wird eine Antwort ähnlich der folgenden in der Ausgabevariable connectorOutputPayload des Connector-Tasks zurückgegeben:

    { }

Beispiel: Abo aktualisieren

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie Subscriptions aus der Liste Entity aus.
  3. Wählen Sie den Vorgang Update aus und klicken Sie auf Fertig.
  4. Klicken Sie im Bereich Data Mapper (Datenzuordnung) der Aufgabe Data Mapping (Datenabgleich) auf Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Input Value ein. Wählen Sie entityId, connectorInputPayload oder filterClause als lokale Variable aus. 
    {
  "Note": "Update Subscription"
}
  5. Legen Sie die entityId im Data Mapper auf die Entität der Abos fest.
  6. Klicken Sie zum Festlegen der entityId auf Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Input Value ein. Wählen Sie entityId, connectorInputPayload oder filterClause als lokale Variable aus.

    Anstelle der entityId können Sie auch die filterClause auf '40da986b-08e4-45bf-9ba2-d11cf9f589fb' festlegen.

    Wenn Sie dieses Beispiel ausführen, wird eine Antwort ähnlich der folgenden in der Ausgabevariable connectorOutputPayload des Connector-Tasks zurückgegeben:

    { }

Beispiel: Auszahlungsdetails aktualisieren

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie PayOuts aus der Liste Entity aus.
  3. Wählen Sie den Vorgang Update aus und klicken Sie auf Fertig.
  4. Klicken Sie im Bereich Data Mapper der Aufgabe Data Mapping auf Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Input Value ein. Wählen Sie entityId, connectorInputPayload oder filterClause als lokale Variable aus. 
    {
  "Version": 1,
  "Description": "Update Payout"
}
  5. Legen Sie die entityId im Data Mapper auf die Entität der Auszahlungen fest.
  6. Klicken Sie zum Festlegen der entityId auf Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Input Value ein. Wählen Sie entityId, connectorInputPayload oder filterClause als lokale Variable aus.

    Anstelle der entityId können Sie auch die filterClause auf '181352d9-94ef-4e86-8bb9-e3759472325f' festlegen.

    Wenn Sie dieses Beispiel ausführen, wird eine Antwort ähnlich der folgenden in der Ausgabevariable connectorOutputPayload des Connector-Tasks zurückgegeben:

    { }

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