API-tilläggets TikTok för webbhändelser - översikt

Händelse-API:t TikTok är ett säkert Edge Network Server-API som gör att du kan dela information med TikTok direkt om användaråtgärder på dina webbplatser. Du kan utnyttja reglerna för vidarebefordran av händelser för att skicka data från Adobe Experience Platform Edge Network till TikTok med hjälp av API-tillägget TikTok för webbhändelser.

Krav för TikTok prerequisites

Om du vill konfigurera TikTok-webbhändelseAPI:t så att det använder TikTok-händelse-API:t måste du generera en TikTok pixelkod och komma åt token.

Du måste ha en giltig TikTok för företagskonto för att kunna skapa en TikTok pixel med partnerkonfigurationen. Gå till sidan TikTok för företagsregistrering om du vill registrera dig och skapa ett konto om du inte redan har ett.

Du måste vara inloggad på ditt företagskonto för att kunna konfigurera TikTok pixlar med partnerkonfiguration. Gör så här:

  1. Navigera till fliken Assets och välj Event.
  2. Välj Manage under Webbhändelser.
  3. Välj Set Up Web Events.
  4. Välj Partner Setup som anslutningsmetod.

Mer information om hur du ställer in pixeln TikTok finns i guiden Kom igång med Pixel .

Du kan generera en åtkomsttoken när pixeln har skapats. Om du vill göra det går du till pixeln och väljer fliken Settings. Välj Generate Access Token under Händelse-API.

Mer information om hur du konfigurerar pixelkoden och får åtkomst till token finns i TikTok Komma igång-guiden.

Installera och konfigurera API-tillägget för TikTok-webbhändelser install

Om du vill installera tillägget väljer du Extensions i den vänstra navigeringen. Markera TikTok Web Events API Extension på fliken Catalog och välj sedan Install.

Tilläggskatalogen som visar installationen av TikTok tilläggskort.

På nästa skärm anger du följande konfigurationsvärden som du tidigare har genererat från TikTok Ads Manager:

  • Pixel Code
  • Access Token

När du är klar väljer du Save.

TikTok konfigurationsskärm för API-tillägget TikTok för webbhändelser.

Konfigurera en regel för vidarebefordran av händelser config-rule

När alla dataelement har konfigurerats kan du börja skapa regler för vidarebefordran av händelser som avgör när och hur händelser skickas till TikTok.

Skapa en ny regel i egenskapen för vidarebefordran av händelser. Under Actions lägger du till en ny åtgärd och anger tillägget till TikTok Web Events API Extension. Om du vill skicka Edge Network-händelser till TikTok anger du Action Type till Send TikTok Web Events API Event.

Åtgärdstypen Send TikTok Web Events API Event som väljs för en TikTok-regel i användargränssnittet för datainsamling.

Efter markeringen visas ytterligare kontroller för att ytterligare konfigurera händelsen enligt instruktionerna nedan. När du är klar väljer du Keep Changes för att spara regeln.

Web Events and Parameters

Webbhändelser och parametrar innehåller allmän information om händelsen. Standardhändelser stöds i alla TikTok-integreringsverktyg och kan användas för att rapportera, optimera för konverteringar och skapa målgrupper.

Indata
Beskrivning
Händelsenamn
Namnet på händelsen. Det här är åtgärder med fördefinierade namn skapade av TikTok och är ett obligatoriskt fält. Mer information om händelser som stöds finns i dokumentationen för TikTok Marketing API.
Händelsetid
Datum-tid som sträng i ISO 8601 eller i formatet yyyy-MM-dd'T'HH:mm:ss:SSSZ. Detta är ett obligatoriskt fält.
Händelse-ID
Det unika ID som genereras av annonsörer för att ange varje händelse. Det här är ett valfritt fält och används för borttagning av dubbletter.

Avsnittet Web Events and Parameters som visar exempeldata i fälten.

User Context Parameters

Parametrar för användarkontext innehåller kundinformation som används för att matcha webbbesökshändelser med TikTok användare. Genom att ta med flera typer av matchande data kan ni öka noggrannheten i målinriktning och optimeringsmodeller.

Indata
Beskrivning
IP-adress
Webbläsarens offentliga IP-adress som inte hashats. Stöd ges för IPv4- och IPv6-adresser. Både fullständiga och komprimerade former av IPv6-adresser känns igen.
Användaragent
Den icke-hash-kodade användaragenten från användarens enhet.
E-post
E-postadress till den kontakt som är associerad med konverteringshändelsen.
Telefon
Telefonnumret måste vara i E164-format [+][landskod][riktnummer][local phone number] innan hashning utförs.
Cookie-ID
Om du använder Pixel SDK sparas automatiskt en unik identifierare i _ttp-cookien, om cookies är aktiverade. Värdet _ttp kan extraheras och användas för det här fältet.
Externt ID
Alla unika identifierare, till exempel användar-ID:n, externa cookie-ID:n och så vidare, måste hash-kodas med SHA256.
TikTok Click ID
ttclid som läggs till i URL:en för landningssidan varje gång en annons väljs TikTok.
Sidans URL
Sidans URL vid tidpunkten för händelsen.
URL för sidreferens
URL för sidreferenten.

Avsnittet User Context Parameters som visar exempeldata i fälten.

Properties Parameters

Använd egenskapsparametrarna för att konfigurera ytterligare egenskaper som stöds.

Indata
Beskrivning
Pris
Kostnaden för en enstaka artikel.
Kvantitet
Antalet artiklar som köpts i händelsen. Detta måste vara ett positivt tal större än 0.
Innehållstyp
Värdet product eller product_group måste tilldelas objektegenskapen content_type, beroende på hur du konfigurerar dataflödet när du konfigurerar produktkatalogen.
Innehålls-ID
En unik identifierare för produktartikeln.
Innehållskategori
Sidans/produktens kategori.
Innehållsnamn
Namn på sidan/produkten.
Valuta
Valutan för de artiklar som köps in i händelsen. Detta anges i ISO-4217.
Värde
Orderns totala pris. Det här värdet är lika med priset * kvantitet.
Beskrivning
En beskrivning av objektet eller sidan.
Fråga
Den textsträng som användes för att söka efter en produkt.
Status
Status för en order, artikel eller tjänst. Till exempel"skickat".

Avsnittet Properties Parameters som visar exempeldata i fälten.

Borttagning av händelser deduplication

TikTok pixel måste vara konfigurerad för borttagning av dubbletter om du använder både TikTok pixel SDK och TikTok API-tillägget för webbhändelser för att skicka samma händelser till TikTok.

Deduplicering krävs inte om distinkta händelsetyper skickas från klienten och servern utan någon överlappning. Om du vill vara säker på att din rapportering inte påverkas negativt måste du se till att alla enskilda händelser som delas av TikTok pixel-SDK och API-tillägget för TikTok-webbhändelser dedupliceras.

När du skickar delade händelser måste du se till att alla händelser innehåller ett pixel-ID, händelse-ID och namn. Duplicerade händelser som kommer inom fem minuter från varandra sammanfogas. Om datafältet inte fanns med i den första händelsen kombineras det med den efterföljande händelsen. Alla dubbletthändelser som tas emot inom 48 timmar tas bort.

Mer information om den här processen finns i TikTok-dokumentationen om händelseborttagning.

Nästa steg

I den här guiden beskrivs hur du skickar händelsedata på serversidan till TikTok med API-tillägget för webbhändelser i TikTok. Mer information om funktioner för vidarebefordran av händelser i Adobe Experience Platform finns i översikten över vidarebefordran av händelser.

recommendation-more-help
12b4e4a9-5028-4d88-8ce6-64a580811743