Hybride personalisatie met Web SDK en Edge Network API

Overzicht overview

De hybride verpersoonlijking beschrijft het proces om verpersoonlijkingsinhoud server-kant terug te winnen, gebruikend Edge Network API, en het terug te geven cliënt-kant, gebruikend SDK van het Web.

U kunt hybride personalisatie met verpersoonlijkingsoplossingen zoals Adobe Target, Adobe Journey Optimizer, of Offer Decisioning gebruiken, het verschil is de inhoud van de Edge Network API lading.

Vereisten prerequisites

Controleer of u aan de volgende voorwaarden voldoet voordat u hybride personalisatie gaat implementeren op uw webeigenschappen:

Stroomdiagram flow-diagram

In het onderstaande stroomdiagram wordt de volgorde beschreven van de stappen die zijn genomen om hybride personalisatie te leveren.

Cookies cookies

Cookies worden gebruikt om de gebruikersidentiteit en clusterinformatie voort te zetten. Wanneer het gebruiken van een hybride implementatie, behandelt de de toepassingsserver van het Web het opslaan en verzenden van deze koekjes tijdens de verzoeklevenscyclus.

Verzoek om plaatsing request-placement

Edge Network API-aanvragen zijn vereist voor het ophalen van voorstellen en het verzenden van een weergavemelding. Wanneer u een hybride implementatie gebruikt, doet de toepassingsserver deze aanvragen aan de Edge Network API.

Oprichting van de regionale host van Edge Network regional-host

Als u de regionale Edge Network-host wilt instellen, leest u eerst de locatiehint in het kndctr_<orgId>_AdobeOrg_cluster -cookie, die de volgende waarden kan hebben:

Voorbeeld: kndctr_53A16ACB5CC1D3760A495C99_AdobeOrg_cluster: va6

De regionale gastheer van Edge Network gebruikt het volgende formaat:<location_hint>.server.adobedc.net en kan de volgende waarden hebben:

Door deze specifieke hosts te gebruiken, worden de aanvragen doorgestuurd naar dezelfde Edge Network-locatie die de gebruiker eerder heeft bezocht. Het systeem kan de beste ervaring bieden, aangezien de gebruikersgegevens daar aanwezig zijn.

Als er geen locatiehint (dus geen cookie) aanwezig is, gebruikt u de standaardhost: server.adobedc.net .

Analytische implicaties analytics

Bij het implementeren van hybride personalisatie moet u speciale aandacht besteden aan het tellen van pagina's in Analytics.

Wanneer u een gegevensstroomvoor Analytics vormt, door:sturen de gebeurtenissen automatisch zodat de paginareeksen worden gevangen.

Het voorbeeld van deze implementatie gebruikt twee verschillende gegevensstromen:

Op deze manier registreert de server-side aanvraag geen Analytics-gebeurtenissen, maar de client-side aanvragen wel. Dit leidt ertoe dat de verzoeken van de Analyse nauwkeurig worden geteld.

De serveraanvraag samenstellen server-side-request

De voorbeeldaanvraag hieronder illustreert een Edge Network API-aanvraag die uw toepassingsserver kan gebruiken om de personalisatie-inhoud op te halen.

API formaat

POST /ee/v2/interact

Verzoek request

curl -X POST "https://edge.adobedc.net/ee/v2/interact?dataStreamId={DATASTREAM_ID}"
-H "Content-Type: text/plain"
-d '{
   "event":{
      "xdm":{
         "web":{
            "webPageDetails":{
               "URL":"http://localhost/"
            },
            "webReferrer":{
               "URL":""
            }
         },
         "identityMap":{
            "FPID":[
               {
                  "id":"xyz",
                  "authenticatedState":"ambiguous",
                  "primary":true
               }
            ]
         },
         "timestamp":"2022-06-23T22:21:00.878Z"
      },
      "data":{

      }
   },
   "query":{
      "identity":{
         "fetch":[
            "ECID"
         ]
      },
      "personalization":{
         "schemas":[
            "https://ns.adobe.com/personalization/default-content-item",
            "https://ns.adobe.com/personalization/html-content-item",
            "https://ns.adobe.com/personalization/json-content-item",
            "https://ns.adobe.com/personalization/redirect-item",
            "https://ns.adobe.com/personalization/dom-action"
         ],
         "decisionScopes":[
            "__view__",
            "sample-json-offer"
         ]
      }
   },
   "meta":{
      "state":{
         "domain":"localhost",
         "cookiesEnabled":true,
         "entries": [{
           "key": "kndctr_53A16ACB5CC1D3760A495C99_AdobeOrg_identity",
           "value":"CiY0NzE0NzkwMTUyMzYzMzI4NDAxMjc3NDcwNzA2NTcxMjI3OTI1NVIRCJ_S-uCRMRABGAEqBElSTDHwAZ_S-uCRMQ=="
         }, {
           "key": "kndctr_53A16ACB5CC1D3760A495C99_AdobeOrg_consent",
           "value": "general=in"
         }, {
            "key": "kndctr_53A16ACB5CC1D3760A495C99_AdobeOrg_cluster",
            "value": "va6"
         }]
      }
   }
}'

