Uw Recommendations-catalogus beheren met behulp van API's

Laatst bijgewerkt: 14 november 2023

Gemaakt voor:

Ontwikkelaar

Terwijl u ervoor zorgt dat u voldoet aan de vereisten voor het gebruik van de Recommendations API, hebt u geleerd hoe te een toegangstoken genereren de JWT-verificatiestroom gebruiken om de Adobe Target Admin API's op de Adobe Developer Console.

U kunt nu de opdracht Recommendations API's om items toe te voegen, bij te werken of te verwijderen uit uw catalogus met aanbevelingen. Net als bij de andere Adobe Target Admin API's is verificatie vereist voor de Recommendations API's.

NOTE

Verzend de IMS: JWT Generate + Auth via User Token verzoek wanneer u uw toegangstoken voor authentificatie moet verfrissen, aangezien het na 24 uren verloopt. Zie API-verificatie voor Adobe configureren voor instructies.

JWT3ff

Haal voordat u verdergaat de Recommendations Postman-collectie.

Items maken en bijwerken met de API Entiteiten opslaan

Als u de Recommendations-productdatabase wilt vullen met behulp van de API in plaats van een CSV-productfeed of Target-aanvraag die wordt gestart op productpagina's, gebruikt u de optie Entiteiten-API opslaan. Met deze aanvraag wordt een item toegevoegd of bijgewerkt in één doelomgeving. De syntaxis is:

POST https://mc.adobe.io/{{TENANT_ID}}/target/recs/entities

Bijvoorbeeld, sparen Entiteiten kunnen worden gebruikt om punten bij te werken wanneer bepaalde drempels worden voldaan-zoals drempels voor inventaris of prijs-om die punten te markeren en hen te verhinderen worden geadviseerd.

Navigeren naar Target > Setup > Hosts > CONTROL Environments om identiteitskaart van het Milieu van het Doel te verkrijgen waarin u een punt wilt toevoegen of bijwerken.
Verifiëren TENANT_ID en API_KEY verwijzen naar de eerder vastgestelde Postman-omgevingsvariabelen. Gebruik de onderstaande afbeelding om deze te vergelijken. Wijzig zo nodig de koppen en het pad in de API-aanvraag, zodat deze overeenkomen met de waarden in de onderstaande afbeelding.

Voer uw JSON in als ruw code in de Lichaam. Vergeet niet uw milieu-id op te geven met de environment variabele. (In het onderstaande voorbeeld is de milieu-id 6781.)

Hieronder ziet u een voorbeeld van JSON waarmee entiteit.id kit2001 wordt toegevoegd aan de bijbehorende entiteitswaarden voor een product van Toaster Oven, in omgeving 6781.

    {
    "entities": [{
            "name": "Toaster Oven",
            "id": "kit2001",
            "environment": 6781,
            "categories": [
                "housewares:appliances"
            ],
            "attributes": {
                "inventory": 77,
                "margin": 23,
                "message": "crashing helicopter",
                "pageUrl": "www.foobar.foo.com/helicopter.html",
                "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg",
               "value": 19.2
            }
        }]
    }

Klik op Send. U dient het volgende antwoord te ontvangen.

Het JSON-object kan worden geschaald om meerdere producten te verzenden. In deze JSON worden bijvoorbeeld twee entiteiten opgegeven.

    {
        "entities": [{
                "name": "Toaster Oven",
                "id": "kit2001",
                "environment": 6781,
                "categories": [
                    "housewares:appliances"
                ],
                "attributes": {
                    "inventory": 89,
                    "margin": 11,
                    "message": "Toaster Oven",
                    "pageUrl": "www.foobar.foo.com/helicopter.html",
                    "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg",
                    "value": 102.5
                }
            },
            {
                "name": "Blender",
                "id": "kit2002",
                "environment": 6781,
                "categories": [
                    "housewares:appliances"
                ],
                "attributes": {
                    "inventory": 36,
                    "margin": 5,
                    "message": "Blender",
                    "pageUrl": "www.foobar.foo.com/helicopter.html",
                    "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg",
                    "value": 54.5
                }
            }
        ]
    }

Nu is het jouw beurt! Gebruik de Save Entities API om de volgende items aan uw catalogus toe te voegen. Gebruik het JSON-voorbeeld hierboven als beginpunt. (U moet de JSON uitbreiden tot extra entiteiten.)

