Zum Inhalt springen

Shopify Abfrageaktivität in Jitterbit Studio

Einführung

Eine Shopify Abfrage-Aktivität, die ihre Shopify-Verbindung verwendet, fragt bestimmte Objektdaten von Shopify ab und ist dazu gedacht, als Quelle für Daten in einer Operation verwendet zu werden.

Hinweis

Die Abfrage-Aktivität gibt Objektdaten zurück, die in ihrem Anforderungsschema angegeben sind. Um alle Daten des ausgewählten Objekts abzurufen, verwenden Sie die Leseaktivität.

Ratenlimits

Die Shopify REST Admin API setzt ein Ratenlimit von 40 Anfragen pro App und pro Store und pro Minute durch. Dieses Kontingent wird mit einer Rate von 2 Anfragen pro Sekunde wieder aufgefüllt. Das Ratenlimit ist für Shopify Plus-Stores erhöht. Weitere Informationen zu den Ratenlimits finden Sie unter Shopify REST Admin API Ratenlimits.

Erstellen einer Shopify Abfrageaktivität

Eine Instanz einer Shopify Abfrage-Aktivität wird aus einer Shopify-Verbindung unter Verwendung ihres Abfrage-Aktivitätstyps erstellt.

Um eine Instanz einer Aktivität zu erstellen, ziehen Sie den Aktivitätstyp auf die Entwurfsfläche oder kopieren Sie den Aktivitätstyp und fügen Sie ihn auf der Entwurfsfläche ein. Für Details siehe Erstellen einer Aktivitäts- oder Toolinstanz in Komponentenwiederverwendung.

Eine vorhandene Shopify Abfrage-Aktivität kann von diesen Orten aus bearbeitet werden:

Konfigurieren einer Shopify Query-Aktivität

Befolgen Sie diese Schritte, um eine Shopify Query-Aktivität zu konfigurieren:

Schritt 1: Geben Sie einen Namen ein und wählen Sie ein Objekt aus

In diesem Schritt geben Sie einen Namen für die Aktivität ein und wählen das Objekt aus, das die abzufragenden Daten enthält. Jedes Benutzeroberflächenelement dieses Schrittes wird im Folgenden beschrieben.

  • Endpunktmenü: Wenn Sie mehrere Endpunkte des gleichen Verbindungstyps konfiguriert haben, wird ein Menü oben auf dem Bildschirm angezeigt, das den aktuellen Endpunktnamen anzeigt. Klicken Sie auf das Menü, um zu einem anderen Endpunkt zu wechseln. Weitere Informationen finden Sie unter Ändern des zugewiesenen Endpunkts in Konfigurationsbildschirmen.

    • Endpunkt bearbeiten: Wird angezeigt, wenn Sie über den aktuellen Endpunktnamen fahren. Klicken Sie, um die Verbindungsconfiguration des aktuell ausgewählten Endpunkts zu bearbeiten.

  • Name: Geben Sie einen Namen ein, um die Aktivität zu identifizieren. Der Name muss für jede Shopify Query-Aktivität eindeutig sein und darf keine Schrägstriche / oder Doppelpunkte : enthalten.

  • Wählen Sie ein Objekt aus: Dieser Abschnitt zeigt die in dem Shopify-Endpunkt verfügbaren Objekte an.

    • Ausgewähltes Objekt: Nachdem ein Objekt ausgewählt wurde, wird es hier aufgelistet.

    • Suche: Geben Sie den Wert einer Spalte in das Suchfeld ein, um die Liste der Objekte zu filtern. Die Suche ist nicht groß-/kleinschreibungsempfindlich. Wenn Objekte bereits in der Tabelle angezeigt werden, werden die Tabellenergebnisse in Echtzeit mit jedem Tastendruck gefiltert. Um Objekte beim Suchen erneut vom Endpunkt zu laden, geben Sie Suchkriterien ein und aktualisieren Sie dann, wie unten beschrieben.

    • Aktualisieren: Klicken Sie auf das Aktualisierungs-Icon oder das Wort Aktualisieren, um Objekte vom Shopify-Endpunkt neu zu laden. Dies kann nützlich sein, wenn Objekte zu Shopify hinzugefügt wurden. Diese Aktion aktualisiert alle Metadaten, die zum Erstellen der Tabelle der in der Konfiguration angezeigten Objekte verwendet werden.

    • Ein Objekt auswählen: Klicken Sie innerhalb der Tabelle auf eine beliebige Stelle in einer Zeile, um ein Objekt auszuwählen. Es kann nur ein Objekt ausgewählt werden. Die Informationen, die für jedes Objekt verfügbar sind, werden vom Shopify-Endpunkt abgerufen:

      • Name: Der Name des Shopify-Objekts.

      • Beschreibung: Die Beschreibung des Shopify-Objekts.

    Hinweis

    Wenn die Tabelle nicht mit verfügbaren Objekten gefüllt wird, könnte die Shopify-Verbindung nicht erfolgreich sein. Stellen Sie sicher, dass Sie verbunden sind, indem Sie die Verbindung erneut öffnen und die Anmeldeinformationen erneut testen.

  • Speichern & Beenden: Wenn aktiviert, klicken Sie, um die Konfiguration für diesen Schritt zu speichern und die Aktivitätskonfiguration zu schließen.

  • Weiter: Klicken Sie, um die Konfiguration für diesen Schritt vorübergehend zu speichern und zum nächsten Schritt fortzufahren. Die Konfiguration wird nicht gespeichert, bis Sie auf die Schaltfläche Fertig im letzten Schritt klicken.

  • Änderungen verwerfen: Nach Änderungen klicken Sie, um die Konfiguration zu schließen, ohne die vorgenommenen Änderungen zu speichern. Eine Nachricht fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Schritt 2: Wählen Sie ein Unterobjekt

