Shopify Query-Aktivität in Jitterbit Studio

Einführung

Eine Shopify Query-Aktivität verwendet ihre Shopify-Verbindung und fragt angegebene Objektdaten von Shopify ab. Sie ist als Quelle gedacht, um Daten in einem Vorgang bereitzustellen.

Ratenlimits

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

Erstellen einer Shopify Query-Aktivität

Eine Instanz einer Shopify Query-Aktivität wird aus einer Shopify-Verbindung mit ihrem Query-Aktivitätstyp erstellt.

Um eine Instanz einer Aktivität zu erstellen, ziehen Sie den Aktivitätstyp auf die Design-Canvas oder kopieren Sie den Aktivitätstyp und fügen Sie ihn auf der Design-Canvas ein. Weitere Informationen finden Sie unter Erstellen einer Aktivitäts- oder Tool-Instanz in Komponentenwiederverwendung.

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

• Die Design-Canvas (siehe Komponentenaktionsmenü in Design-Canvas).
• Die Registerkarte Komponenten des Projektbereichs (siehe Komponentenaktionsmenü in Projektbereich-Registerkarte Komponenten).

Konfigurieren einer Shopify Query-Aktivität

Führen Sie diese Schritte aus, um eine Shopify Query-Aktivität zu konfigurieren:

• Schritt 1: Geben Sie einen Namen ein und wählen Sie ein Objekt aus
  Geben Sie einen Namen für die Aktivität ein und wählen Sie das Objekt aus, das die abzufragenden Daten enthält.

• Schritt 2: Wählen Sie ein Unterobjekt aus
  Wählen Sie ein Unterobjekt aus.

• Schritt 3: Überprüfen Sie die Datenschemas
  Alle vom Endpunkt generierten Request- oder Response-Schemas werden angezeigt.

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

Geben Sie in diesem Schritt einen Namen für die Aktivität ein und wählen Sie das Objekt aus, das die abzufragenden Daten enthält. Jedes Benutzeroberflächenelement dieses Schritts wird nachfolgend beschrieben.

• Endpunkt-Menü: Wenn mehrere Endpunkte desselben Connector-Typs konfiguriert sind, wird oben auf dem Bildschirm ein Menü mit dem aktuellen Endpunktnamen angezeigt. Klicken Sie auf das Menü, um zu einem anderen Endpunkt zu wechseln. Weitere Informationen finden Sie unter Zugewiesenen Endpunkt ändern in Konfigurationsbildschirme.

  • Endpunkt bearbeiten: Wird angezeigt, wenn Sie den Mauszeiger über den aktuellen Endpunktnamen bewegen. Klicken Sie, um die Verbindungskonfiguration 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 Bereich zeigt im Shopify-Endpunkt verfügbare Objekte an.

  • Ausgewähltes Objekt: Nach der Auswahl eines Objekts wird es hier aufgelistet.

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

• Aktualisieren: Klicken Sie auf das Aktualisierungssymbol oder auf 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 in der Konfiguration angezeigten Objekttabelle verwendet werden.

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

  • Name: Der Name des Shopify-Objekts.

  • Beschreibung: Die Beschreibung des Shopify-Objekts.

• Speichern und beenden: 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 zu wechseln. Die Konfiguration wird erst gespeichert, wenn Sie auf die Schaltfläche Fertig im letzten Schritt klicken.

• Änderungen verwerfen: Klicken Sie nach dem Vornehmen von Änderungen, um die Konfiguration zu schließen, ohne die in einem beliebigen Schritt vorgenommenen Änderungen zu speichern. Eine Meldung fordert Sie auf zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Schritt 2: Ein Unterobjekt auswählen

Wählen Sie in diesem Schritt ein Unterobjekt aus. Jedes Benutzeroberflächenelement dieses Schritts wird nachfolgend beschrieben.

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

  • 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 beliebigen Spalte in das Suchfeld ein, um die Liste der Unterobjekte zu filtern. Bei der Suche wird nicht zwischen Groß- und Kleinschreibung unterschieden. Wenn Unterobjekte bereits in der Tabelle angezeigt werden, werden die Tabellenergebnisse mit jedem Tastendruck in Echtzeit 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 Aktualisierungssymbol oder auf 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 in der Konfiguration angezeigten Unterobjekttabelle verwendet werden.

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

    • Name: Der Name des Shopify-Unterobjekts.

    • Beschreibung: Die Beschreibung des Shopify-Unterobjekts.

• 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 zu wechseln. Die Konfiguration wird erst gespeichert, wenn Sie auf die Schaltfläche Fertig im letzten Schritt klicken.