Deze laatste twee items horen niet bij elkaar. Laten we ze controleren met de Get Entity API, en indien nodig, schrapt hen gebruikend Delete Entities API.

Itemdetails ophalen met de Get Entiteit API

Om de details van een bestaand punt terug te winnen, gebruik EntiteitsAPI ophalen. De syntaxis is:

GET https://mc.adobe.io/{{TENANT_ID}}/target/recs/entities/[entity.id]

De gegevens van de entiteit kunnen slechts voor één enkele entiteit tegelijkertijd worden teruggewonnen. Met Entiteit ophalen kunt u controleren of er updates zijn gemaakt in de catalogus zoals u had verwacht, of kunt u de inhoud van de catalogus op een andere manier controleren.

Geef in de API-aanvraag de id van de entiteit op met de variabele entityId. Het volgende voorbeeld zal details voor de entiteit terugkeren waarvan entiteitId=kit2004.
Verifiëren TENANT_ID en API_KEY verwijzen naar de eerder vastgestelde Postman-omgevingsvariabelen. Gebruik de onderstaande afbeelding om deze te vergelijken. Wijzig zo nodig de koppen en het pad in de API-aanvraag, zodat deze overeenkomen met de waarden in de onderstaande afbeelding.
Verzend de aanvraag.

Als er een fout optreedt die aangeeft dat de entiteit niet is gevonden, zoals in het bovenstaande voorbeeld wordt getoond, controleert u of u de aanvraag naar de juiste doelomgeving verzendt.

NOTE
Als geen milieu uitdrukkelijk wordt gespecificeerd, krijg de pogingen van de Entiteit om de entiteit van uw te krijgen standaardomgeving alleen. Als u van om het even welke milieu buiten uw standaardomgeving wenst te trekken, moet u milieu-identiteitskaart specificeren.
Voeg zo nodig de environmentId en de aanvraag opnieuw verzenden.
Nog een verzenden Get Entity verzoek, dit keer om de entiteit te inspecteren waarvan entiteitId=kit2005.

Stel dat u besluit dat deze entiteiten uit de catalogus moeten worden verwijderd. Laten we de Delete Entities API.

Items verwijderen met de API Entiteiten verwijderen

Als u items uit uw catalogus wilt verwijderen, gebruikt u de Entiteiten-API verwijderen. De syntaxis is:

DELETE https://mc.adobe.io/{{TENANT_ID}}/target/recs/entities?ids=[comma-delimited-entity-ids]&environment=[environmentId]

WARNING

Met de API Entiteiten verwijderen verwijdert u entiteiten waarnaar wordt verwezen door de id's die u opgeeft. Als er geen id's voor entiteiten zijn opgegeven, worden alle entiteiten in de opgegeven omgeving verwijderd. Als er geen milieu-id is opgegeven, worden entiteiten uit alle omgevingen verwijderd. Wees voorzichtig!

Navigeren naar Target > Setup > Hosts > Environments om identiteitskaart van het Milieu van het Doel te verkrijgen waaruit u punten wilt schrappen.
Geef in de API-aanvraag de entiteit-id's op van de entiteiten die u wilt verwijderen met behulp van de syntaxis &ids=[comma-delimited-entity-ids] (een queryparameter). Wanneer u meerdere entiteiten verwijdert, scheidt u de id's met komma's.
De milieu-id opgeven met de syntaxis &environment=[environmentId]anders worden entiteiten in alle omgevingen verwijderd.
Verifiëren TENANT_ID en API_KEY verwijzen naar de eerder vastgestelde Postman-omgevingsvariabelen. Gebruik de onderstaande afbeelding om deze te vergelijken. Wijzig zo nodig de koppen en het pad in de API-aanvraag, zodat deze overeenkomen met de waarden in de onderstaande afbeelding.
Verzend de aanvraag.
De resultaten verifiëren met Get Entity, die nu moet aangeven welke verwijderde entiteiten niet kunnen worden gevonden.

Gefeliciteerd! U kunt nu de Recommendations API's gebruiken om gegevens over de entiteiten in uw catalogus te maken, bij te werken, te verwijderen en op te halen. In de volgende sectie leert u hoe u aangepaste criteria kunt beheren.

<!— Volgende "Aangepaste criteria beheren" > —>

recommendation-more-help