[Alpha]{class="badge informative"}

personalization (Server SDK)

This page describes personalization in the Server SDK sendEvent method. For the Web SDK, see personalization.

The personalization object of sendEvent requests personalization decisions, also called propositions, from Adobe Target, Adobe Journey Optimizer, and Offer Decisioning. The Server SDK returns the propositions in the result of sendEvent, so that your server can use them or pass them to the browser.

const { propositions = [] } = await visitor.sendEvent({
  xdm: {
    eventType: "decisioning.propositionFetch",
    identityMap: {
      Email: [{ id: "visitor@example.com", primary: true }]
    }
  },
  personalization: {
    decisionScopes: ["hero-banner"],
    surfaces: ["web://example.com/home"]
  }
});

This option is available only when the instance includes the Personalization component, which createInstance includes by default.

personalization.decisionScopes

The decisionScopes property is an array of strings. Each item identifies a location, context, or placement where you want personalized content. In Adobe Target, each decision scope maps to an mbox. In Adobe Journey Optimizer and Offer Decisioning, each decision scope maps to a decision-based placement.

personalization: {
  decisionScopes: ["hero-banner", "cart-offer"]
}

personalization.surfaces

The surfaces property is an array of surface URI strings. Each surface identifies a channel, page, or component for which you want Adobe Journey Optimizer code-based experiences, such as web://example.com/home or web://example.com/home#hero.

personalization: {
  surfaces: ["web://example.com/home", "web://example.com/home#hero"]
}

In a browser, the Web SDK automatically requests the surface for the current page. A server has no current page, so the Server SDK requests only the surfaces that you list. Similarly, the SDK doesn’t automatically request the page-wide decision scope that the Web SDK requests when it renders a page.

Top-level decisionScopes top-level-decision-scopes

You can also pass decision scopes in a decisionScopes array at the top level of the sendEvent options, outside the personalization object. The SDK combines both arrays and removes duplicates.

await visitor.sendEvent({
  xdm: {
    eventType: "decisioning.propositionFetch",
    identityMap: {
      Email: [{ id: "visitor@example.com", primary: true }]
    }
  },
  decisionScopes: ["hero-banner"]
});

Propositions in the result result

When you request personalization, the result of sendEvent contains a propositions array. Each proposition contains an id, a scope, scopeDetails, and an array of items. Each item has a schema that describes its content, such as HTML, JSON, or DOM actions.

The SDK doesn’t render propositions, and it doesn’t record that they were displayed. Use them in one of the following ways:

await visitor.sendEvent({
  xdm: {
    eventType: "decisioning.propositionDisplay",
    identityMap: {
      Email: [{ id: "visitor@example.com", primary: true }]
    },
    _experience: {
      decisioning: {
        propositions: renderedPropositions.map(({ id, scope, scopeDetails }) => ({
          id,
          scope,
          scopeDetails
        })),
        propositionEventType: { display: 1 }
      }
    }
  }
});

Options that have no effect on a server no-effect

The SDK accepts the following properties so that you can share code with a browser implementation, but ignores them:

The renderDecisions option of sendEvent also has no effect, because the SDK never renders content.