DocumentatieExperience PlatformHandleiding voor Web SDK

Het gebruiken van Offer decisioning met het Web SDK van het Platform

Last update: Thu Apr 04 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Onderwerpen:

Gemaakt voor:

  • Ontwikkelaar
NOTE
Het gebruik van Offer decisioning in de SDK van het Web van Adobe Experience Platform is beschikbaar in vroege toegang om gebruikers te selecteren. Deze functionaliteit is niet beschikbaar voor alle organisaties.

Adobe Experience Platform Web SDK kan gepersonaliseerde aanbiedingen leveren en teruggeven die in Offer decisioning worden beheerd. U kunt uw aanbiedingen en andere verwante objecten maken met de gebruikersinterface (UI) of API's van de Offer decisioning.

Vereisten

  • Organisatie is ingeschakeld voor randbesluitvorming
  • Aanbiedingen, gemaakte activiteiten
  • DataStream wordt gepubliceerd

Terminologie

Het is belangrijk om de volgende terminologie te begrijpen wanneer het werken met Offer decisioning. Ga voor meer informatie en voor meer informatie naar de Verklarende woordenlijst offer decisioning.

  • Beslissingsgebieden: Voor Offer decisioning, zijn het besluitvormingswerkingsgebied Base64 gecodeerde koorden van JSON die de activiteit en plaatsings IDs bevatten u de dienst van de offer decisioning wilt gebruiken om aanbiedingen voor te stellen.

    Reikwijdte van de beschikking JSON:

    code language-json 
    {
  "activityId":"xcore:offer-activity:11cfb1fa93381aca",
  "placementId":"xcore:offer-placement:1175009612b0100c"
}

    Base64-gecodeerde tekenreeks met beslissingsbereik:

    code language-json 
    "eyJhY3Rpdml0eUlkIjoieGNvcmU6b2ZmZXItYWN0aXZpdHk6MTFjZmIxZmE5MzM4MWFjYSIsInBsYWNlbWVudElkIjoieGNvcmU6b2ZmZXItcGxhY2VtZW50OjExNzUwMDk2MTJiMDEwMGMifQ=="
    note tip
    TIP
    U kunt de waarde van het beslissingsbereik kopiëren uit de Overzicht van activiteiten in de gebruikersinterface.

    Instellingen voor beslissingskopie.

  • Gegevensstromen: Lees voor meer informatie de datastreams documentatie.

  • Identiteit: Lees voor meer informatie deze documentatie waarin wordt beschreven hoe Platform Web SDK gebruikt Identity Service.

Offer decisioning inschakelen

Voer de volgende stappen uit om Offer decisioning in te schakelen:

  1. Adobe Experience Platform ingeschakeld in uw datastream en schakel het selectievakje "Offer decisioning" in

    aanbieding-beslist-rand-config

  2. Volg de instructies op de SDK installeren (De SDK kan zelfstandig of via de gebruikersinterface worden geïnstalleerd. Zie de snel aan de slag met tags) voor meer informatie.

  3. De SDK configureren voor Offer decisioning met personalization.decisionScopes. Hieronder vindt u aanvullende specifieke stappen voor Offer decisioning.

    • De zelfstandige SDK installeren

      1. De handeling "sendEvent" configureren met personalization.decisionScopes
      code language-javascript 
      alloy("sendEvent", {
  ...
  "personalization": {
    "decisionScopes": [
      "eyJhY3Rpdml0eUlkIjoieGNvcmU6b2ZmZXItYWN0aXZpdHk6MTIxYWIwOWMxM2JkZDIyNCIsInBsYWNlbWVudElkIjoieGNvcmU6b2ZmZXItcGxhY2VtZW50OjEyMWFiMDZhODRkMDViMTEifQ==",
      "eyJhY3Rpdml0eUlkIjoieGNvcmU6b2ZmZXItYWN0aXZpdHk6MTIxYWIyNWI5NTUwNWIxZiIsInBsYWNlbWVudElkIjoieGNvcmU6b2ZmZXItcGxhY2VtZW50OjEyMWFiMjFmOTQzMDE0MmIifQ=="
    ]
  }
});

    • De SDK installeren via tags

      1. Een tag-eigenschap maken

      2. De insluitcode toevoegen

      3. Installeer en vorm de uitbreiding van SDK van het Web van het Platform met de Datstream u door de configuratie van "Datasstream"dropdown te selecteren creeerde. Zie de documentatie op extensions.

        install-aep-web-sdk-extension

        configure-aep-web-sdk-extension

      4. Maak de noodzakelijke Gegevenselementen. Bij het absolute minimum, moet u een Identiteitskaart van het Web SDK van het Platform en een het gegevenselement van de Objecten van XDM van het Web van het Web van het Platform tot stand brengen XDM.

        identity-map-data-element

        xdm-object-data-element

      5. Maak uw Regels.

        • Voeg een actie van de Gebeurtenis van de Server van SDK van het Web van het Platform toe verzenden en voeg relevante toe decisionScopes aan de configuratie van die actie

        send-event-action-decisionsScopes

      6. Bibliotheek maken en publiceren met alle relevante regels, gegevenselementen en extensies die u hebt geconfigureerd

