DokumentationTarget Developer Guide

Hantera din Recommendations Catalog med API:er

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Skapat för:

  • Utvecklare

Du försäkrar dig om att du uppfyller kraven för att använda Recommendations API, men du lärde dig att generera en åtkomsttoken med JWT-autentiseringsflödet för att använda Adobe Target Admin API:er på Adobe Developer Console .

Du kan nu använda Recommendations API:er för att lägga till, uppdatera eller ta bort objekt i din rekommendationskatalog. Precis som med övriga Adobe Target Admin API:er kräver Recommendations API:er autentisering.

NOTE
Skicka IMS: JWT Generate + Auth via User Token-begäran när du behöver uppdatera din åtkomsttoken för autentisering, eftersom den upphör att gälla efter 24 timmar. Mer information finns i Konfigurera Adobe API-autentisering.

JWT3ff

Hämta Recommendations Postman-samlingen innan du fortsätter.

Skapa och uppdatera objekt med API:t för att spara enheter

Om du vill fylla i din Recommendations-produktdatabas med API:t i stället för en CSV-produktfeed eller Target-begäran som aktiveras på produktsidor använder du API:t för att spara entiteter. Den här begäran lägger till eller uppdaterar ett objekt i en enda målmiljö. Syntaxen:

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

Du kan till exempel använda Spara enheter för att uppdatera artiklar när vissa tröskelvärden har uppnåtts, t.ex. tröskelvärden för lager eller pris, för att flagga dessa artiklar och förhindra att de rekommenderas.

  1. Navigera till Target > Setup > Hosts > CONTROL Environments för att hämta det målmiljö-ID där du vill lägga till eller uppdatera ett objekt.

    SaveEntities1

  2. Verifiera att TENANT_ID och API_KEY refererar till de Postman-miljövariabler som upprättats tidigare. Använd bilden nedan för att jämföra. Om det behövs kan du ändra rubrikerna och sökvägen i din API-begäran så att de matchar dem i bilden nedan.

    SaveEntities3

  3. Ange din JSON som raw-kod i Body. Glöm inte att ange ditt miljö-ID med variabeln environment. (I exemplet nedan är miljö-ID 6781.)

    SaveEntities4.png

    Nedan visas exempel-JSON som lägger till entity.id kit2001 med associerade enhetsvärden för en Toaster Oven-produkt i miljö 6781.

    code language-none 
        {
    "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
            }
        }]
    }

  4. Klicka på Send. Du bör få följande svar.

    SaveEntities5.png

    JSON-objektet kan skalas för att skicka flera produkter. Denna JSON anger till exempel två enheter.

    code language-none 
        {
        "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
                }
            }
        ]
    }

  5. Nu är det din tur! Använd API:t Save Entities för att lägga till följande objekt i katalogen. Använd JSON-exempelkoden ovan som utgångspunkt. (Du måste utöka JSON för att inkludera ytterligare entiteter.)

    SaveEntities6.png

De sista två objekten hör inte hemma. Låt oss inspektera dem med API:t Get Entity och vid behov ta bort dem med API:t Delete Entities.

Hämta objektinformation med Get Entity API

Om du vill hämta information om ett befintligt objekt använder du Get Entity API. Syntaxen:

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

Det går bara att hämta entitetsinformation för en enskild entitet åt gången. Du kan använda Hämta entitet för att bekräfta att uppdateringar har gjorts i katalogen som förväntat, eller för att på annat sätt granska innehållet i katalogen.

  1. Ange enhets-ID i API-begäran med variabeln entityId. Följande exempel returnerar information för den entitet vars entityId=kit2004.

    GetEntity1

  2. Verifiera att TENANT_ID och API_KEY refererar till de Postman-miljövariabler som upprättats tidigare. Använd bilden nedan för att jämföra. Om det behövs kan du ändra rubrikerna och sökvägen i din API-begäran så att de matchar dem i bilden nedan.

    GetEntity2

  3. Skicka begäran.

    GetEntity3
    Om du får ett felmeddelande om att enheten inte hittades, som visas i exemplet ovan, kontrollerar du att du skickar begäran till rätt målmiljö.

    note note
    NOTE
    Om ingen miljö uttryckligen anges försöker Get Entity att hämta entiteten enbart från din standardmiljö. Om du vill hämta från någon annan miljö än standardmiljön måste du ange miljö-ID:t.

  4. Om det behövs lägger du till parametern environmentId och skickar begäran igen.

    GetEntity4

  5. Skicka ytterligare en Get Entity-begäran, den här gången för att inspektera entiteten vars entityId=kit2005.

    GetEntity5

Anta att du måste ta bort de här entiteterna från katalogen. Låt oss använda Delete Entities-API:t.

Ta bort objekt med API:t Ta bort entiteter

Om du vill ta bort objekt från katalogen använder du API:t Ta bort entiteter. Syntaxen:

DELETE https://mc.adobe.io/{{TENANT_ID}}/target/recs/entities?ids=[comma-delimited-entity-ids]&environment=[environmentId]
WARNING
API:t Ta bort entiteter tar bort entiteter som refereras av de ID som du anger. Om inga enhets-ID anges tas alla enheter i den angivna miljön bort. Om inget miljö-ID anges tas enheter bort från alla miljöer. Använd det här med försiktighet!

  1. Navigera till Target > Setup > Hosts > Environments för att hämta det målmiljö-ID som du vill ta bort objekt från.

    DeleteEntities1

  2. I API-begäran anger du enhets-ID för de entiteter som du vill ta bort med syntaxen &ids=[comma-delimited-entity-ids] (en frågeparameter). Om du tar bort mer än en enhet avgränsar du ID:n med kommatecken.

    DeleteEntities2

  3. Ange miljö-ID med syntaxen &environment=[environmentId], annars tas entiteter bort i alla miljöer.

    DeleteEntities3

  4. Verifiera att TENANT_ID och API_KEY refererar till de Postman-miljövariabler som upprättats tidigare. Använd bilden nedan för att jämföra. Om det behövs kan du ändra rubrikerna och sökvägen i din API-begäran så att de matchar dem i bilden nedan.

    DeleteEntities4

  5. Skicka begäran.

    DeleteEntities5

  6. Verifiera dina resultat med Get Entity, som nu bör ange att det inte går att hitta de borttagna entiteterna.

    DeleteEntities6

    DeleteEntities6

Grattis! Nu kan du använda Recommendations API:er för att skapa, uppdatera, ta bort och få information om enheterna i din katalog. I nästa avsnitt får du lära dig hur du hanterar anpassade villkor.

<!— Nästa "Hantera anpassade villkor" > —>

recommendation-more-help
6906415f-169c-422b-89d3-7118e147c4e3