Podgląd danych API używanych w Shopify Flow
Większość procesów uzyskuje dostęp do danych ze sklepu, dzięki czemu można ich używać w warunkach i akcjach. Aplikacja Shopify Flow uzyskuje dostęp do danych sklepu, wywołując GraphQL Admin API, co zapewnia dostęp do prawie wszystkich pól w API.
Podczas tworzenia workflow często napotkasz nazwy pól i opisy oparte na API, ale możesz chcieć poznać wartości tych danych. Na przykład możesz chcieć poznać nazwę aplikacji dla zamówienia, które zostało utworzone z wersji roboczej zamówienia. Ponadto możesz chcieć się upewnić, że Twój workflow zwraca oczekiwane dane lub że zwraca je w oczekiwanej formie.
Aby przejrzeć wartości danych, masz do dyspozycji kilka opcji w aplikacji Shopify Flow.
Na tej stronie
Znajdź pole w panelu administracyjnym Shopify
W większości przypadków dane można znaleźć, przeglądając panel administracyjny Shopify. Na przykład product.title znajduje się na stronie Produktu.
Pobierz przykładowe dane
Podczas tworzenia workflow możesz uzyskać przykładowe dane bezpośrednio w edytorze Flow. Ponieważ dane w aplikacji Flow pochodzą ze zdarzeń, w celu uzyskania dokładnych danych przykładowych musisz rozpocząć od wybrania odpowiedniego zdarzenia:
- W edytorze Flow otwórz akcję, w której chcesz użyć danych, i kliknij opcję Dodaj zmienną. Alternatywnie w warunku kliknij opcję Dodaj kryteria.
- Kliknij Skonfiguruj dane przykładowe.
- Aplikacja Flow wyświetla poprzednie zdarzenia na podstawie wyzwalacza workflow. Kliknij opcję Odśwież zdarzenia, aby pobrać zdarzenia z ostatnich przebiegów, lub kliknij opcję Rozpocznij nasłuchiwanie zdarzeń na żywo, a następnie ręcznie uruchom zdarzenie w panelu administracyjnym lub odpowiedniej aplikacji (w przypadku wyzwalaczy opartych na aplikacjach).
- Po wystąpieniu zdarzenia Flow wyświetli szczegóły na jego temat. Wybierz zdarzenie, którego chcesz użyć, aby uzyskać dane przykładowe. Kliknij opcję Użyj tego zdarzenia wyzwalającego.
- Teraz podczas przeglądania zdarzeń powinny być wyświetlane dane przykładowe dla każdej zmiennej.
Ograniczenia:
- Ze względu na ograniczenia przestrzenne w przypadku danych na liście aplikacja Flow wyświetli tylko dane z pierwszej pozycji na liście.
- Flow będzie przechowywać do 5 zdarzeń naraz dla każdego workflow.
- Flow nie może pobierać zdarzeń z ostatnich przebiegów dla niektórych wyzwalaczy, takich jak Zaplanowany czas, Utworzono wpis metaobiektu, Klient dołączył do segmentu lub Klient opuścił segment.
Użyj pola w aktywnym workflow
Możesz bezpiecznie używać pól w workflow, korzystając z akcji Rejestruj dane wyjściowe. Po uruchomieniu workflow akcja Rejestruj dane wyjściowe wydrukuje dane wyjściowe wszystkich zmiennych i tekstu na stronie Historia przebiegów. Możesz również użyć akcji powiadomień, takich jak Wyślij wewnętrzną wiadomość e-mail.
Kroki, aby użyć opcji Rejestruj dane wyjściowe:
- Wybierz wyzwalacz, który można uruchomić ręcznie.
- Dodaj akcję Rejestruj dane wyjściowe do workflow i połącz ją z wyzwalaczem.
- W konfiguracji Rejestruj dane wyjściowe kliknij opcję Dodaj zmienną, aby dodać zmienne, które chcesz sprawdzić, do sekcji Dane wyjściowe.
- Po zakończeniu kliknij opcję Włącz workflow.
- Uruchom workflow ręcznie lub poprzez aktywację wyzwalacza. Na przykład, jeśli używasz wyzwalacza Utworzono zamówienie, utwórz zamówienie testowe.
- Po uruchomieniu workflow sprawdź zmienne w dzienniku działania.
Skorzystaj ze strony zasobu w formacie JSON
Większość stron zasobów w panelu administracyjnym Shopify, takich jak strony Zamówienia, Produktu lub Klienta, pozwala na przeglądanie danych, które obsługują stronę. Nazwy i format tych danych nie są dokładnie takie same, jakich używa aplikacja Shopify Flow, ale wartości odpowiadają tym, które znajdują się w GraphQL Admin API. Aby przejrzeć dane, dodaj .json do adresu URL.
Na przykład przejdź do zamówienia, wchodząc w panelu administracyjnym Shopify na stronę Zamówienia i klikając zamówienie. W pasku adresu przeglądarki zmień adres strony z:
https://https://admin.shopify.com/store/<shopname>/orders/3804849891234
na:
https://https://admin.shopify.com/store/<shopname>/orders/3804849891234.json
Użyj narzędzia GraphiQL lub zewnętrznego narzędzia API
Możesz bezpośrednio wysyłać zapytania do API za pomocą zewnętrznego narzędzia API, takiego jak Postman, lub bezpłatnego narzędzia GraphiQL udostępnianego przez Shopify. Ta opcja zapewnia najdokładniejsze wyniki, ale wymaga pewnej znajomości tworzenia zapytań GraphQL.
W przypadku GraphiQL Shopify oferuje zarówno internetowy eksplorator GraphiQL z danymi ogólnymi, jak i aplikację GraphiQL. Za pomocą GraphiQL możesz utworzyć zapytanie GraphQL, które dokładnie odpowiada nazwom pól w Shopify Flow. Wartości również dokładnie pasują do Twojego sklepu, jeśli używasz aplikacji.
Korzystając z tego narzędzia, możesz dokładnie określić, jakich danych używa aplikacja Shopify Flow, z wykorzystaniem rzeczywistych danych Twojego sklepu. Na przykład tworzysz następujące zapytanie:
{
orders(first:5, reverse:true) {
nodes {
createdAt
app {
name
}
channelInformation {
app {
title
}
}
}
}
}W poniższych wynikach zmienna order / app / name wyświetla nazwę aplikacji dla zamówienia. W tym przypadku zamówienie zostało utworzone z aplikacji Zamówienia robocze, więc wartością jest Draft Orders. Informacje o kanale są dostępne tylko dla aplikacji Point of Sale.
{
"data": {
"orders": {
"nodes": [
{
"createdAt": "2023-04-10T12:32:41Z",
"app": {
"name": "Draft Orders"
},
"channelInformation": null
},
{
"createdAt": "2023-04-10T12:29:12Z",
"app": {
"name": "Draft Orders"
},
"channelInformation": null
},
{
"createdAt": "2023-03-17T20:23:10Z",
"app": {
"name": "Draft Orders"
},
"channelInformation": null
},
{
"createdAt": "2023-03-17T20:20:53Z",
"app": {
"name": "Draft Orders"
},
"channelInformation": null
},
{
"createdAt": "2023-03-17T15:45:15Z",
"app": {
"name": "Point of Sale"
},
"channelInformation": {
"app": {
"title": "Point of Sale"
}
}
}
]
}
}