Voorbeeldverzoeken en -antwoorden

Eén decisionScopes value

Verzoek

{
  "events": [
    {
      "xdm": {
        "identityMap": {
          "ECID": [
            {
              "id": "91133425615229052182584359620783097099"
            }
          ]
        }
      },
      "query": {
        "personalization": {
          "decisionScopes": [
            "eyJhY3Rpdml0eUlkIjoieGNvcmU6b2ZmZXItYWN0aXZpdHk6MTFjZmIxZmE5MzM4MWFjYSIsInBsYWNlbWVudElkIjoieGNvcmU6b2ZmZXItcGxhY2VtZW50OjExNzUwMDk2MTJiMDEwMGMifQ=="
          ]
        }
      }
    }
  ]
}
Eigenschap
Vereist
Beschrijving
Limieten
Voorbeeld
identityMap
Ja
Zie dit Identiteitsdocumentatie.
Eén identiteit per aanvraag.
{ "identityMap": { "ECID": [ { "id": "91133425615229052182584359620783097099" } ] } }.

Opmerking: gebruikers hoeven de ECID in de API-aanroep. Deze parameter wordt automatisch toegevoegd aan de vraag indien nodig.
decisionScopes
Ja
Een array met Base64-gecodeerde tekenreeksen van JSON die de activiteit- en plaatsings-id's bevatten.
Maximaal 30 decisionScopes per verzoek.
"decisionScopes": ["eyJhY3Rpdml0eUlkIjoieGNvcmU6b2ZmZXItYWN0aXZpdHk6MTFjZmIxZmE5MzM4MWFjYSIsInBsYWNlbWVudElkIjoieGNvcmU6b2ZmZXItcGxhY2VtZW50OjExNzUwMDk2MTJiMDEwMGMifQ=="]

Antwoord

{
  "requestId": "94c4f2f1-9218-43ce-afd3-eb0d853c5174",
  "handle": [
    {
      "payload": [
        {
          "id": "2862bb89-5df2-4bc6-85c2-d8f7e1a091de",
          "scope": "eyJhY3Rpdml0eUlkIjoieGNvcmU6b2ZmZXItYWN0aXZpdHk6MTFjZmIxZmE5MzM4MWFjYSIsInBsYWNlbWVudElkIjoieGNvcmU6b2ZmZXItcGxhY2VtZW50OjExNzUwMDk2MTJiMDEwMGMifQ==",
          "activity": {
            "id": "xcore:offer-activity:11cfb1fa93381aca",
            "etag": "2"
          },
          "placement": {
            "id": "xcore:offer-placement:1175009612b0100c",
            "etag": "1"
          },
          "items": [
            {
              "id": "xcore:personalized-offer:124cc332095cfa74",
              "schema": "https://ns.adobe.com/experience/offer-management/content-component-html",
              "etag": "1",
              "data": {
                "id": "xcore:personalized-offer:124cc332095cfa74",
                "format": "text/html",
                "language": [
                  "en-US"
                ],
                "content": "<p>20% Off on shipping</p>",
                "characteristics": {
                  "foo": "bar",
                  "foo1": "bar1"
                }
              }
            }
          ]
        }
      ],
      "type": "personalization:decisions",
      "eventIndex": 0
    }
  ]
}
Eigenschap
Beschrijving
Voorbeeld
scope
De reikwijdte van de beslissing die tot de voorgestelde aanbiedingen heeft geleid.
"scope": "eyJhY3Rpdml0eUlkIjoieGNvcmU6b2ZmZXItYWN0aXZpdHk6MTFjZmIxZmE5MzM4MWFjYSIsInBsYWNlbWVudElkIjoieGNvcmU6b2ZmZXItcGxhY2VtZW50OjExNzUwMDk2MTJiMDEwMGMifQ=="
activity.id
De unieke id van de aanbiedingsactiviteit.
"id": "xcore:offer-activity:11cfb1fa93381aca"
placement.id
De unieke id van de plaatsing van de aanbieding.
"id": "xcore:offer-placement:1175009612b0100c"
items.id
De id van de voorgestelde aanbieding.
"id": "xcore:personalized-offer:124cc332095cfa74"
schema
Het schema van de inhoud verbonden aan de voorgestelde aanbieding.
"schema": "https://ns.adobe.com/experience/offer-management/content-component-html"
data.id
De id van de voorgestelde aanbieding.
"id": "xcore:personalized-offer:124cc332095cfa74"
format
Het formaat van de inhoud die aan de voorgestelde aanbieding is gekoppeld.
"format": "text/html"
language
Een array met talen die zijn gekoppeld aan de inhoud van het voorgestelde aanbod.
"language": [ "en-US" ]
content
De inhoud die aan de voorgestelde aanbieding in het formaat van een koord wordt geassocieerd.
"content": "<p style="color:red;">20% Off on shipping</p>"
deliveryUrl
De afbeeldingsinhoud die aan de voorgestelde aanbieding is gekoppeld, wordt weergegeven in de vorm van een URL.
"deliveryURL": "https://image.jpeg"
characteristics
Kenmerken van de voorgestelde aanbieding in de vorm van een JSON-object.
"characteristics": { "foo": "bar", "foo1": "bar1" }

