[Hérité]{class="badge informative"}
Liste des emplacements list-placements
Les emplacements sont des conteneurs utilisés pour présenter vos offres. Un emplacement permet de s'assurer que le contenu d'offre approprié s'affiche au bon endroit dans votre message. Lorsque vous ajoutez du contenu à une offre, vous êtes invité à sélectionner un emplacement dans lequel ce contenu peut être affiché.
Vous pouvez afficher une liste de tous les emplacements en exécutant une seule requête GET sur l’API Offer Library.
Format d’API
GET /{ENDPOINT_PATH}/placements?{QUERY_PARAMS}
{ENDPOINT_PATH}https://platform.adobe.io/data/core/dpsUtiliser des paramètres de requête using-query-parameters
Vous pouvez utiliser des paramètres de requête pour paginer et filtrer les résultats lors de l'organisation en liste des ressources.
Pagination paging
Les paramètres de requête les plus courants pour la pagination sont les suivants :
propertyUn filtre de propriété facultatif :
- Les propriétés sont regroupées par opération AND.
- Les paramètres peuvent être répétés comme suit : property={PROPERTY_EXPR}[&property={PROPERTY_EXPR2}…] ou property={PROPERTY_EXPR1}[,{PROPERTY_EXPR2}…]
- Les expressions de propriété sont au format
[ !]field[op]value, avecopdans[==,!=,<=,>=,<,>,~], prenant en charge les expressions régulières.
property=name!=abc&property=id~.*1234.*&property=description equivalent with property=name!=abc,id~.*1234.*,description.orderByorderby=field1[,-fields2,field3,...]orderby=id,-nameRequête
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}'
Réponse
Une réponse réussie renvoie une liste d’emplacements présents et ceux auxquels vous avez accès.
{
"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"
}
}
}