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
In diesem Connector werden die Shopify Admin APIs als relationale Datenbank modelliert.
Hinweise
Führen Sie vor der Verwendung des Shopify-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. 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 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.
Eine Liste aller unterstützten Regionen finden Sie unter Standorte.
- Tippen Sie auf 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 Shopify 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 49 Zeichen haben.
- Geben Sie optional unter Beschreibung eine Beschreibung für die Verbindungsinstanz ein.
- Optional können Sie Cloud Logging aktivieren und dann eine Logebene auswählen. Die Logebene ist standardmäßig auf
Error
festgelegt. - Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
- 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.
- Maximale Anzahl von Punkten pro Anruf: Gibt an, wie viele Punkte ein Anruf kostet.
- Schema: Geben Sie die Shopify-Serverversion an, mit der eine Verbindung hergestellt werden soll.
- Optional: Wählen Sie im Abschnitt Erweiterte Einstellungen das Kästchen Proxy verwenden aus, um einen Proxyserver für die Verbindung zu konfigurieren, und konfigurieren Sie die folgenden Werte:
-
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-Nutzer: 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 die URL eine HTTPS-URL ist, wird die Tunnel-Option verwendet. Wenn die URL eine HTTP-URL ist, wird die Option „NIE“ verwendet.
- Immer: 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 wird über den Proxy hin- und hergeleitet.
- Geben Sie im Abschnitt Proxyserver die Details des Proxyservers ein.
- Klicken Sie auf + Ziel hinzufügen.
- 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 Backend-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.
- Hostadresse: Geben Sie den Hostnamen oder die IP-Adresse des Ziels an.
- Klicken Sie optional auf + LABEL HINZUFÜGEN, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
- Tippen 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: Wählen Sie einen Zieltyp aus.
- Wenn Sie den Zielhostnamen oder die Ziel-IP-Adresse angeben möchten, wählen Sie Hostadresse aus und geben Sie die Adresse in das Feld Host 1 ein.
- Wenn Sie eine private Verbindung herstellen möchten, wählen Sie Endpunktanhang aus und wählen Sie den erforderlichen Anhang 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.
- Tippen Sie auf Weiter.
- Zieltyp: Wählen Sie einen Zieltyp aus.
- Geben Sie im Abschnitt Authentifizierung die Details zum Zugriffstoken an.
- Tippen Sie auf Weiter.
- Überprüfen: Prüfen Sie Ihre Verbindungs- und Authentifizierungsdetails.
- Klicken Sie auf Erstellen.
Zugriffstoken und API-Anmeldedaten erstellen
- Melden Sie sich im Shopify-Konto an.
- Klicken Sie im Shopify-Entwicklerportal auf Settings (Einstellungen).
- Wählen Sie Apps und Vertriebskanäle > Apps entwickeln aus.
- Klicken Sie auf App erstellen.
- Geben Sie im angezeigten Dialogfeld den Namen Ihrer App ein und klicken Sie auf Erstellen.
- Klicken Sie auf der Seite Übersicht auf Admin-API-Bereiche konfigurieren und wählen Sie die Zugriffsberechtigungen für Ihre App aus.
- Klicken Sie auf Speichern.
- Wählen Sie auf der Seite API-Anmeldedaten die Option App installieren aus.
- Klicken Sie im angezeigten Dialogfeld auf Installieren.
- Wählen Sie auf der Seite API Credentials (API-Anmeldedaten) die Option Reveal token once (Token einmalig anzeigen) aus und kopieren Sie das API Admin Access Token (API-Administratorzugriffstoken) zur späteren Verwendung, wenn Sie die Authentifizierung für die Verbindung konfigurieren.
- Kopieren Sie aus den Feldern API-Schlüssel und Geheimer API-Schlüssel die Schlüssel zur späteren Verwendung, wenn Sie die Authentifizierung für die Verbindung konfigurieren.
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 diese 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.
Beispiele für Entitätsvorgänge
Beispiel: Alle Produkte auflisten
In diesem Beispiel werden alle Datensätze in der Entität Products
aufgelistet.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie
Products
aus der ListeEntity
aus. - Wählen Sie den Vorgang
List
aus und klicken Sie auf Fertig.
Beispiel: Kundendetails abrufen
In diesem Beispiel werden die Details des angegebenen Kunden aus der Customers
-Entität abgerufen.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie
Customers
aus der ListeEntity
aus. - Wählen Sie den Vorgang
Get
aus und klicken Sie auf Fertig. - 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: Bestellaufzeichnung löschen
In diesem Beispiel wird die angegebene Bestellung aus der Order
-Entität gelöscht.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie
Order
aus der ListeEntity
aus. - Wählen Sie den Vorgang
Delete
aus und klicken Sie auf Fertig. - Geben Sie die Entitäts-ID der Bestellung ein, die 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 Customer
-Einheit hinzugefügt.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie
Customer
aus der ListeEntity
aus. - Wählen Sie den Vorgang
Create
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in FeldDefault Value
ein:{ "FirstName": "Test", "LastName": "Customer5" }
Wenn Sie dieses Beispiel ausführen, wird in der Ausgabevariable
connectorOutputPayload
der Connector-Aufgabe eine Antwort ähnlich der folgenden zurückgegeben:{ "Id": 6448083206296 }
Beispiel: Datensatz in DiscountCode erstellen
In diesem Beispiel wird ein neuer Datensatz in der DiscountCode
-Entität erstellt.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie
DiscountCode
aus der ListeEntity
aus. - Wählen Sie den Vorgang
Create
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das FeldDefault Value
ein:{ "PriceRuleId": 1.394097291568E12, "Code": "FREESHIP2025798" }
Wenn Sie dieses Beispiel ausführen, wird in der Ausgabevariable
connectorOutputPayload
der Connector-Aufgabe eine Antwort ähnlich der folgenden zurückgegeben:{ "Id": 1.97836790828E13, "PriceRuleId": null }
Beispiel: Einen Eintrag in Pricerule erstellen
In diesem Beispiel wird ein neuer Datensatz in der Pricerule
-Entität erstellt.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie
Pricerule
aus der ListeEntity
aus. - Wählen Sie den Vorgang
Create
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in FeldDefault Value
ein:{ "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 ähnlich der folgenden in der Ausgabevariablen
connectorOutputPayload
der Connector-Aufgabe zurückgegeben:{ "Id": 197836790834, "PriceRuleId": null }
Beispiel: Datensatz in „ProductVariant“ erstellen
In diesem Beispiel wird ein neuer Datensatz in der ProductVariant
-Entität erstellt.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie
ProductVariant
aus der ListeEntity
aus. - Wählen Sie den Vorgang
Create
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in FeldDefault 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 Ausgabevariable
connectorOutputPayload
der Connector-Aufgabe eine Antwort ähnlich der folgenden zurückgegeben:{ "Id": 42711984373912 }
Beispiel: Kundendaten aktualisieren
In diesem Beispiel werden die Details des angegebenen Kunden in der Customer
-Entität aktualisiert.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie
Customer
aus der ListeEntity
aus. - Wählen Sie den Vorgang
Update
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in FeldDefault Value
ein:{ "FirstName": "Test", "LastName": "Customer2" }
- Geben Sie die Entitäts-ID des Kunden ein, den Sie löschen möchten.
Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf entityId und geben Sie dann
648400653532
in das Feld Standardwert ein.Anstelle der entityId können Sie auch die filterClause auf
648400653532
festlegen.Wenn Sie dieses Beispiel ausführen, wird in der Ausgabevariable
connectorOutputPayload
der Connector-Aufgabe eine Antwort ähnlich der folgenden zurückgegeben:{ "Id": 648400653532 }
Beispiel: Datensatz in „ProductVariant“ aktualisieren
In diesem Beispiel wird ein Datensatz in der Entität ProductVariant
aktualisiert.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie
ProductVariant
aus der ListeEntity
aus. - Wählen Sie den Vorgang
Update
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in FeldDefault 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 }
- Geben Sie die Entitäts-ID des zu aktualisierenden Datensatzes 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 der Ausgabevariable
connectorOutputPayload
der Connector-Aufgabe eine Antwort ähnlich der folgenden zurückgegeben:{ "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.
Ein Beispiel für eine Terraform-Vorlage zum Erstellen einer Verbindung finden Sie hier.
Wenn Sie diese Verbindung mit Terraform erstellen, müssen Sie die folgenden Variablen in Ihrer Terraform-Konfigurationsdatei 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, mit 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 | Aktivieren Sie dieses Kästchen, 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 | SECRET | 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: AUTO, ALWAYS, NEVER, TUNNEL |
Shopify-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.
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
- Verbindung anhalten und fortsetzen
- Informationen zum Überwachen der Connector-Nutzung
- Connector-Logs ansehen