Komma igång med kod

Du kommer att lära dig

Lär dig mer om kod och hur du skapar anpassade funktioner som körs direkt av Klaviyo.

Koden kräver anpassad utveckling och Klaviyo:s supportteam kan inte erbjuda praktisk hjälp. Om du inte har en utvecklare i ditt team och inte är bekväm med att skriva kod själv, överväg att kontakta en Klaviyo-partner för hjälp.

Innan du börjar

Vad är kod?

Med kod kan du utföra anpassade funktioner som svar på händelser samla in i Klaviyo. Du kan skriva dina egna Javascript- eller Python-funktioner i kodredigeraren, och de körs sedan direkt i plattformen.

Med kod kan du skicka data till dina externa system utan att behöva konfigurera en publik HTTP-slutpunkt för att ta emot webhooks, och bygga anpassad funktionalitet som utlöses som svar på en händelses inträffande. Du kan också få tillgång till många populära förbyggda moduler som gör det lättare att skapa anpassade lösningar.

Ämnen

Med Code kan du köra anpassade funktioner som svar på alla händelser som kan efterfrågas via API:et Get Events.

Dessa inkluderar:

• e-posthändelser (t.ex. klickad e-post, markerad e-post som skräppost )
• sms-händelser (t.ex. skickade sms, mottagna sms)
• pushnotis-händelser (t.ex. Mottagen pushnotis, Studsad pushnotis)
• Händelser från integrerare (dvs. händelser från förstapartsintegrerare som skapats av Klaviyo)
• API händelser (dvs. händelser som synkroniserats via Klaviyo:s API)

Kodgränssnitt

För att komma åt koden, navigera till fliken Kod under Avancerad Klaviyo Data Platform > data Management > Kod. 

Om du vill skapa en anpassad funktion väljer du knappen Skapa en funktion:

Du kommer till sidan Recipes , där du antingen kan välja en förbyggd lösning att köra, eller en tom Python- eller Node.js-funktion.

Om du väljer ett befintligt recept visas kodredigeraren med koden för lösningen, tillsammans med en beskrivning av funktionaliteten. 

Om du väljer en tom funktion så att du kan skapa dina egna anpassade lösningar visas Details-modalen där du kan göra det:

• Namnge din funktion
  Ett namn för att identifiera din funktion.
• Välj ett ämne för din funktion
  Den händelse som kommer att utlösa din kods exekvering .
• Välj en runtime
  Den runtime-miljö som koden exekveras i (t.ex. Python eller Node.js).

När du har gjort de nödvändiga valen och valt funktionsknappen Create kommer du till ett gränssnitt med följande flikar: 

• Redaktör 
• Testutgång 
• Loggar

Tilldela behörigheter

Första gången du skapar en funktion via Code uppmanas du att autentisera Code OAuth-applikationen. Detta är nödvändigt för att dina kodfunktioner ska kunna komma åt data på ditt Klaviyo Konto.

När du har beviljat åtkomst kommer du till kodredigeraren.

Redigerare

På sidan Editor i Code delas sidan in i tre flikar:

• Kod
  Kodfliken har en editor där du kan skriva Python- eller Javascript-funktioner.
• Moduler
  Moduler är tredjepartspaket som lägger till funktionalitet i dina funktioner.
• Miljövariabler
  Miljövariabler är de nyckel-värdepar som din funktion kommer åt när den körs. 

Kod

På fliken Code ser du en editor som du kan använda för att skriva Python- eller Javascript-funktioner som körs som svar på det valda ämnet.

Parametrar för hanterarfunktionen

För att Klaviyo ska kunna utföra den kod du skriver måste den förpackas i en funktion som heter "handler" och som accepterar 2 parametrar:

• Händelse
  Består av händelsen data som är kopplad till den utlösande händelsen i JSON:API -format. Om utlösaren inte är händelsebaserad (t.ex. Added to lista) kommer värdet på denna parameter att vara None eller Null beroende på språk.
• Sammanhang
  Innehåller ytterligare metadata om funktionsutförandet, inklusive den profil som är kopplad till funktionsinkallningen. Du kan komma åt profilobjektet via context. profil i Javascript eller context["profil" ] i Python.

Nedan visas exempel på de händelse- och kontextparametrar som skickas till hanterarfunktionen.

Exempel på händelseformat

{
 {
 "data" : {
 " type": "event",
 " id": "7S2q9haejYG",
 " attributes": {
 " tidsstämpel": 1694435729,
 " event_properties": {
        "MfaEnabled": false,
        "IpAddress": "000.00.0.0",
        "UserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36",
        "UserRole": "Owner",
        "SessionId": "34sh0a9nh8ngnk2nfacjxmt592yx40ib",
        "LoginType": "Username_password",
        "current_company_id": "XXXXX",
        "$event_id": "1694435729"
      },
 " datetime": "2023-09-11 12:35:29+00:00",
 " uuid": "b0b8fe80-509f-11ee-8001-278cc529fcd3"
 },
 " relationships": {
 profildata" : {
          "type": "profile",
          "id": "123456"
        },
 " länkar": {
          "self": "https://a.klaviyo.com/api/events/7S2q9haejYG/relationships/profile/",
          "related": "https://a.klaviyo.com/api/events/7S2q9haejYG/profile/"
        }
      },
 " mättal": {
 "data" : {
          "type": "metric",
          "id": "4Tdup6"
        },
 " länkar": {
          "self": "https://a.klaviyo.com/api/events/7S2q9haejYG/relationships/metric/",
          "related": "https://a.klaviyo.com/api/events/7S2q9haejYG/metric/"
        }
      }
    },
 " länkar": {
      "self": "https://a.klaviyo.com/api/events/7S2q9haejYG/"
    }
  }
}

Exempel på format för sammanhang 

