https://ns.adobe.com/experience/offer-management/offer-placement
An offer placement is a location or place in a personalized message or content experience. It is used to set technical constraints for content selected during personalization. Technical constraints include the content component type that is expected from the personalization (offer representation) and the channel that indicates the context for consuming the content. The channel imposes further constraints on the media type. For instance, html content used in an email is often structured differently than html content used on the web. The placement also represents a request to produce certain types of metrics when an experience event is produced where this placemement is involved. For instance the placement facilitates a personalized clickable image inside an email shown to an end user. The placement may for instance request from the assembled experience that the click on its image gets reported in an experience event with a metric https://ns.adobe.com/xdm/data/metrics/web/linkclicks and a reference to this placement.
An offer with its content representations refers to an offer placement object by the placement's @id. This is important that the constraints are not enumerated in the offer or the placement. The placement can be thought to represent the contract between the offer's content and the place where the content needs to be embedded. Any number of constraints can be agreed upon and outside of the repository and can be thought to be represented by a particular offer placement object.
An offer activity referencing a particular offer placement means the activity seeks to select content items that comply with the "virtual contract". An offer with its representation pointing to the same offer placement means the offer has a representation that complies with that particular "virtual contract".
By extending the offer placement schema more structure could be imposed finding the particular placement object. For example, in addition to the media type "image" a custom placement could add a field aspectRatio that holds the aspect ratio. What an aspect ratio is does not need to be understood by the offer decisioning process but creating or finding and attaching content to the offer representation needs to make sure the contract is respected and only images with a perticular aspect ratio are used for the offer when the representation makes the reference to the offer placement object.
The mutual contract does not need to rely on physical properties of the content. One can also express an intent what the content should be. An offer placement with a 'video' media type file could be called upon to represent a pre-roll ad or another offer placement might represent that an image is a banner image on a web page.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In |
|---|---|---|---|---|---|---|
| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | adobe/experience/offer-management/offer-placement.schema.json |
- Placement
https://ns.adobe.com/experience/offer-management/offer-placement- Record Schema
https://ns.adobe.com/xdm/data/record - Decision Content Placement
https://ns.adobe.com/experience/decisioning/placement - Representation (deprecated)
https://ns.adobe.com/experience/offer-management/offer-representation
- Record Schema
| Property | Type | Required | Defined by |
|---|---|---|---|
| @id | string |
Optional | Record Schema |
| https://ns.adobe.com/experience/decisioning/channelID | string |
Optional | Decision Content Placement |
| https://ns.adobe.com/experience/decisioning/componentType | string |
Optional | Decision Content Placement |
| https://ns.adobe.com/experience/decisioning/contentTypes | string[] |
Optional | Decision Content Placement |
| https://ns.adobe.com/experience/decisioning/description | string |
Optional | Decision Content Placement |
| https://ns.adobe.com/experience/decisioning/name | string |
Optional | Decision Content Placement |
| repo:etag | string |
Optional | Decision Content Placement |
| xdm:channel | string |
Optional | Placement (this schema) |
| xdm:componentType | enum |
Optional | Placement (this schema) |
| xdm:contentTypes | string[] |
Optional | Placement (this schema) |
| xdm:description | string |
Optional | Placement (this schema) |
| xdm:name | string |
Optional | Placement (this schema) |
* |
any | Additional | this schema allows additional properties |
A unique identifier for the record.
@id
- is optional
- type:
string - defined in Record Schema
string
- format:
uri-reference– URI Reference (according to RFC3986)
The channel in which proposition was made. The value is a valid Channel URI. See 'https://ns.adobe.com/xdm/channels/channel'
https://ns.adobe.com/experience/decisioning/channelID
- is optional
- type:
string - defined in Decision Content Placement
string
- format:
uri-reference– URI Reference (according to RFC3986)
A constraint for the content that can be shown in the place described by this placement. Component Types for example are: image link, html block or plain text.
https://ns.adobe.com/experience/decisioning/componentType
- is optional
- type:
string - defined in Decision Content Placement
string
- format:
uri-reference– URI Reference (according to RFC3986)
https://ns.adobe.com/experience/decisioning/contentTypes
-
is optional
-
type:
string[] -
defined in Decision Content Placement
Array type: string[]
All items must be of the type:
string
All instances must conform to this regular expression (test examples here):
\w+\/[-.\w]+(?:\+[-.\w]+)?A constraint for the media type of the components that is expected in that placement. There could be more than one media type possible for one component such as different image format.
Placement description. It is used to convey human readable intentions on how dynamic content is used in the overall message delivery. That a certain space is a "Banner" in a web page is often conveyed via the description and not by a formal method.
https://ns.adobe.com/experience/decisioning/description
- is optional
- type:
string - defined in Decision Content Placement
string
An assigned name for the placement to refer to it in human interactions
https://ns.adobe.com/experience/decisioning/name
- is optional
- type:
string - defined in Decision Content Placement
string
The revision that the placement object was at when the snapshot was taken.
repo:etag
- is optional
- type:
string - defined in Decision Content Placement
string
A reference to the channel entity. The channel indicates where the dynamic content is intended to be delivered. The channel constraint is used to convey not only where the offer will be used but also to determine the content editor or validator that is used for the experience. See 'https://ns.adobe.com/xdm/channels/channel'
xdm:channel
- is optional
- type:
string - defined in this schema
string
- format:
uri– Uniformous Resource Identifier (according to RFC3986)
A constraint for the content that can be shown in the place described by this placement. Component Types are: image, html or plain text.
xdm:componentType
- is optional
- type:
enum - defined in this schema
The value of this property must be equal to one of the known values below.
| Value | Description |
|---|---|
https://ns.adobe.com/experience/offer-management/content-component-text |
Text component |
https://ns.adobe.com/experience/offer-management/content-component-html |
HTML component |
https://ns.adobe.com/experience/offer-management/content-component-imagelink |
Image and click link component |
xdm:contentTypes
-
is optional
-
type:
string[] -
defined in this schema
Array type: string[]
All items must be of the type:
string
All instances must conform to this regular expression (test examples here):
\w+\/[-.\w]+(?:\+[-.\w]+)?A constraint for the media type of the components that is expected in that placement. There could be more than one media type possible for one component such as different image format.
Placement description. It is used to convey human readable intentions on how dynamic content is used in the overall message delivery. That a certain space is a "Banner" in a web page is often conveyed via the description and not by a formal method.
xdm:description
- is optional
- type:
string - defined in this schema
string
An assigned name for the placement to refer to it in human interactions
xdm:name
- is optional
- type:
string - defined in this schema
string