Adobe Target Bulk Profile Update API
Met Adobe Target Bulk Profile Update API kunt u gebruikersprofielen voor meerdere bezoekers van een website in bulk bijwerken met behulp van een batchbestand.
Met de Bulk Profile Update API kunt u eenvoudig gedetailleerde gegevens van het bezoekersprofiel in de vorm van profielparameters voor veel gebruikers naar Target verzenden vanuit een externe bron. Externe bronnen kunnen systemen van het Beheer van de Verhouding van de Klant (CRM) of van het Verkooppunt (POS) omvatten, die gewoonlijk niet op een Web-pagina beschikbaar zijn.
http://CLIENTCODE.tt.omtrdc.net/m2/CLIENTCODE/profile/batchUpdatehttp://CLIENTCODE.tt.omtrdc.net/m2/CLIENTCODE/v2/profile/batchUpdate- Profiel maken indien niet gevonden.
- Status per rij bijwerken.
-
Als uw Target -implementatie Experience Cloud ID (ECID) gebruikt als een van de profiel-id's voor anonieme bezoekers, gebruikt u
pcIdniet als de sleutel in een batchbestand van versie 2 (v2). Het gebruik vanpcIdmet v2 van Bulk Profile Update API is alleen bedoeld voor zelfstandige Target implementaties die niet afhankelijk zijn van ECID. -
Als in uw implementatie ECID wordt gebruikt voor profielidentificatie en u
pcIdwilt gebruiken als de sleutel in het batchbestand, gebruikt u versie 1 (v1) van de API. -
Als uw implementatie
thirdPartyIdgebruikt voor profielidentificatie, gebruikt u versie 2 (v2) van de API metthirdPartyIdals sleutel.
Voordelen van de Bulk Profile Update API
- Geen limiet voor het aantal profielkenmerken.
- Profielkenmerken die via de site worden verzonden, kunnen via de API worden bijgewerkt en omgekeerd.
Caveats
- Het batchbestand moet kleiner zijn dan 50 MB. Bovendien mag het totale aantal rijen niet groter zijn dan 500.000 rijen per upload.
- Updates vinden meestal plaats binnen een uur, maar het kan 24 uur duren voordat ze worden gereflecteerd.
- Er is geen limiet voor het aantal rijen dat of de rijen die u kunt uploaden over een periode van 24 uur in volgende batches. Nochtans, zou het innameproces tijdens kantooruren kunnen worden vertraagd om ervoor te zorgen dat andere processen efficiënt lopen.
- Opeenvolgende v2 vraag van de partijupdate zonder mbox vraag binnen tussen voor zelfde thirdPartyIds treedt de eigenschappen met voeten die in de eerste vraag van de partijupdate worden bijgewerkt.
- Adobe garandeert niet dat 100% van de gegevens van het batchprofiel in Target wordt gecontroleerd en bewaard en dus beschikbaar is voor gebruik bij het zoeken naar gegevens. In het huidige ontwerp bestaat de mogelijkheid dat een klein percentage gegevens (tot 0,1% van de grote productiepartijen) niet wordt opgetekend of bewaard.
Batchbestand
Als u profielgegevens bulksgewijs wilt bijwerken, maakt u een batchbestand. Het batchbestand is een tekstbestand met waarden gescheiden door komma's die lijken op het volgende voorbeeldbestand.
\ batch=pcId,param1,param2,param3,param4\ 123,value1\ 124,value1,value4\ 125,value2\ 126,value1,value2,value3,value4\
batch= is vereist en moet aan het begin van het bestand worden opgegeven.U verwijst dit bestand in de POST-aanroep naar Target servers om het bestand te verwerken. Houd rekening met het volgende wanneer u het batchbestand maakt:
- In de eerste rij van het bestand moeten kolomkoppen worden opgegeven.
- De eerste header moet een
pcIdofthirdPartyIdzijn. Marketing Cloud visitor ID wordt niet ondersteund. pcId is een door Target gegenereerde bezoeker-id.thirdPartyIdis een id die door de clienttoepassing is opgegeven en die via een mbox-aanroep als Target aanmbox3rdPartyIdwordt doorgegeven. U moet hier naar dit item verwijzen alsthirdPartyId. - Parameters en waarden die u in het batchbestand opgeeft, moeten uit veiligheidsoverwegingen URL-gecodeerd zijn met UTF-8. Parameters en waarden kunnen naar andere randknooppunten worden doorgestuurd voor verwerking door HTTP-aanvragen.
- De parameters mogen alleen de notatie
paramNamehebben. Parameters worden weergegeven in Target alsprofile.paramName. - Als u Bulk Profile Update API v2 gebruikt, hoeft u niet alle parameterwaarden voor elke
pcIdop te geven. Profielen worden gemaakt voorpcIdofmbox3rdPartyIddie niet worden gevonden in Target . Als u v1 gebruikt, worden er geen profielen gemaakt voor ontbrekende pcIds of mbox3rdPartyIds. Voor meer informatie, zie Behandelend lege waarden in Bulk Profile Update API hieronder. - Het batchbestand moet kleiner zijn dan 50 MB. Bovendien mag het totale aantal rijen niet groter zijn dan 500.000. Deze limiet zorgt ervoor dat servers niet overstroomd raken met te veel verzoeken.
- U kunt meerdere bestanden verzenden. Het totaal van de rijen van alle bestanden die u op een dag verzendt, mag echter niet hoger zijn dan 1 miljoen voor elke client.
- Er is geen beperking op het aantal kenmerken dat u kunt uploaden. De totale grootte van de externe profielgegevens, die klantkenmerken, profiel-API, In-Mbox-profielparameters en profielscriptuitvoer bevatten, mag echter niet groter zijn dan 64 kB.
- Parameters en waarden zijn hoofdlettergevoelig.
HTTP POST-aanvraag
Voer een HTTP POST-aanvraag in bij Target Edge-servers om het bestand te verwerken. Hier volgt een voorbeeld van een HTTP POST-aanvraag voor het bestand batch.txt met de opdracht curl:
\ curl -X POST --data-binary @BATCH.TXT http\://CLIENTCODE.tt.omtrdc.net/m2/CLIENTCODE/v2/profile/batchUpdate\
Waarbij:
BATCH.TXT is de bestandsnaam. CLIENTCODE is de Target clientcode.
Als u de clientcode niet kent, klikt u in de Target gebruikersinterface op Administration > Implementation . De clientcode wordt weergegeven in de sectie Account Details .
De reactie controleren
De API voor profielen retourneert de verzendstatus van de batch voor verwerking samen met een koppeling onder "batchStatus" voor een andere URL die de algemene status van de specifieke batchtaak weergeeft.
Voorbeeld-API-reactie
De volgende code die is uitgesneden, is een voorbeeld van een API-reactie voor profielen:
<response>
<success>true</success>
<batchStatus>http://mboxedge45.tt.omtrdc.net/m2/demo/profile/batchStatus?batchId=demo-1701473848678-13029383</batchStatus>
<message>Batch submitted for processing</message>
</response>
Als er een fout is, bevat de reactie success=false en een gedetailleerd bericht voor de fout.
Standaardbatchstatusreactie
Een succesvol standaardantwoord wanneer op de bovenstaande batchStatus URL-koppeling wordt geklikt, ziet er als volgt uit:
<response><batchId>demo4-1701473848678-13029383</batchId><status>complete</status><batchSize>1</batchSize></response>
De verwachte waarden voor de statusvelden zijn:
Gedetailleerde batchstatus URL-reactie
Een gedetailleerdere reactie kan worden opgehaald door een parameter showDetails=true door te geven aan de bovenstaande batchStatus url.
Bijvoorbeeld:
http://mboxedge45.tt.omtrdc.net/m2/demo/profile/batchStatus?batchId=demo-1701473848678-13029383&showDetails=true
Gedetailleerde respons
<response>
<batchId>demo4-1701473848678-13029383</batchId>
<status>complete</status>
<batchSize>1</batchSize>
<consumedCount>1</consumedCount>
<successfulUpdates>1</successfulUpdates>
<profilesNotFound>0</profilesNotFound>
<failedUpdates>0</failedUpdates>
</response>
Lege waarden verwerken in de Bulk Profile Update API empty
Wanneer u Target Bulk Profile Update API (v1 of v2) gebruikt, is het belangrijk dat u begrijpt hoe het systeem lege parameter- of kenmerkwaarden verwerkt.
Verwacht gedrag
Als u lege waarden ("", null of ontbrekende velden) verzendt voor bestaande parameters of kenmerken, worden deze waarden niet opnieuw ingesteld of verwijderd in het profielarchief. Dit is door ontwerp.
-
Lege waarden worden genegeerd: De API filters uit lege waarden tijdens verwerking om onnodige of betekenisloze updates te vermijden.
-
geen ontruiming van bestaande gegevens: Als een parameter reeds een waarde heeft, verlaat het verzenden van een lege waarde het onveranderd.
-
leeg-slechts partijen worden overgeslagen: Als een partij slechts lege of ongeldige waarden bevat, wordt het volledig genegeerd en geen updates worden toegepast.
Aanvullende opmerkingen
Dit gedrag is van toepassing op zowel v1 als v2 van de Bulk Profile Update API .
Wanneer u probeert een kenmerk te wissen of te verwijderen door een lege waarde te verzenden, heeft dit geen effect.
Ondersteuning voor het expliciet verwijderen van kenmerken is gepland voor een toekomstige versie (v3) van de API, maar is momenteel niet beschikbaar.