Shopify

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

Unterstützte Versionen

Mit diesem Connector werden die Shopify Admin APIs als relationale Datenbank modelliert.

Hinweis

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

  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 Shopify 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. Aktivieren Sie optional Cloud Logging. und wählen Sie dann eine Logebene aus. 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 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.

    8. App-ID: App-ID für die Admin API.
    9. Maximale Punkte pro Anruf: Gibt an, wie viele Punkte ein Anruf kostet.
    10. Schema: Gib die Shopify-Serverversion an, mit der eine Verbindung hergestellt werden soll.
    11. Proxy verwenden: Aktivieren Sie dieses Kästchen, um einen Proxyserver für die Verbindung zu konfigurieren. Legen Sie dann die folgenden Werte fest:
      • Proxy Auth Scheme (Proxy-Authentifizierungsschema): Wählen Sie den Authentifizierungstyp für die Authentifizierung beim Proxyserver aus. Die folgenden Authentifizierungstypen werden unterstützt:
        • Standard: Basis-HTTP-Authentifizierung.
        • Digest: Digest-HTTP-Authentifizierung.
      • Proxy User: Ein Nutzername, der für die Authentifizierung beim Proxyserver verwendet werden soll.
      • Proxy-Passwort: Das Secret Manager-Secret des Nutzerpassworts.
      • Proxy-SSL-Typ: Der SSL-Typ, der beim Herstellen einer Verbindung zum Proxyserver verwendet werden soll. Die folgenden Authentifizierungstypen werden unterstützt:
        • Automatisch: Standardeinstellung. Wenn es sich bei der URL um eine HTTPS-URL handelt, wird die Option „Tunnel“ verwendet. Wenn es sich bei der URL um eine HTTP-URL handelt, wird die Option „NEVER“ (NIE) verwendet.
        • Immer: Für die Verbindung ist immer SSL aktiviert.
        • Nie: Die Verbindung ist nicht SSL-fähig.
        • Tunnel: Die Verbindung erfolgt über einen Tunneling-Proxy. Der Proxyserver öffnet eine Verbindung zum Remote-Host und der Traffic fließt über den Proxy hin und zurück.
      • Geben Sie im Abschnitt Proxyserver Details zum Proxyserver ein.
        1. Klicken Sie auf + Ziel hinzufügen.
        2. Wählen Sie einen Zieltyp aus.
          • Hostadresse: Geben Sie den Hostnamen oder die IP-Adresse des Ziels an.

            Wenn Sie eine private Verbindung zu Ihrem Back-End-System herstellen möchten, gehen Sie so vor:

            • Erstellen Sie einen PSC-Dienstanhang.
            • Erstellen Sie einen Endpunktanhang und geben Sie dann die Details des Endpunktanhangs in das Feld Hostadresse ein.
    12. Klicken Sie optional auf + LABEL HINZUFÜGEN, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
    13. Tippen 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. Destination Type: Wählen Sie einen Destination Type aus.
      • Wählen Sie in der Liste Hostadresse aus, um den Hostnamen oder die IP-Adresse des Ziels anzugeben.
      • Wenn Sie eine private Verbindung zu Ihren Backend-Systemen herstellen möchten, wählen Sie in der Liste Endpunktanhang und dann den erforderlichen Endpunktanhang aus der Liste Endpunktanhang aus.

      Wenn Sie eine öffentliche Verbindung zu Ihren Back-End-Systemen mit zusätzlicher Sicherheit herstellen möchten, können Sie statische ausgehende IP-Adressen für Ihre Verbindungen konfigurieren und dann Ihre Firewallregeln konfigurieren, um nur bestimmte statische IP-Adressen zuzulassen.

      Wenn Sie weitere Ziele eingeben möchten, klicken Sie auf + ZIEL HINZUFÜGEN.

    2. Tippen Sie auf Weiter.
  6. Geben Sie im Abschnitt Authentifizierung die Authentifizierungsdetails ein.
    1. Für die Shopify-Verbindung ist keine Authentifizierung erforderlich.
    2. Tippen Sie auf Weiter.
  7. Überprüfen: Prüfen Sie Ihre Verbindungs- und Authentifizierungsdetails.
  8. 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. Wenn ein Connector jedoch keinen der Entitätsvorgänge unterstützt, werden diese 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 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.

Beispiele für Entitätsvorgänge

Beispiel: Alle Produkte auflisten

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

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie in der Liste Entity die Option Products aus.
  3. Wählen Sie den Vorgang List aus und klicken Sie auf Fertig.

Beispiel – Kundendaten abrufen

In diesem Beispiel werden die Details des angegebenen Kunden aus der Customers-Entität.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wähle Customers aus der Entity-Liste aus.
  3. Wählen Sie den Vorgang Get aus und klicken Sie auf Fertig.
  4. Geben Sie die Entitäts-ID des Kunden ein, dessen Details Sie abrufen möchten.

    Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf entityId und geben Sie dann 365009521884E12 in das Feld Standardwert ein.

Beispiel: Bestelleintrag löschen

In diesem Beispiel wird die angegebene Bestellung aus der Entität Order gelöscht.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wähle Order aus der Entity-Liste aus.
  3. Wählen Sie den Vorgang Delete aus und klicken Sie auf Fertig.
  4. Geben Sie die Entitäts-ID des Auftrags ein, den Sie löschen möchten.

    Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf entityId und geben Sie dann 475009571483E15 in das Feld Standardwert ein.

Beispiel – Kunden hinzufügen

In diesem Beispiel wird der angegebene Kunde der Entität Customer hinzugefügt.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wähle Customer aus der Entity-Liste 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 das Feld Default Value ein:
    {
    "FirstName": "Test",
    "LastName": "Customer5"
    }

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

    {
    "Id": 6448083206296
    }

