Predogled podatkov API-ja, uporabljenih v aplikaciji Shopify Flow

Večina potekov dela dostopa do podatkov iz vaše trgovine, tako da jih lahko uporabite v pogojih in dejanjih. Shopify Flow do podatkov trgovine dostopa s klicanjem vmesnika GraphQL Admin API, kar vam omogoča dostop do skoraj vseh polj v API-ju.

Ko ustvarjate potek dela, boste pogosto naleteli na imena polj in opise, ki temeljijo na API-ju, vendar boste morda morali poznati tudi vrednosti teh podatkov. Morda boste na primer želeli izvedeti ime aplikacije za naročilo, ki je bilo ustvarjeno iz osnutka naročila. Poleg tega se boste morda želeli prepričati, da vaš potek dela vrne pričakovane podatke oziroma podatke v pričakovani obliki.

Za pregled vrednosti podatkov imate v storitvi Shopify Flow na voljo več možnosti.

Poiščite polje v skrbniku Shopify

V večini primerov lahko podatke najdete tako, da preverite v skrbniku Shopify. Na primer, product.title je naveden na strani Izdelek.

Pridobite vzorčne podatke

Ko ustvarjate potek dela, lahko vzorčne podatke pridobite neposredno v urejevalniku storitve Flow. Ker podatki v storitvi Flow izvirajo iz dogodkov, morate za pridobitev natančnih vzorčnih podatkov najprej izbrati ustrezen dogodek:

1. V urejevalniku storitve Flow odprite dejanje, v katerem želite uporabiti podatke, in kliknite Dodaj spremenljivko. Lahko pa v pogoju kliknete Dodaj merila.
2. Kliknite Konfiguriraj vzorčne podatke.
3. Flow prikaže prejšnje dogodke na podlagi sprožilca poteka dela. Kliknite Osveži dogodke, da pridobite dogodke iz nedavnih zagonov, ali pa kliknite Začni poslušati dogodke v živo in nato ročno sprožite dogodek v skrbniku ali ustrezni aplikaciji (za sprožilce na podlagi aplikacij).
4. Ko se dogodek zgodi, bo Flow prikazal podrobnosti o njem. Izberite dogodek, ki ga želite uporabiti za pridobitev vzorčnih podatkov. Kliknite Uporabi ta sprožilni dogodek.
5. Zdaj se morajo med brskanjem po dogodkih prikazati vzorčni podatki za vsako spremenljivko.

Omejitve:

• Zaradi prostorskih omejitev bo Flow za podatke na seznamu prikazal le podatke iz prvega elementa na seznamu.
• Flow bo za posamezen potek dela hkrati shranil do 5 dogodkov.
• Flow za nekatere sprožilce ne more pridobiti dogodkov iz nedavnih zagonov. To velja na primer za sprožilce Načrtovan čas, Ustvarjen vnos metaobjekta, Stranka je dodana v segment ali Stranka je odstranjena iz segmenta.

Uporabite polje v aktivnem poteku dela

Polja lahko varno uporabljate v poteku dela s pomočjo dejanja Zabeleži izhod. Ko zaženete potek dela, bo dejanje Zabeleži izhod izpisalo izhod vseh spremenljivk in besedila na strani Zgodovina zagonov. Uporabite lahko tudi dejanja obveščanja, kot je Pošlji interno e-pošto.

Koraki za uporabo dejanja Zabeleži izhod:

1. Izberite sprožilec, ki ga lahko sprožite ročno.
2. V potek dela dodajte dejanje Zabeleži izhod in ga povežite s sprožilcem.
3. V konfiguraciji dejanja Zabeleži izhod kliknite Dodaj spremenljivko, da v razdelek Izhod dodate spremenljivke, ki jih želite pregledati.
4. Ko končate, kliknite Vklopi potek dela.
5. Sprožite potek dela tako, da ga zaženete ročno ali pa povzročite aktivacijo sprožilca. Če na primer uporabljate sprožilec Ustvarjeno naročilo, ustvarite testno naročilo.
6. Po izvedbi poteka dela v dnevniku dejavnosti preverite spremenljivke.

Oglejte si stran vira JSON

Večina strani virov v skrbniku Shopify, kot so strani Naročilo, Izdelek ali Stranka, omogoča ogled podatkov, ki služijo strani. Ti podatki nimajo popolnoma enakega poimenovanja in oblike, kot ju uporablja Shopify Flow, vendar se vrednosti ujemajo s tistimi v vmesniku GraphQL Admin API. Za ogled podatkov na konec URL-naslova dodajte .json.

Odprite na primer naročilo, tako da v skrbniku Shopify obiščete stran Naročila in kliknete izbrano naročilo. Naslov strani v naslovni vrstici brskalnika spremenite iz:

https://https://admin.shopify.com/store/<ime_trgovine>/orders/3804849891234

v naslednjega:

https://https://admin.shopify.com/store/<ime_trgovine>/orders/3804849891234.json

Opomba

Format .json sledi vmesniku REST API. Poimenovanje spremenljivk v vmesniku REST API uporablja podčrtaje, na primer line_items. GraphQL in Shopify Flow uporabljata zapis z velikimi začetnicami (camelCasing), na primer lineItems. Poleg tega se včasih imena polj razlikujejo, na primer properties namesto customAttributes. Preverite informacije, ki jih najdete s tem pristopom.

Uporabite GraphiQL ali orodje API zunanjega izvajalca

V API lahko pošljete neposredno poizvedbo z orodjem API zunanjega izvajalca, kot je Postman, ali z brezplačnim orodjem GraphiQL, ki ga ponuja Shopify. Ta možnost zagotavlja najbolj natančne rezultate, vendar zahteva nekaj poznavanja ustvarjanja poizvedb GraphQL.

Za GraphiQL ponuja Shopify tako spletni raziskovalec GraphiQL s splošnimi podatki kot aplikacijo GraphiQL. Z orodjem GraphiQL lahko zgradite poizvedbo GraphQL, ki se natančno ujema z imeni polj v storitvi Shopify Flow. Če uporabljate aplikacijo, se tudi vrednosti natančno ujemajo z vašo trgovino.

S tem orodjem lahko z uporabo dejanskih podatkov iz svoje trgovine natančno določite, katere podatke uporablja Shopify Flow. Ustvarite lahko na primer naslednjo poizvedbo:

{
  orders(first:5, reverse:true) {
    nodes {
      createdAt
      app {
        name
      }
      channelInformation {
        app {
          title
        }
      }
    }
  }
}

V naslednjih rezultatih spremenljivka order / app / name prikazuje ime aplikacije za naročilo. V tem primeru je bilo naročilo ustvarjeno iz aplikacije za osnutke naročil, zato je vrednost Draft Orders. Podatki o kanalu so na voljo samo za aplikacijo 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"
            }
          }
        }
      ]
    }
  }