Recherche d’une collection
Dernière mise à jour : 5 avril 2024
- Rubriques :
- Gestion des décisions
- API
- Requête
Créé pour :
- Expérimenté
- Développeur
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 rechercher des collections spécifiques en adressant une requête GET à l’API Offer Library qui inclut la collection @id
ou le nom de la collection dans le chemin de la requête.
Format d’API
GET /{ENDPOINT_PATH}/{CONTAINER_ID}/queries/core/search?schema={SCHEMA_FILTER}&{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 collections. | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
{SCHEMA_FILTER} | Définit le schéma associé aux collections. | https://ns.adobe.com/experience/offer-management/offer-filter;version=0.1 |
id | Chaîne utilisée pour faire correspondre la propriété @id des entités. La chaîne correspond exactement. Les paramètres id et name ne peuvent pas être utilisés ensemble. | xcore:offer-filter:124bd44648f17ec1 |
name | Chaîne utilisée pour correspondre à la propriété xdm:name des entités. La chaîne correspond exactement, avec la capitalisation, mais des caractères génériques peuvent être utilisés. Les paramètres id et name ne peuvent pas être utilisés ensemble | Mobile demo |
Requête
curl -X GET \
'https://platform.adobe.io/data/core/xcore/ab574eca-f7a9-38d0-b3d9-297376ca9ee2/instances?schema=https://ns.adobe.com/experience/offer-management/offer-filter;version=0.1&id=xcore:offer-filter:124bd44648f17ec1' \
-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}'
Réponse
Une réponse réussie renvoie les détails de l’emplacement, y compris les informations sur votre ID de conteneur, l’ID d’instance et l’@id
de collection unique.
{
"containerId": "ab574eca-f7a9-38d0-b3d9-297376ca9ee2",
"schemaNs": "https://ns.adobe.com/experience/offer-management/offer-filter;version=0.1",
"requestTime": "2023-10-21T21:29:27.329070Z",
"_embedded": {
"results": [
{
"instanceId": "27c92e00-127d-11eb-b9fe-5bcfb5d7ef36",
"schemas": [
"https://ns.adobe.com/experience/offer-management/offer-filter;version=0.3"
],
"productContexts": [
"acp"
],
"repo:etag": 1,
"repo:createdDate": "2023-10-20T02:37:11.263718Z",
"repo:lastModifiedDate": "2023-10-20T02:37:11.263718Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_score": 0,
"_instance": {
"xdm:ids": [
"xcore:tag:124bd3de7f598dd8"
],
"xdm:name": "Mobile Demo",
"xdm:filterType": "anyTags",
"@id": "xcore:offer-filter:124bd44648f17ec1"
},
"_links": {
"self": {
"name": "https://ns.adobe.com/experience/offer-management/offer-filter;version=0.3#27c92e00-127d-11eb-b9fe-5bcfb5d7ef36",
"href": "/ab574eca-f7a9-38d0-b3d9-297376ca9ee2/instances/27c92e00-127d-11eb-b9fe-5bcfb5d7ef36",
"@type": "https://ns.adobe.com/experience/offer-management/offer-filter;version=0.3"
}
},
"sandboxName": "ode-prod-va7-edge-testing"
}
],
"total": 1,
"count": 1
},
"_links": {
"self": {
"href": "/ab574eca-f7a9-38d0-b3d9-297376ca9ee2/instances?schema=https://ns.adobe.com/experience/offer-management/offer-filter;version=0.1&id=xcore:offer-filter:124bd44648f17ec1",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
}
}
}
recommendation-more-help
b22c9c5d-9208-48f4-b874-1cefb8df4d76