Beispiel: Eintrag in „Rabattcode“ erstellen

In diesem Beispiel wird ein neuer Datensatz in der Entität DiscountCode erstellt.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wähle DiscountCode aus der Entity-Liste 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 das Feld Default Value ein:
    {
    "PriceRuleId": 1.394097291568E12,
    "Code": "FREESHIP2025798"
    }

    Bei Ausführung dieses Beispiels wird eine ähnliche Antwort wie die in der Ausgabevariable connectorOutputPayload der Connector-Aufgabe eingeben:

    {
    "Id": 1.97836790828E13,
    "PriceRuleId": null
    }

Beispiel – Eintrag in Pricerule erstellen

In diesem Beispiel wird ein neuer Datensatz in der Entität Pricerule erstellt.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie in der Liste Entity die Option Pricerule aus.
  3. Wählen Sie den Vorgang Create aus und klicken Sie auf Fertig.
  4. Klicken Sie im Abschnitt Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Default Value:
    {
    "Id": 7.13459564696E11,
    "AllocationMethod": "each",
    "CustomerSelection": "all",
    "TargetType": "line_item",
    "UsageLimit": 100.0,
    "Title": "DP_PriceRule"
    }

    Wenn Sie dieses Beispiel ausführen, wird eine Antwort wie die folgende zurückgegeben: in der Ausgabevariable connectorOutputPayload der Connector-Aufgabe:

    {
    "Id": 197836790834,
    "PriceRuleId": null
    }

Beispiel: Datensatz in „ProductVariant“ erstellen

In diesem Beispiel wird ein neuer Datensatz in der Entität ProductVariant erstellt.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie in der Liste Entity die Option ProductVariant 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 das Feld Default Value ein:
    {
    "Id": 1070325065,
    "ProductId": 7652181016728,
    "ImageId": null,
    "Price": 1,
    "CompareAtPrice": null,
    "Title": "Yellow",
    "Barcode": null,
    "FulfillmentService": "manual",
    "InventoryManagement": "shopify",
    "InventoryPolicy": "deny",
    "InventoryQuantity": 1070325069,
    "Option1": "Yellow",
    "Option2": null,
    "Option3": null,
    "Position": 5,
    "Sku": "",
    "Taxable": true
    }

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

    {
    "Id": 42711984373912
    }

Beispiel – Kundendaten aktualisieren

In diesem Beispiel werden die Details des angegebenen Kunden in der Entität Customer aktualisiert.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wähle Customer aus der Entity-Liste aus.
  3. Wählen Sie den Vorgang Update aus und klicken Sie auf Fertig.
  4. Klicken Sie im Abschnitt Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Default Value:
    {
    "FirstName": "Test",
    "LastName": "Customer2"
    }
  5. Geben Sie die Entitäts-ID des Kunden ein, den Sie löschen möchten.

    Führen Sie im Abschnitt Task Input der Aufgabe Connectors die folgenden Schritte aus: klicken Sie auf entityId und geben Sie dann 648400653532 ein das Feld Standardwert.

    Anstelle der entityId können Sie auch die filterClause auf 648400653532 festlegen.

    Wenn Sie dieses Beispiel ausführen, wird in Ihrem Connector eine Antwort wie die folgende zurückgegeben: der connectorOutputPayload-Ausgabevariable der Aufgabe:

    {
    "Id": 648400653532
    }

Beispiel: Datensatz in „ProductVariant“ aktualisieren

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

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wähle ProductVariant aus der Entity-Liste 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 das Feld Default Value ein:
    {
    "ProductId": 7.652181016728E12,
    "ImageId": null,
    "Price": 200.0,
    "CompareAtPrice": null,
    "Title": "Yellow Updated",
    "Barcode": null,
    "FulfillmentService": "manual",
    "InventoryManagement": "shopify",
    "InventoryQuantity": 1.070325069E9,
    "Option1": "Yellow new",
    "Option2": null,
    "Option3": null,
    "Position": 5.0,
    "Sku": "",
    "Taxable": true
    }
  5. Geben Sie die Entitäts-ID des zu aktualisierenden Eintrags an.

    Klicken Sie zum Festlegen der Entitäts-ID auf entityId und geben Sie dann 34601602744472 in das Feld Standardwert ein.

    Wenn Sie dieses Beispiel ausführen, wird in Ihrem Connector eine Antwort wie die folgende zurückgegeben: der connectorOutputPayload-Ausgabevariable der Aufgabe:

    {
    "Id": 2484258073471
    }

Verbindungen mit Terraform erstellen

Sie können die Terraform-Ressource verwenden, um eine neue Verbindung zu erstellen.

Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle.

Eine Beispiel-Terraform-Vorlage zum Erstellen einer Verbindung 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
max_points_per_call STRING Falsch Gibt an, wie viele Punkte ein Anruf kostet.
schema_v23 ENUM Falsch Geben Sie die Shopify-Serverversion an, zu der eine Verbindung hergestellt werden soll. Unterstützte Werte: REST-2023-04, REST-2023-07, GRAPHQL-2023-04, GRAPHQL-2023-07
proxy_enabled BOOLEAN Falsch Klicken Sie dieses Kästchen an, um einen Proxyserver für die Verbindung zu konfigurieren.
proxy_auth_scheme ENUM Falsch Der Authentifizierungstyp, der für die Authentifizierung beim ProxyServer-Proxy verwendet werden soll. 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 VERTRAULICH Falsch Ein Passwort, das zur Authentifizierung beim ProxyServer-Proxy verwendet werden soll.
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

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