Liste des collections list-collections
Les collections sont des sous-ensembles d’offres basés sur des conditions prédéfinies établies par un spécialiste marketing, telles que la catégorie de l’offre.
Vous pouvez afficher une liste de toutes les collections en exécutant une seule requête GET sur l’API Offer Library.
Format d’API
GET /{ENDPOINT_PATH}/offer-collections?{QUERY_PARAMS}
Paramètre
Description
Exemple
{ENDPOINT_PATH}
Chemin d’accès de point d’entrée pour les API Persistence
https://platform.adobe.io/data/core/dps
{QUERY_PARAMS}
Paramètres de requête facultatifs en fonction desquels filtrer les résultats.
limit=2
Requête
curl -X GET 'https://platform.adobe.io/data/core/dps/offer-collections?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}'
Utilisation 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 :
Paramètre
Description
Exemple
property
Un 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
, avecop
dans[==,!=,<=,>=,<,>,~]
, prenant en charge les expressions régulières.
property=name!=abc&property=id~.*1234.*&property=description equivalent with property=name!=abc,id~.*1234.*,description.
orderBy
Triez les résultats en fonction d'une propriété spécifique. L’ajout d’un - avant le nom (orderby=-name) triera les éléments par nom dans l’ordre décroissant (Z-A). Les expressions de chemin se présentent sous la forme de chemins séparés par des points. Ce paramètre peut être répété comme suit :
orderby=field1[,-fields2,field3,...]
orderby=id
,-name
limit
Limitez le nombre d’entitées renvoyées.
limit=5
Réponse
Une réponse positive renvoie une liste de collections présentes dans le conteneur auquel vous avez accès.
{
"results": [
{
"created": "2022-09-16T18:59:23.063+00:00",
"modified": "2022-09-16T18:59:23.063+00:00",
"etag": 1,
"schemas": [
"https://ns.adobe.com/experience/offer-management/offer-filter;version=0.4"
],
"createdBy": "{CREATED_BY}",
"lastModifiedBy": "{MODIFIED_BY}",
"id": "offerCollection1234",
"name": "Test Collection with tags",
"filterType": "any-tags",
"ids": [
"tag1234"
],
"labels": [
"core/C5",
"custom/myLabel"
]
},
{
"created": "2023-05-15T12:50:49.887+00:00",
"modified": "2023-05-15T12:50:49.887+00:00",
"etag": 1,
"schemas": [
"https://ns.adobe.com/experience/offer-management/offer-filter;version=0.4"
],
"createdBy": "{CREATED_BY}",
"lastModifiedBy": "{MODIFIED_BY}",
"id": "offerCollection5678",
"name": "Test Collection with offers",
"filterType": "offers",
"ids": [
"personalizedOffer1234",
"personalizedOffer5678"
]
}
],
"count": 2,
"total": 9,
"_links": {
"self": {
"href": "/offer-collections?href={SELF_HREF}&limit=2",
"type": "application/json"
},
"next": {
"href": "/offer-collections?href={NEXT_HREF}&limit=2",
"type": "application/json"
}
}
}
recommendation-more-help
b22c9c5d-9208-48f4-b874-1cefb8df4d76