Meerdere decisionScopes waarden

Verzoek

{
  "events": [
    {
      "xdm": {
        "identityMap": {
          "ECID": [
            {
              "id": "91133425615229052182584359620783097099"
            }
          ]
        }
      },
      "query": {
        "personalization": {
          "decisionScopes": [
            "eyJhY3Rpdml0eUlkIjoieGNvcmU6b2ZmZXItYWN0aXZpdHk6MTFjZmIxZmE5MzM4MWFjYSIsInBsYWNlbWVudElkIjoieGNvcmU6b2ZmZXItcGxhY2VtZW50OjExNzUwMDk2MTJiMDEwMGMifQ==",
            "eyJhY3Rpdml0eUlkIjoieGNvcmU6b2ZmZXItYWN0aXZpdHk6MTIyMjA4YjNhODc0MDU1OCIsInBsYWNlbWVudElkIjoieGNvcmU6b2ZmZXItcGxhY2VtZW50OjEyMjIwNDUyOTUxNGEyYzAifQ==",
            "eyJhY3Rpdml0eUlkIjoieGNvcmU6b2ZmZXItYWN0aXZpdHk6MTIyYzkxMzg1Mjc2MDE4YyIsInBsYWNlbWVudElkIjoieGNvcmU6b2ZmZXItcGxhY2VtZW50OjEyMzMxZjU2MTYyYWEyZjcifQ=="
          ]
        }
      }
    }
  ]
}
Eigenschap
Vereist
Beschrijving
Limieten
Voorbeeld
identityMap
Ja
Zie dit Identiteitsdocumentatie.
Eén identiteit per aanvraag.
{ "identityMap": { "ECID": [ { "id": "91133425615229052182584359620783097099" } ] } }.