{
 " company_id": "XXXXX",
 " trigger": {"type": "event", "uid": "123456"},
 " function_id": "123456",
}

Moduler

På fliken Modules kan du välja bland de mest populära förbyggda modulerna (dvs. tredjepartspaket som lägger till funktioner i dina funktioner). 

Om du vill lägga till en extern modul som ska användas i din kod väljer du knappen Add module:

I modalrutan som visas kan du söka och välja den modul du vill lägga till: 

När du har lagt till modulen kan du använda den med den kod du skriver i Klaviyo.

från klaviyo_api importera KlaviyoAPI
importera os
def handler(händelse, sammanhang):
  Klaviyo = KlaviyoAPI(api_key=os.getenv("KLAVIYO_API_KEY"))
  print(Klaviyo.mättal.get_metrics())

importör Klaviyo

def handler(händelse, sammanhang):
  print(Klaviyo.mättal.get_metrics())

importera { Metrics } från 'Klaviyo';
export default async (event, context) => {
  console.log(await Metrics.getMetrics())
}

Miljövariabler 

På fliken Miljövariabler kan du ställa in nyckelvärdepar som din kod i Klaviyo kan referera till när den körs. Dessa kan användas för att lagra information som inloggningsuppgifter och hemliga nycklar så att dina funktioner kan komma åt dem när de körs. 

Om du vill lägga till en miljövariabel klickar du på knappen Lägg till en variabel: 

I modalrutan som visas kan du ange ett nyckelvärdepar för din miljövariabel. 

När miljövariablerna har skapats visas de på sidan och kan användas i din kod. 

Testutdata

På fliken Test output i Code kan du testa din kod med aktuella händelser för att bekräfta att utdata beter sig som förväntat. 

För att testa din funktion:

1. Välj knappen Kör test:
   
2. I modalrutan som visas väljer du en händelse att testa med. Du kan välja bland de 10 senaste händelserna samla in i Klaviyo.
   
3. När du har valt en händelse att testa med visas testresultatet:

Loggar

Fliken Loggar visar hur det går för dina pågående kodfunktioner. Du kommer att få se:

• Status
  Hur långt en funktion har kommit i sitt utförande. 
• Svarstid
  Den tid det tar för din kod att exekvera som svar på en händelse.
• Datum
  En tidsstämpel för när funktionen utfördes. 

Gränsvärden för priser

Klaviyo-koden har följande hastighetsgränser:

• Timeout för funktioner
  Funktioner i kod kan utföras i upp till 15 sekunder innan de timeoutas.
• Begränsning av funktionens hastighet
  Funktioner i Code tillåter upp till 25 samtidiga körningar per funktion.

Distribuera kod 

För att distribuera koden som du skriver i redigeraren, växla statusrullgardinsmenyn till Live. 

När du har satt igång kommer koden du skriver att exekveras varje gång ämneshändelsen samlas in i Klaviyo.

Exempel på lösning

Nedan visas ett exempel på en anpassad lösning som implementerats med Code.

I exemplet är eventet data inställt som profilegenskaper så att det kan användas i riktad e-post och i segmentering. Den anpassade händelsen Booked shoot samlas in i Klaviyo när kund bokar en fotografering med varumärket, och data om bokningsstaden och tillhörande URL anges som profilegenskaper på respektive profil.

En egenskap som heter Recent bookings skapas också, som butik data från de 5 senaste Booked shoot-händelserna så att den kan loopas igenom och nås i en e-postmallar.

Kod

Python-koden för den här lösningen skrivs i kodredigeraren och körs direkt av Klaviyo.

Exempel på kod

Moduler

I detta exempel används den inbyggda Klaviyo modul används. Modulen Klaviyo är beroende av att modulen Klaviyo-API läggs till i funktionen. När du har lagt till modulen Klaviyo kommer modulen att hantera autentisering åt dig, så ingen API-nyckel behövs.

Miljövariabler

Miljövariabler kan användas för att lagra information som autentiseringsuppgifter och hemliga nycklar så att dina funktioner kan komma åt dem när de körs. I det här exemplet anges följande nyckel-värdepar:

• MAX_EGENSKAPER_ATT_LAGRA
  En miljövariabel som används för att definiera det maximala antalet egenskaper som ska lagras för exempelfunktionen.

Testning

När du skapar funktionen för att ställa in händelsen data som profilegenskaper används fliken Testutdata för att verifiera den förväntade utdata.

Loggar

När funktionen har skapats och testats visar fliken Loggar funktionens hälsostatus när den körs som svar på händelser i samband med bokad skjutning . 

Utfall

Med denna kodfunktion på plats, när kund Registrera gräver efter fotograferingar och utlöser den anpassade händelsen Bokad fotografering, kommer händelsen data att butik på kundprofilen för användning i segmentering och riktade kampanjer. 

Implementering av recept  

Recept i kod gör att du kan implementera färdiga lösningar utan behov av anpassad utveckling.

För att implementera ett recept i din Klaviyo Konto:

1. Välj knappen Skapa funktion på kodsidan.
2. Välj det recept som du vill implementera i ditt Konto. Du kommer till redigeraren där du kan se koden för det valda receptet, tillsammans med en beskrivning av vad funktionen gör.
3. Klicka på knappen Välj för att fortsätta.
   
4. Välj ett namn för funktionen och den trigger som ska få den att exekvera. Körtiden ställs in automatiskt baserat på koden för receptet.
5. Välj funktionsknappen Skapa.
6. När funktionen har skapats ställer du in de relevanta miljövariablerna så att funktionen har de data den behöver för att köras.
7. Receptet kan nu testas och ställas in på Live.

Ytterligare resurser 

Komma igång med avancerad Klaviyo Data Platform
Förstå de olika webhook som finns tillgängliga i Klaviyo