Une décision contient la logique sous-tendant la sélection d’une offre.
Vous pouvez afficher une liste de toutes les décisions au sein d'un conteneur en exécutant une seule requête GET sur l'API Offer Library.
Format d'API
GET /{ENDPOINT_PATH}/{CONTAINER_ID}/queries/core/search?schema={SCHEMA_ACTIVITIES}&{QUERY_PARAMS}
Paramètre | Description | Exemple |
---|---|---|
{ENDPOINT_PATH} |
Chemin d’accès de point d’entrée pour les API de référentiel. | https://platform.adobe.io/data/core/xcore/ |
{CONTAINER_ID} |
Conteneur où se trouvent les décisions. | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
{SCHEMA_ACTIVITIES} |
Définit le schéma associé aux décisions. | https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5 |
{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/xcore/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?schema=https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5&limit=2' \
-H 'Accept: *,application/vnd.adobe.platform.xcore.hal+json; schema="https://ns.adobe.com/experience/xcore/hal/results"' \
-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}'
Vous pouvez utiliser des paramètres de requête pour paginer et filtrer les résultats lors de l'organisation en liste des ressources.
Les paramètres de requête les plus courants pour la pagination sont les suivants :
Paramètre | Description | Exemple |
---|---|---|
q |
Chaîne de requête facultative à rechercher dans les champs sélectionnés. La chaîne de requête doit être en minuscules et peut être entourée de guillemets doubles pour l'empêcher d'être divisée en symboles et pour échapper les caractères spéciaux. Les caractères `+ - = && | |
qop |
Applique l'opérateur ET ou OU aux valeurs du paramètre de chaîne de requête q. | AND / OR |
field |
Liste facultative des champs à laquelle limiter la recherche. Ce paramètre peut être répété comme suit : field=field1[,field=field2,…] et (les expressions du chemin se présentent sous la forme de chemins séparés par des points, tels que _instance.xdm:name). | _instance.xdm:name |
orderBy |
Triez les résultats en fonction d'une propriété spécifique. L'ajout d'un - devant le titre (orderby=-title ) trie les éléments par titre dans l'ordre décroissant (Z-A). |
-repo:createdDate |
limit |
Limite le nombre de décisions renvoyées. | limit=5 |
Réponse
Une réponse positive renvoie une liste des décisions présentes dans le conteneur auquel vous avez accès.
{
"containerId": "e0bd8463-0913-4ca1-bd84-6309134ca1f6",
"schemaNs": "https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5",
"requestTime": "2020-10-21T22:38:32.838180Z",
"_embedded": {
"results": [
{
"instanceId": "286f6f80-026b-11eb-9439-ad36e372cbf1",
"schemas": [
"https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5"
],
"productContexts": [
"acp"
],
"repo:etag": 5,
"repo:createdDate": "2020-09-29T15:48:02.808677Z",
"repo:lastModifiedDate": "2020-10-15T15:49:26.673560Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_instance": {
"xdm:fallback": "xcore:fallback-offer:1233160780eaa2ef",
"xdm:name": "A2: Cross Channel Activity",
"xdm:endDate": "2020-10-09T07:00:00.000Z",
"xdm:startDate": "2020-09-29T07:00:00.000Z",
"xdm:status": "live",
"xdm:criteria": [
{
"xdm:placements": [
"xcore:offer-placement:122204529514a2c0"
],
"xdm:optionSelection": {
"xdm:filter": "xcore:offer-filter:122a120f234dac7f"
}
},
{
"xdm:placements": [
"xcore:offer-placement:122201b2150d98c2"
],
"xdm:optionSelection": {
"xdm:filter": "xcore:offer-filter:1222058c3f0d98de"
}
}
],
"@id": "xcore:offer-activity:12317fe6aeec9330"
},
"_links": {
"self": {
"name": "https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5#286f6f80-026b-11eb-9439-ad36e372cbf1",
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/286f6f80-026b-11eb-9439-ad36e372cbf1",
"@type": "https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5"
}
},
"sandboxName": "ode-prod-va7-edge-testing"
},
{
"instanceId": "4e0206d0-0e6a-11eb-884a-c1a1104e3d7d",
"schemas": [
"https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5"
],
"productContexts": [
"acp"
],
"repo:etag": 1,
"repo:createdDate": "2020-10-14T22:12:10.300775Z",
"repo:lastModifiedDate": "2020-10-14T22:12:10.300775Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_instance": {
"xdm:fallback": "xcore:fallback-offer:1233160780eaa2ef",
"xdm:name": "LBAR",
"xdm:endDate": "2021-02-28T08:00:00.000Z",
"xdm:startDate": "2020-10-14T07:00:00.000Z",
"xdm:status": "live",
"xdm:criteria": [
{
"xdm:placements": [
"xcore:offer-placement:122204529514a2c0"
],
"xdm:optionSelection": {
"xdm:filter": "xcore:offer-filter:122a120f234dac7f"
}
}
],
"@id": "xcore:offer-activity:124527ab00b2ebbc"
},
"_links": {
"self": {
"name": "https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5#4e0206d0-0e6a-11eb-884a-c1a1104e3d7d",
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/4e0206d0-0e6a-11eb-884a-c1a1104e3d7d",
"@type": "https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5"
}
},
"sandboxName": "ode-prod-va7-edge-testing"
}
],
"total": 7,
"count": 2
},
"_links": {
"self": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?schema=https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5&limit=2",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
},
"next": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?start=4e0206d0-0e6a-11eb-884a-c1a1104e3d7d&orderby=instanceId&schema=https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5&limit=2",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
}
}
}