API-översikt för modeller

Med API:t för modeller, som även kallas API för Blockeringslista, kan användare visa och hantera listan med funktioner som används i maskininlärningsmodeller för Automated Personalization (AP) och Auto-Target (AT) verksamhet. Om en användare vill utesluta en funktion från att användas av modellerna för AP- eller AT-aktiviteter kan de använda API:t för modeller för att lägga till den funktionen i blockeringslista.

A blocklist definierar den uppsättning funktioner som kommer att exkluderas av Adobe Target från sina maskininlärningsmodeller. Mer information om funktioner finns i Data som används av Target maskininlärningsalgoritmer.

Blockeringslista kan definieras per aktivitet (aktivitetsnivå) eller för alla aktiviteter inom en Target konto (global nivå).

API-specifikation för modeller

Visa Models API-specifikationen här.

Förutsättningar

Om du vill använda API:t för modeller måste du konfigurera autentisering med Adobe Developer Console, precis som med API för måladministratör. Mer information finns i Konfigurera autentisering.

Riktlinjer för användning av API-modeller

Hantera blockeringslista

Steg 1: Visa en lista över funktioner för en aktivitet

Steg 2: Kontrollera aktivitetens blockeringslista

Steg 3: Lägg till funktioner till blockeringslista i aktiviteten

Steg 4: (Valfritt) Avblockera

Steg 5: (Valfritt) Hantera den globala blockeringslista

Steg 1: Visa lista med funktioner för en aktivitet step1

Innan du blocklist en funktion ska du visa en lista över funktioner som för närvarande ingår i modellerna för den aktiviteten.

Begäran
code language-json line-numbers
GET https://mc.adobe.io/<tenant>/target/models/features/<campaignId>
Svar
code language-json line-numbers
{
    "features": [
        {
            "externalName": "Visitor Profile - Total Visits to Activity",
            "internalName": "SES_PREVIOUS_VISIT_COUNT",
            "type": "CONTINUOUS"
        },
        {
            "externalName": "Visitor Profile - Total Visits",
            "internalName": "SES_TOTAL_SESSIONS",
            "type": "CONTINUOUS"
        },
        {
            "externalName": "Visitor Profile - Pages Seen Before Activity",
            "internalName": "SES_PREVIOUS_VISIT_COUNT",
            "type": "CONTINUOUS"
        },
        {
            "externalName": "Visitor Profile - Activity Lifetime Time on Site",
            "internalName": "SES_TOTAL_TIME",
            "type": "CONTINUOUS"
        }
    ],
    "reportParameters": {
        "clientCode": <tenant>,
        "campaignId": <campaignId>
    }
}

I exemplet som visas här kontrollerar användaren om det finns en lista över funktioner som används i modellen för aktiviteten vars aktivitets-ID är 260840.

Steg 1

NOTE
Navigera till listan Aktiviteter i dialogrutan Target Gränssnitt. Klicka på aktiviteten. Aktivitets-ID visas i texten på sidan Översikt över aktiviteter, samt i slutet av URL:en för sidan.

The externalName är ett användarvänligt namn för en funktion. Den har skapats av Targetoch det är möjligt att det här värdet kan ändras över tid. Användare kan visa dessa användarvänliga namn i Rapport om personaliseringsinsikter.

The internalName är funktionens faktiska identifierare. Den har också skapats av Target, men den kan inte ändras. Detta är det värde som du måste referera till för att identifiera de funktioner som du vill blocklist.

Observera, att en aktivitet krävs för att funktionslistan ska innehålla värden (det vill säga för att den ska vara icke-null):

  1. Måste ha status = Live eller ha aktiverats tidigare
  2. Måste ha körts tillräckligt länge för att det ska finnas kampanjaktiviteter, så att modellen har haft data att köra mot.

Steg 2: Kontrollera aktivitetens blockeringslista step2