In diesem Schritt wählen Sie ein Unterobjekt aus. Jedes Benutzeroberflächenelement dieses Schrittes wird im Folgenden beschrieben.

  • Ein Objekt auswählen: Dieser Abschnitt zeigt die im Shopify-Endpunkt verfügbaren Unterobjekte an.

    • Ausgewähltes Objekt: Das im vorherigen Schritt ausgewählte Objekt wird hier aufgelistet.

    • Ausgewähltes Unterobjekt: Nach der Auswahl eines Unterobjekts wird es hier aufgelistet.

    • Suche: Geben Sie den Wert einer Spalte in das Suchfeld ein, um die Liste der Unterobjekte zu filtern. Die Suche ist nicht groß-/kleinschreibungssensitiv. Wenn Unterobjekte bereits in der Tabelle angezeigt werden, werden die Tabellenergebnisse in Echtzeit mit jedem Tastendruck gefiltert. Um Unterobjekte vom Endpunkt beim Suchen neu zu laden, geben Sie Suchkriterien ein und aktualisieren Sie dann, wie unten beschrieben.

    • Aktualisieren: Klicken Sie auf das Aktualisierungsymbol oder das Wort Aktualisieren, um Unterobjekte vom Shopify-Endpunkt neu zu laden. Dies kann nützlich sein, wenn Unterobjekte zu Shopify hinzugefügt wurden. Diese Aktion aktualisiert alle Metadaten, die zum Erstellen der Tabelle der in der Konfiguration angezeigten Unterobjekte verwendet werden.

    • Auswählen eines Unterobjekts: Klicken Sie innerhalb der Tabelle auf eine beliebige Stelle in einer Zeile, um ein Unterobjekt auszuwählen. Es kann nur ein Unterobjekt ausgewählt werden. Die Informationen, die für jedes Unterobjekt verfügbar sind, werden vom Shopify-Endpunkt abgerufen:

      • Name: Der Name des Shopify-Unterobjekts.

      • Beschreibung: Die Beschreibung des Shopify-Unterobjekts.

    Hinweis

    Wenn die Tabelle nicht mit verfügbaren Unterobjekten gefüllt wird, könnte die Shopify-Verbindung nicht erfolgreich sein. Stellen Sie sicher, dass Sie verbunden sind, indem Sie die Verbindung erneut öffnen und die Anmeldeinformationen erneut testen.

  • Zurück: Klicken Sie, um die Konfiguration für diesen Schritt vorübergehend zu speichern und zum vorherigen Schritt zurückzukehren.

  • Weiter: Klicken Sie, um die Konfiguration für diesen Schritt vorübergehend zu speichern und zum nächsten Schritt fortzufahren. Die Konfiguration wird nicht gespeichert, bis Sie auf die Schaltfläche Fertig im letzten Schritt klicken.

  • Änderungen verwerfen: Nachdem Sie Änderungen vorgenommen haben, klicken Sie, um die Konfiguration zu schließen, ohne die Änderungen an einem Schritt zu speichern. Eine Nachricht fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Schritt 3: Überprüfen der Datenschemas