Opmerking: gebruikers hoeven de ECID in de API-aanroep. Deze parameter wordt automatisch toegevoegd aan de vraag indien nodig.
decisionScopes
Ja
Een array met Base64-gecodeerde tekenreeksen van JSON die de activiteit- en plaatsings-id's bevatten.
Maximaal 30 decisionScopes per verzoek.
"decisionScopes":["eyJhY3Rpdml0eUlkIjoieGNvcmU6b2ZmZXItYWN0aXZpdHk6MTFjZmIxZmE5MzM4MWFjYSIsInBsYWNlbWVudElkIjoieGNvcmU6b2ZmZXItcGxhY2VtZW50OjExNzUwMDk2MTJiMDEwMGMifQ==", "eyJhY3Rpdml0eUlkIjoieGNvcmU6b2ZmZXItYWN0aXZpdHk6MTIyMjA4YjNhODc0MDU1OCIsInBsYWNlbWVudElkIjoieGNvcmU6b2ZmZXItcGxhY2VtZW50OjEyMjIwNDUyOTUxNGEyYzAifQ=="

Antwoord

{
  "requestId": "94c4f2f1-9218-43ce-afd3-eb0d853c5174",
  "handle": [
    {
      "payload": [
        {
          "id": "a2804dfb-a0ec-4df9-8311-59d3ecdeb642",
          "scope": "eyJhY3Rpdml0eUlkIjoieGNvcmU6b2ZmZXItYWN0aXZpdHk6MTFjZmIxZmE5MzM4MTEyMyIsInBsYWNlbWVudElkIjoieGNvcmU6b2ZmZXItcGxhY2VtZW50OjExNzUwMDk2MTJiMDExMjMifQ==",
          "activity": {
            "id": "xcore:offer-activity:11cfb1fa93381123",
            "etag": "1"
          },
          "placement": {
            "id": "xcore:offer-placement:1175009612b01123",
            "etag": "3"
          },
          "items": [
            {
              "id": "xcore:personalized-offer:11e36d4a22954123",
              "schema": "https://ns.adobe.com/experience/offer-management/content-component-text",
              "etag": "2",
              "data": {
                "id": "xcore:personalized-offer:11e36d4a22954123",
                "format": "text/text",
                "language": [
                  "en"
                ],
                "content": "20% Off on shipping",
                "characteristics": {
                  "foo2": "bar2"
                }
              }
            }
          ]
        },
        {
          "id": "a2804dfb-a0ec-4df9-8311-59d3ecdeb642",
          "scope": "eyJhY3Rpdml0eUlkIjoieGNvcmU6b2ZmZXItYWN0aXZpdHk6MTFjZmIxZmE5MzM4MWFjYSIsInBsYWNlbWVudElkIjoieGNvcmU6b2ZmZXItcGxhY2VtZW50OjExNzUwMDk2MTJiMDEwMGMifQ==",
          "activity": {
            "id": "xcore:offer-activity:11cfb1fa93381aca",
            "etag": "2"
          },
          "placement": {
            "id": "xcore:offer-placement:1175009612b0100c",
            "etag": "1"
          },
          "items": [
            {
              "id": "xcore:personalized-offer:11e36d4a2295415d",
              "schema": "https://ns.adobe.com/experience/offer-management/content-component-imagelink",
              "etag": "1",
              "data": {
                "id": "xcore:personalized-offer:11e36d4a2295415d",
                "format": "image/png",
                "language": [
                  "en"
                ],
                "deliveryURL": "https://image.jpeg",
                "characteristics": {
                  "foo": "bar",
                  "foo1": "bar1"
                }
              }
            }
          ]
        }
      ],
      "type": "personalization:decisions",
      "eventIndex": 0
    }
  ]
}
Eigenschap
Beschrijving
Voorbeeld
scope
De reikwijdte van de beslissing die tot de voorgestelde aanbiedingen heeft geleid.
"scope": "eyJhY3Rpdml0eUlkIjoieGNvcmU6b2ZmZXItYWN0aXZpdHk6MTFjZmIxZmE5MzM4MWFjYSIsInBsYWNlbWVudElkIjoieGNvcmU6b2ZmZXItcGxhY2VtZW50OjExNzUwMDk2MTJiMDEwMGMifQ=="
activity.id
De unieke id van de aanbiedingsactiviteit.
"id": "xcore:offer-activity:11cfb1fa93381123"
placement.id
De unieke id van de plaatsing van de aanbieding.
"xcore:offer-placement:1175009612b01123"
items.id
De id van de voorgestelde aanbieding.
"id": "xcore:personalized-offer:11e36d4a22954123"
schema
Het schema van de inhoud verbonden aan de voorgestelde aanbieding.
"schema": "https://ns.adobe.com/experience/offer-management/content-component-text"
data.id
De id van de voorgestelde aanbieding.
"id": "xcore:personalized-offer:11e36d4a22954123"
format
Het formaat van de inhoud die aan de voorgestelde aanbieding is gekoppeld.
"format": "text/text"
language
Een array met talen die zijn gekoppeld aan de inhoud van het voorgestelde aanbod.
"language": [ "en-US" ]
content
De inhoud die aan de voorgestelde aanbieding in het formaat van een koord wordt geassocieerd.
"content": "<p style="color:red;">20% Off on shipping</p>"
deliveryUrl
De afbeeldingsinhoud die aan de voorgestelde aanbieding is gekoppeld, wordt weergegeven in de vorm van een URL.
"deliveryURL": "https://image.jpeg"
characteristics
Kenmerken van de voorgestelde aanbieding in de vorm van een JSON-object.
"characteristics": { "foo": "bar", "foo1": "bar1" }

Beperkingen

Sommige aanbodbeperkingen worden momenteel niet ondersteund door de mobiele Edge Network-workflows, bijvoorbeeld Capping. De waarde van het gebied van de Plak specificeert het aantal tijden een aanbieding over alle gebruikers kan worden voorgesteld. Zie voor meer informatie Aanbiedingsregels en documentatie over beperkingen.

recommendation-more-help
ad108910-6329-42f1-aa1d-5920a2b13636