Visa sedan blockeringslista. Kontrollera med andra ord vilka funktioner, om några, som för närvarande blockeras från att inkluderas i modellerna för den här aktiviteten.

ERROR
Observera att /blockList/ är skiftlägeskänsligt i begäran.
Begäran
code language-json line-numbers
GET https://mc.adobe.io/<tenant>/target/models/features/blockList/<campaignId>
Svar
code language-json line-numbers

I exemplet som visas här kontrollerar användaren listan över blockerade funktioner för aktiviteten vars aktivitets-ID är 260840. Resultatet är tomt, vilket innebär att den här aktiviteten inte har några blocklist funktioner.

Steg 2

NOTE
Du kan se tomma resultat som detta, första gången du kontrollerar hela blockeringslista, innan du lägger till några funktioner i den. När du har lagt till (och sedan tagit bort) funktioner från en blockeringslista kan du dock se något annorlunda resultat, där en tom blocklist funktionsarray returneras. Fortsätt läsa för att se ett exempel på detta i Steg 4.

Steg 3: Lägg till funktioner till blockeringslista i aktiviteten step3

Om du vill lägga till funktioner i blockeringslista ändrar du begäran från GET till PUT och ändrar texten i begäran för att ange blockedFeatureSources eller blockedFeatures efter behov.

  • Innehållet i begäran kräver antingen blockedFeatures eller blockedFeatureSources. Båda kan inkluderas.
  • Fylla blockedFeatures med värden som identifieras av internalName. Se Steg 1.
  • Fylla blockedFeatureSources med värden från tabellen nedan.

Observera att blockedFeatureSources anger varifrån en funktion kommer. När du blocklist fungerar de som grupper eller kategorier av funktioner, som gör att användare kan blockera hela uppsättningar med funktioner samtidigt. Värdena för blockedFeatureSources matchar de första tecknen i en funktions identifierare (blockedFeatures eller internalName värden), och därför kan de också betraktas som"funktionsprefix".

Tabell över blockedFeatureSources values table

Prefix
Beskrivning
RUTA
Mbox-parameter
URL
Anpassad - URL-parameter
ENV
Miljö
SE
Besökarprofil
GEO
Geo-plats
PRO
Anpassad - profil
SEG
Anpassad - Rapporteringssegment
AAM
Anpassad - Experience Cloud-segment
MOB
Mobil
CRS
Anpassad - kundattribut
UPA
Anpassad - RT-CDP-profilattribut
IAC
Intresseområden för besök
Begäran
code language-json line-numbers
PUT https://mc.adobe.io/<tenant>/target/models/features/blockList/<campaignId>

{
    "blockedFeatureSources": ["AAM"],
    "blockedFeatures": ["SES_PREVIOUS_VISIT_COUNT", "SES_TOTAL_SESSIONS"]
}
Svar
code language-json line-numbers
{
    "blockedFeatures": [
            "SES_PREVIOUS_VISIT_COUNT",
            "SES_TOTAL_SESSIONS"
        ],
    "blockedFeatureSources": [
            "AAM"
        ]
}

I exemplet som visas här blockerar användaren två funktioner, SES_PREVIOUS_VISIT_COUNT och SES_TOTAL_SESSIONSsom de tidigare identifierade genom att fråga en fullständig lista över funktioner för aktiviteten vars aktivitets-ID är 260480, enligt beskrivningen i Steg 1. De blockerar också alla funktioner som kommer från Experience Cloud-segment, vilket uppnås genom att blockera funktioner med prefixet"AAM", vilket beskrivs i table ovan.

Steg 3

Observera att när du har blocklist en funktion bör du verifiera den uppdaterade blockeringslista genom att utföra Steg 2 igen (GET blockeringslista). Kontrollera att resultatet visas som förväntat (kontrollera att resultatet innehåller de funktioner som lagts till från senaste PUT-begäran).

Steg 4: (valfritt) Avblockera step4

