Documentation Journey Optimizer Guide de Journey Optimizer

Liste des offres de secours

Dernière mise à jour : 5 avril 2024

Créé pour :

Expérimenté
Développeur

Une offre de secours est envoyée aux clients s’ils ne sont pas éligibles pour d’autres offres. Les étapes de création d'une offre de secours consistent à créer une ou plusieurs représentations, comme lors de la création d'une offre.

Vous pouvez afficher une liste de toutes les offres de secours au sein d’un conteneur en adressant une seule requête GET à l’API Offer Library.

Format d’API

GET /{ENDPOINT_PATH}/{CONTAINER_ID}/queries/core/search?schema={SCHEMA_FALLBACK_OFFER}&{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 offres de secours.	`e0bd8463-0913-4ca1-bd84-6309134ca1f6`
`{SCHEMA_FALLBACK_OFFER}`	Définit le schéma associé aux offres de secours.	`https://ns.adobe.com/experience/offer-management/fallback-offer;version=0.1`
`{QUERY_PARAMS}`	Paramètres de requête facultatifs en fonction desquels filtrer les résultats.	`limit=1`

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/fallback-offer;version=0.1&limit=1' \
  -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}'

Utilisation des paramètres de requête

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

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 `+ - = && \|\| > < ! ( ) { } [ ] ^ \" ~ * ? : \ /` ont une signification spéciale et doivent être précédés d'une barre oblique inverse lorsqu'ils apparaissent dans la chaîne de requête.	`default`
`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`	Limitez le nombre d’offres de secours renvoyées.	`limit=5`

Réponse

Une réponse réussie renvoie une liste d’offres de secours présentes dans le conteneur auquel vous avez accès.

{
    "containerId": "e0bd8463-0913-4ca1-bd84-6309134ca1f6",
    "schemaNs": "https://ns.adobe.com/experience/offer-management/fallback-offer;version=0.1",
    "requestTime": "2023-10-22T07:12:30.923768Z",
    "_embedded": {
      "results": [
        {
                "instanceId": "053bc610-f8f9-11ea-ad6e-775ad2c9b1a1",
            "schemas": [
                    "https://ns.adobe.com/experience/offer-management/fallback-offer;version=0.5"
            ],
                "productContexts": [
                    "acp"
                ],
                "repo:etag": 3,
                "repo:createdDate": "2023-09-17T15:18:20.657299Z",
                "repo:lastModifiedDate": "2023-10-02T02:34:48.034583Z",
                "repo:createdBy": "{CREATED_BY}",
                "repo:lastModifiedBy": "{MODIFIED_BY}",
                "repo:createdByClientId": "{CREATED_CLIENT_ID}",
                "repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
                "_instance": {
                    "xdm:name": "F1: Web fallback ",
                    "xdm:representations": [
                {
                            "xdm:components": [
                        {
                                    "xdm:content": "aaa",
                                    "@type": "https://ns.adobe.com/experience/offer-management/content-component-json",
                                    "dc:format": "application/json",
                                    "repo:name": "aa"
                        }
                            ],
                            "xdm:channel": "https://ns.adobe.com/xdm/channel-types/web",
                            "xdm:placement": "xcore:offer-placement:122201b2150d98c2"
        },
        {
                            "xdm:components": [
                                {
                                    "xdm:content": "bb",
                                    "@type": "https://ns.adobe.com/experience/offer-management/content-component-html",
                                    "dc:format": "text/html",
                                    "repo:name": "bb"
                                }
            ],
                            "xdm:channel": "https://ns.adobe.com/xdm/channel-types/web",
                            "xdm:placement": "xcore:offer-placement:122201c34354a2b4"
                        },
                {
                            "xdm:components": [
                        {
                                    "xdm:deliveryURL": "https://mysite.com",
                                    "@type": "https://ns.adobe.com/experience/offer-management/content-component-imagelink",
                                    "dc:format": "image/png",
                                    "repo:name": "ll"
                        }
                            ],
                            "xdm:channel": "https://ns.adobe.com/xdm/channel-types/web",
                            "xdm:placement": "xcore:offer-placement:122207eddb05205a"
                }
            ],
                    "xdm:status": "approved",
                    "xdm:tags": [],
                    "@id": "xcore:fallback-offer:122206064e0d98df"
                },
                "_links": {
                    "self": {
                        "name": "https://ns.adobe.com/experience/offer-management/fallback-offer;version=0.5#053bc610-f8f9-11ea-ad6e-775ad2c9b1a1",
                        "href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/053bc610-f8f9-11ea-ad6e-775ad2c9b1a1",
                        "@type": "https://ns.adobe.com/experience/offer-management/fallback-offer;version=0.5"
                    }
                },
                "sandboxName": "ode-prod-va7-edge-testing"
        }
    ],
        "total": 5,
        "count": 1
    },
    "_links": {
        "self": {
            "href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?schema=https://ns.adobe.com/experience/offer-management/fallback-offer;version=0.1&limit=1",
            "@type": "https://ns.adobe.com/experience/xcore/hal/results"
        },
        "next": {
            "href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?start=053bc610-f8f9-11ea-ad6e-775ad2c9b1a1&orderby=instanceId&schema=https://ns.adobe.com/experience/offer-management/fallback-offer;version=0.1&limit=1",
            "@type": "https://ns.adobe.com/experience/xcore/hal/results"
        }
    }
}

recommendation-more-help