Alle Anforderungs- oder Antwortschemas, die vom Endpunkt generiert wurden, werden angezeigt. Jedes Benutzeroberflächenelement dieses Schrittes wird im Folgenden beschrieben.

  • Datenschemas: Diese Datenschemas werden von benachbarten Transformationen geerbt und während der Transformationszuordnung erneut angezeigt.

    Seitenumbruch

    Die Shopify Abfrage-Aktivität behandelt automatisch bestimmte Fälle von Seitenumbruch basierend auf dem limit-Feld im Anforderungsschema.

    • Wenn limit gesetzt ist (maximal auf 250), gibt die Aktivität eine Seite von Ergebnissen zurück, die der Abfrage als Antwort entsprechen.
      • Die Anzahl der für die Seite zurückgegebenen Ergebnisse entspricht dem limit.
      • Wenn die Gesamtanzahl der Ergebnisse das limit überschreitet, können Sie manuell navigieren und benachbarte Seiten verarbeiten, indem Sie die Werte Token_next_page oder Token_previous_page im page_info-Feld nachfolgender Anfragen verwenden.
    • Wenn limit nicht gesetzt ist, fügt die Aktivität automatisch alle Seiten von Ergebnissen, die der Abfrage entsprechen, hinzu und gibt sie als Antwort zurück.

    Für weitere Informationen zu den Feldern limit und page_info des Anfrage-Schemas siehe die Pagination-Dokumentation von Shopify.

    Der Shopify-Connector verwendet die Shopify REST Admin API in der Version, die in einer Shopify-Verbindung ausgewählt wurde. Je nach den von Shopify in der verwendeten API-Version unterstützten API-Endpunkten können die verfügbaren Objekte und Unterobjekte variieren. Siehe die API-Dokumentation für Informationen zu den Schema-Knoten und -Feldern.

    Wichtig

    Shopify veröffentlicht alle drei Monate eine neue API-Version und pflegt jede Veröffentlichungsversion mindestens zwölf Monate lang. Sobald eine API-Version als veraltet gilt, wird Shopify diese Version nicht mehr pflegen, und alle API-Aufrufe, die diese Version anfordern, werden automatisch auf die älteste derzeit unterstützte stabile Version umgeleitet.

    Shopify kann bestimmte Endpunkte veralten lassen, wenn eine neue API-Version eingeführt wird. Daher müssen Sie möglicherweise Ihre Apps und Aktivitätskonfigurationen aufgrund geänderter oder zurückgezogener Funktionen anpassen.

    Veraltete API-Versionen und Endpunkte werden im Änderungsprotokoll von Shopify angekündigt, wo weitere Details und relevante Migrationsinformationen verfügbar sind.

  • Aktualisieren: Klicken Sie auf das Aktualisierungs-Symbol oder das Wort Aktualisieren, um die Schemata vom Shopify-Endpunkt neu zu generieren. Diese Aktion regeneriert auch ein Schema an anderen Stellen im Projekt, wo dasselbe Schema referenziert wird, wie in einer angrenzenden Transformation.

  • Bearbeiten: Klicken Sie auf das Bearbeitungs-Symbol über dem Antwortdatenschema, um den Editor zu betreten. Der Editor ermöglicht es Ihnen, Knoten und Felder hinzuzufügen, zu löschen und neu anzuordnen sowie deren Datentypen zu ändern. Alle neu hinzugefügten Knoten und Felder sind auf [0, 1] Kardinalität eingestellt. Änderungen an den Datenschemata müssen für den Endpunkt akzeptabel sein und sollten nur nach Konsultation der verfügbaren Dokumentation für den Endpunkt vorgenommen werden. Nach dem Bearbeiten des Schemas wird ein Datum der letzten Bearbeitung oben im entsprechenden Schema angezeigt, um anzuzeigen, dass das Schema manuelle Änderungen erfahren hat. Das Aktualisieren der Schemata setzt die Schemata auf ihre Standardstrukturen zurück.

  • Zurück: Klicken Sie, um die Konfiguration für diesen Schritt vorübergehend zu speichern und zum vorherigen Schritt zurückzukehren.

  • Fertig: Klicken Sie, um die Konfiguration für alle Schritte zu speichern und die Aktivitätskonfiguration zu schließen.

  • Änderungen verwerfen: Nach Änderungen klicken Sie, um die Konfiguration zu schließen, ohne die Änderungen an einem Schritt zu speichern. Eine Nachricht fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Nächste Schritte

Nachdem Sie eine Shopify Abfrage-Aktivität konfiguriert haben, vervollständigen Sie die Konfiguration des Vorgangs, indem Sie andere Aktivitäten oder Werkzeuge als Vorgangsschritte hinzufügen und konfigurieren. Sie können auch die Vorgangseinstellungen konfigurieren, die die Möglichkeit umfassen, Vorgänge zusammenzuführen, die sich in denselben oder unterschiedlichen Workflows befinden.

Menüaktionen für eine Aktivität sind im Projektbereich und auf der Entwurfsgrafik zugänglich. Für Details siehe Aktivitätsaktionsmenü in Connector-Grundlagen.

Shopify Abfrage-Aktivitäten können als Quelle mit dem Zwei-Transformation-Muster verwendet werden (als die zweite Quelle nur).

Um die Aktivität mit Skriptfunktionen zu verwenden, schreiben Sie die Daten an einen temporären Ort und verwenden Sie dann diesen temporären Ort in der Skriptfunktion.

Wenn Sie bereit sind, bereitstellen und ausführen Sie den Vorgang und validieren Sie das Verhalten, indem Sie die Vorgangsprotokolle überprüfen.