Proxyheaders proxy-headers

De volgende kopballen worden vereist om het verzoek correct te verwerken.

Zorg ervoor dat u deze op de juiste wijze instelt om naar de werkelijke clientgegevens te verwijzen. De header X-Forwarded-For moet bijvoorbeeld de client-IP bevatten, zodat een juiste geolocatie kan plaatsvinden.

Kopteksten van gebruikersagent user-agent-headers

Gebruik de volgende gebruiker-agent kopballen om het verzoek correct te verwerken.

Gebrek

Lage entropie (verplicht):

Hoge entropie (facultatief):

Het verzoek moet worden verzonden zoals aangetoond in de Edge Network API specificatie. Zie de verpersoonlijkingsdocumentatieals uw gebruiksgeval het vereist.

Serverreactie server-response

Het Edge Network-antwoord bevat state:store instructies die moeten worden getransformeerd in Set-Cookie headers. Ze worden opgeslagen in de browser en de Web SDK-implementatie kan ze gebruiken.

De koekjes zouden op het top-level domein moeten worden geplaatst, zodat zij samen met verzoeken naar de serverimplementatie evenals de cliënt worden verzonden. (Of ten minste een gemeenschappelijk subdomein dat door beide implementaties wordt gebruikt)

Voorbeeld:

Cookies moeten worden ingesteld op .example.com , zodat ze in beide gevallen worden gedeeld.

De reactie aan de serverzijde wordt geordend in fragmenten die Handles worden genoemd, die afhankelijk van de configuratie van de gegevensstroom worden geproduceerd. Aanpassingsprogramma's in real-time retourneren bijvoorbeeld personalization:decisions -handgrepen terwijl de activeringsengine in real-time activation:pull -handgrepen produceert.

De voorbeeldreactie hieronder laat zien hoe de Edge Network API-respons eruit zou kunnen zien.

{
   "requestId":"5c539bd0-33bf-43b6-a054-2924ac58038b",
   "handle":[
      {
         "payload":[
            {
               "id":"XXX",
               "namespace":{
                  "code":"ECID"
               }
            }
         ],
         "type":"identity:result"
      },
      {
         "payload":[
            {
               "..."
            },
            {
               "..."
            }
         ],
         "type":"personalization:decisions",
         "eventIndex":0
      }
   ]
}

Aanvraag op de client client-request

Op de clientpagina wordt de opdracht Web SDK applyResponse aangeroepen, waarbij de koppen en de hoofdtekst van de reactie van de server worden doorgegeven.

   alloy("applyResponse", {
      "renderDecisions": true,
      "responseHeaders": {
         "cache-control": "no-cache, no-store, max-age=0, no-transform, private",
         "connection": "close",
         "content-encoding": "deflate",
         "content-type": "application/json;charset=utf-8",
         "date": "Mon, 11 Jul 2022 19:42:01 GMT",
         "server": "jag",
         "strict-transport-security": "max-age=31536000; includeSubDomains",
         "transfer-encoding": "chunked",
         "vary": "Origin",
         "x-adobe-edge": "OR2;9",
         "x-content-type-options": "nosniff",
         "x-konductor": "22.6.78-BLACKOUTSERVERDOMAINS:7fa23f82",
         "x-rate-limit-remaining": "599",
         "x-request-id": "5c539bd0-33bf-43b6-a054-2924ac58038b",
         "x-xss-protection": "1; mode=block"
      },
      "responseBody": {
         "requestId": "5c539bd0-33bf-43b6-a054-2924ac58038b",
         "handle": [
         {
            "payload": [
               {
               "id": "XXX",
               "namespace": {
                  "code": "ECID"
               }
               }
            ],
            "type": "identity:result"
         },
         {
            "payload": [
               {...},
               {...}
            ],
            "type": "personalization:decisions",
            "eventIndex": 0
         }
         ]
      }
   }
   ).then(applyPersonalization("sample-json-offer"));

JSON -aanbiedingen op basis van formulieren worden handmatig toegepast via de methode applyPersonalization om de DOM bij te werken op basis van de aanpassingsaanbieding. Voor op formulieren gebaseerde activiteiten moeten weergavegebeurtenissen handmatig worden verzonden om aan te geven wanneer de aanbieding is weergegeven. Dit gebeurt via de opdracht sendEvent .

function sendDisplayEvent(decision) {
    const { id, scope, scopeDetails = {} } = decision;

    alloy("sendEvent", {
        "xdm": {
            "eventType": "decisioning.propositionDisplay",
            "_experience": {
                "decisioning": {
                    "propositions": [{
                        "id": id,
                        "scope": scope,
                        "scopeDetails": scopeDetails
                    }],
                    "propositionEventType": {
                        "display": 1
                    }
                }
            }
        }
    });
}

Voorbeeldtoepassing sample-app

Om u te helpen experimenteren en meer te leren over dit type van verpersoonlijking, verstrekken wij een steekproeftoepassing die u voor het testen kunt downloaden en gebruiken. U kunt de toepassing, samen met gedetailleerde instructies op downloaden hoe te om het te gebruiken, van deze bewaarplaats GitHub.