• Änderungen verwerfen: Klicken Sie nach dem Vornehmen von Änderungen, um die Konfiguration zu schließen, ohne die in einem beliebigen Schritt vorgenommenen Änderungen zu speichern. Eine Meldung fordert Sie auf zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Schritt 3: Die Datenschemas überprüfen

Alle vom Endpunkt generierten Request- oder Response-Schemas werden angezeigt. Jedes Benutzeroberflächenelement dieses Schritts wird nachfolgend beschrieben.

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

• Wenn limit gesetzt ist (maximal 250), gibt die Aktivität eine Seite mit Ergebnissen zurück, die der Abfrage entsprechen. - Die Anzahl der zurückgegebenen Ergebnisse pro Seite entspricht dem limit. - Wenn die Gesamtzahl der Ergebnisse das limit überschreitet, können Sie manuell zu benachbarten Seiten navigieren und diese verarbeiten, indem Sie die Werte Token_next_page oder Token_previous_page im Feld page_info in nachfolgenden Anfragen verwenden. - Wenn limit nicht gesetzt ist, fügt die Aktivität automatisch alle Seiten mit Ergebnissen zusammen, die der Abfrage entsprechen, und gibt diese als Antwort zurück.

  Weitere Informationen zu den Feldern `limit` und `page_info` des Request-Schemas finden Sie in [Shopifys Paginierungsdokumentation](https://shopify.dev/docs/api/usage/pagination-rest).
  

  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 Endpunkten können die verfügbaren Objekte und Unterobjekte unterschiedlich sein. Informationen zu den Schema-Knoten und Feldern finden Sie in der API-Dokumentation.

  Wichtig

  Shopify veröffentlicht alle drei Monate eine neue API-Version und unterstützt jede Version mindestens zwölf Monate lang. Sobald eine API-Version veraltet ist, wird Shopify diese Version nicht mehr unterstützen, und alle API-Aufrufe, die diese Version anfordern, werden automatisch zur ältesten derzeit unterstützten stabilen Version weitergeleitet.

  Shopify kann bestimmte Endpunkte als veraltet kennzeichnen, wenn eine neue API-Version eingeführt wird. Daher müssen Sie möglicherweise Ihre Apps und Aktivitätskonfigurationen aufgrund von geänderten oder eingestellten Funktionen anpassen.

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

• Aktualisieren: Klicken Sie auf das Aktualisierungssymbol oder das Wort Aktualisieren, um Schemas vom Shopify-Endpunkt neu zu generieren. Diese Aktion generiert auch ein Schema an anderen Stellen im Projekt neu, an denen auf dasselbe Schema verwiesen wird, z. B. in einer benachbarten Transformation.

• Bearbeiten: Klicken Sie auf das Bearbeitungssymbol über dem Response-Datenschema, um den Editor zu öffnen. Der Editor ermöglicht es Ihnen, Knoten und Felder hinzuzufügen, zu löschen und neu zu organisieren sowie deren Datentypen zu ändern. Alle neu hinzugefügten Knoten und Felder werden auf [0, 1] Kardinalität gesetzt. Änderungen an den Datenschemas müssen vom Endpunkt akzeptabel sein und sollten nur nach Rücksprache mit der verfügbaren Dokumentation für den Endpunkt vorgenommen werden. Nach der Bearbeitung von Schemas wird oben im betreffenden Schema ein Datum der letzten Bearbeitung angezeigt, um anzuzeigen, dass das Schema manuell bearbeitet wurde. Das Aktualisieren der Schemas setzt diese 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: Klicken Sie nach dem Vornehmen von Änderungen, um die Konfiguration zu schließen, ohne Änderungen an einem Schritt zu speichern. Eine Meldung fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Nächste Schritte

Nach der Konfiguration einer Shopify-Aktivität Abfrage schließen Sie die Konfiguration des Vorgangs ab, indem Sie weitere Aktivitäten oder Tools als Vorgangsschritte hinzufügen und konfigurieren. Sie können auch die Vorgangseinstellungen konfigurieren, die die Möglichkeit bieten, Vorgänge zu verketten, die sich in denselben oder verschiedenen Workflows befinden.

Menüaktionen für eine Aktivität sind über den Projektbereich und die Design-Canvas zugänglich. Weitere Informationen finden Sie unter Aktionsmenü für Aktivitäten in Connector-Grundlagen.

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

Um die Aktivität mit Scripting-Funktionen zu verwenden, schreibe die Daten an einen temporären Speicherort und verwende diesen temporären Speicherort dann in der Scripting-Funktion.

Wenn alles bereit ist, stelle die Operation bereit und führe sie aus und validiere das Verhalten durch Überprüfung der Operationsprotokolle.