List placements list-placements
Placements are containers that are used to showcase your offers. A placement helps ensure that the right offer content shows up in the right location within your message. When you add content to an offer, you will be asked to select a placement in which that content can be shown.
You can view a list of all placements by performing a single GET request to the Offer Library API.
API format
GET /{ENDPOINT_PATH}/placements?{QUERY_PARAMS}
Parameter
Description
Example
{ENDPOINT_PATH}
The endpoint path for repository APIs.
https://platform.adobe.io/data/core/dps
Using query parameters using-query-parameters
You can use query parameters to page and filter results when listing resources.
Paging paging
The most common query parameters for paging include:
Parameter
Description
Example
property
An optional property filter:
- The properties are grouped by AND operation.
- Parameters can be repeated like so: property={PROPERTY_EXPR}[&property={PROPERTY_EXPR2}…] or property={PROPERTY_EXPR1}[,{PROPERTY_EXPR2}…]
- Property expressions are in format
[!]field[op]value
, withop
in[==,!=,<=,>=,<,>,~]
, supporting regular expressions.
property=name!=abc&property=id~.*1234.*&property=description equivalent with property=name!=abc,id~.*1234.*,description.
orderBy
Sort results by a specific property. Adding a - before name (orderby=-name) will sort items by name in descending order (Z-A). Path expressions are in the form of dot separated paths. This parameter can be repeated like so:
orderby=field1[,-fields2,field3,...]
orderby=id
,-name
Request
curl -X GET 'https://platform.adobe.io/data/core/dps/placements?limit=2' \
-H 'Accept: *,application/json' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Response
A successful response returns a list of placements that are present and those that you have access to.
{
"results": [
{
"created": "2023-05-15T11:22:50.031+00:00",
"modified": "2023-05-15T11:22:50.031+00:00",
"etag": 1,
"schemas": [
"https://ns.adobe.com/experience/offer-management/offer-placement;version=0.5"
],
"createdBy": "{CREATED_BY}",
"lastModifiedBy": "{MODIFIED_BY}",
"id": "offerPlacement5678",
"name": "Placement one",
"description": "Placement description",
"componentType": "html",
"channel": "https://ns.adobe.com/xdm/channel-types/web",
"itemCount": 1,
"allowDuplicatePlacements": false,
"returnContent": false,
"returnMetaData": {
"decisionName": true,
"offerName": true,
"offerAttributes": true,
"offerPriority": true,
"placementName": true,
"channelType": true,
"contentType": true
}
},
{
"created": "2023-05-19T08:29:15.875+00:00",
"modified": "2023-05-19T08:29:15.875+00:00",
"etag": 1,
"schemas": [
"https://ns.adobe.com/experience/offer-management/offer-placement;version=0.5"
],
"createdBy": "{CREATED_BY}",
"lastModifiedBy": "{MODIFIED_BY}",
"id": "offerPlacement1234",
"name": "Placement two",
"description": "Placement description",
"componentType": "html",
"channel": "https://ns.adobe.com/xdm/channel-types/email",
"itemCount": 1,
"allowDuplicatePlacements": false,
"returnContent": false,
"returnMetaData": {
"decisionName": true,
"offerName": true,
"offerAttributes": true,
"offerPriority": true,
"placementName": true,
"channelType": true,
"contentType": true
}
}
],
"count": 2,
"total": 4,
"_links": {
"self": {
"href": "/placements?href={SELF_HREF}&limit=2",
"type": "application/json"
},
"next": {
"href": "/placements?href={NEXT_HREF}&limit=2",
"type": "application/json"
}
}
}
recommendation-more-help
b22c9c5d-9208-48f4-b874-1cefb8df4d76