Om du vill ta bort alla blocklist funktioner tar du bort värdena från blockedFeatureSources eller blockedFeatures.

Begäran
code language-json line-numbers
PUT https://mc.adobe.io/<tenant>/target/models/features/blockList/<campaignId>

{
    "blockedFeatureSources": [],
    "blockedFeatures": []
}
Svar
code language-json line-numbers
{
    "blockedFeatures": [],
    "blockedFeatureSources": []
}

I exemplet som visas här rensar användaren blockeringslista för aktiviteten vars aktivitets-ID är 260840. Observera att svaret bekräftar tomma arrayer för både blockerade funktioner och deras källor -blockedFeatureSources och blockedFeatures, respektive

Steg 4

När du har ändrat blockeringslista bör du som alltid utföra Steg 2 igen (GET blockeringslista för att verifiera att listan innehåller funktioner som förväntat). I exemplet som visas här bekräftar användaren att blockeringslista nu är tom.

Steg 4b

Fråga: Hur tar jag bort vissa, men inte alla, av ett blockeringslista?

Svar: Om du vill ta bort en separat delmängd av blocklist funktioner från en blockeringslista med flera funktioner kan användare helt enkelt skicka den uppdaterade listan över funktioner som de vill blockera i begäran från blockeringslistatill skillnad från att rensa hela blockeringslista och lägga till de önskade funktionerna igen. Skicka med andra ord den uppdaterade funktionslistan (som visas i Steg 3) och se till att de funktioner som du vill ta bort inte finns med i blockeringslista.

Steg 5: (Valfritt) Hantera den globala blockeringslista step5

Exemplen ovan var alla i samband med en enda aktivitet. Du kan också blockera funktioner för alla aktiviteter för en viss klient (klientorganisation) i stället för att behöva ange blockeringslista för varje aktivitet separat. Om du vill utföra en global blockeringslista använder du /blockList/global ring i stället för blockList/<campaignId>.

Begäran
code language-json line-numbers
PUT https://mc.adobe.io/<tenant>/target/models/features/blockList/global

{
    "blockedFeatureSources": ["AAM", "PRO", "ENV"],
    "blockedFeatures": ["AAM_FEATURE_1", "AAM_FEATURE_2"]
}
Svar
code language-json line-numbers
{
    "blockedFeatures": [
        "AAM_FEATURE_1",
        "AAM_FEATURE_2"
    ],
    "blockedFeatureSources": [
        "AAM",
        "PRO",
        "ENV"
    ]
}

I exemplet med begäran ovan blockerar användaren två funktioner, "AAM_FEATURE_1" och "AAM_FEATURE_2", för alla aktiviteter i Target konto. Det innebär, oavsett aktivitet, att "AAM_FEATURE_1" och "AAM_FEATURE_2" inte kommer att inkluderas i datorutbildningsmodellerna för det här kontot. Dessutom blockerar användaren globalt alla funktioner vars prefix är"AAM","PRO" eller"ENV".

Fråga: Är inte kodexemplet ovan överflödigt?

Svar: Ja. Det är överflödigt att blockera funktioner med värden som börjar med"AAM", samtidigt som alla funktioner vars källa är"AAM" blockeras. Nettoresultatet är att alla funktioner som kommer från AAM (Experience Cloud Segments) blockeras. Om målet är att blockera alla funktioner från Experience Cloud-segment är det därför onödigt att ange vissa funktioner som börjar med"AAM" separat, i exemplet ovan.

Slutligt steg: Oavsett om du arbetar på aktivitets- eller global nivå rekommenderar vi att du kontrollerar blockeringslista efter att du har ändrat den, så att den innehåller de värden du förväntar dig. Gör detta genom att ändra PUT till GET.

Provsvaret som visas nedan indikerar Target blockerar två enskilda funktioner, plus alla funktioner som kommer från"AAM","PRO" och"ENV".

Steg 5

recommendation-more-help
6906415f-169c-422b-89d3-7118e147c4e3