Aanbevelingen ophalen met de leverings-API
De API's voor Adobe Target- en Adobe Target-aanbevelingen kunnen worden gebruikt om reacties op webpagina's te leveren, maar kunnen ook worden gebruikt in ervaringen die niet op HTML zijn gebaseerd, zoals apps, schermen, consoles, e-mails, kiosken en andere weergaveapparaten. Met andere woorden, wanneer de bibliotheken van het Doel en JavaScript niet kunnen worden gebruikt, laat Levering API van het Doelnog toegang tot de volledige waaier van de functionaliteit van het Doel toe, om gepersonaliseerde ervaringen te leveren.
Als u aanbevelingen wilt opvragen, stuurt u een POST-aanroep van de Adobe Target Delivery API met de relevante contextafhankelijke informatie. Deze kan een gebruikers-id bevatten (voor gebruik met profielspecifieke aanbevelingen zoals de onlangs bekeken items van de gebruiker), relevante mbox-naam, mbox-parameters, profielparameters of andere kenmerken. De reactie zal geadviseerde entiteit.ids (en kan andere entiteitgegevens omvatten) in formaat JSON of HTML omvatten, die dan in het apparaat kan worden getoond.
De Levering APIvoor Adobe Target stelt alle bestaande eigenschappen bloot die een standaardverzoek van het Doel verstrekt.
De leverings-API:
- Laat u toe om ervaringen of aanbiedingen voor een plaats en een publiek op een RESTful manier terug te winnen.
- Geen verificatie vereist.
- Alleen POST's.
- Verwerkt geen cookies of richt geen aanroepen om.
- Vereist of herkent geen "gebruikersrollen." Het haalt eenvoudig inhoud op of rapporteert gebeurtenissen aan de Edge-servers van het Doel.
De leverings-API gebruiken om de ervaringen van het Doel-met inbegrip van aanbevelingen-te leveren:
- Creeer een activiteit van het Doel (A/B, XT, AP, of Aanbevelingen) gebruikend Form-Based Composer (niet de Visuele Composer van de Ervaring).
- Gebruik de leverings-API om een reactie op te halen voor de aanvragen die worden gegenereerd door de doelactiviteit die u zojuist hebt gemaakt.
<!— Q: Waarom zijn BEIDE stappen hiervoor nodig? Als u een op vorm-Gebaseerde aanbeveling hebt die voor een mbox wordt bepaald, wat is het punt/voordeel van OOK het hebben van de stap van levering API binnen om resultaten terug te winnen? Waarom kunt u niet enkel op vorm-gebaseerde Rec de resultaten in het bestemmingsapparaat…? hebben? A: Zie onderstaande kwestie gebruiken… Het is wanneer u de hangende resultaten wilt "onderscheppen"om meer te doen alvorens de resultaten te tonen. Dingen zoals vergelijkingen in real time met inventarisniveaus. —>
Een aanbeveling maken met de Form-based Experience Composer
Om aanbevelingen tot stand te brengen die met levering API kunnen worden gebruikt, gebruik op vorm-gebaseerde Composer.
-
Maak eerst een JSON-ontwerp en sla dit op dat u in uw aanbeveling wilt gebruiken. Voor steekproef JSON, plus achtergrondinformatie betreffende hoe de reacties JSON kunnen zijn teruggekeerd wanneer het vormen van een op vorm-gebaseerde activiteit, zie de documentatie bij Creërend de Ontwerpen van de Aanbeveling. In dit voorbeeld, wordt het ontwerp genoemd Eenvoudige JSON.
-
Navigeer in Doel naar Activities > Create Activity > Recommendations en selecteer vervolgens Form .
-
Selecteer een eigenschap en klik op Next .
-
Bepaal de plaats waar u gebruikers de reactie van de aanbeveling wilt ontvangen. Het voorbeeld gebruikt hieronder een plaats genoemd api_charter. Selecteer uw op JSON-Gebaseerd ontwerp, vroeger gecreeerd, genoemd Eenvoudige JSON.
-
Sla de aanbeveling op en activeer deze. Het zal resultaten opleveren. Zodra de resultaten klaarzijn, kunt u levering API gebruiken om hen terug te winnen.
De API voor aflevering gebruiken
De syntaxis voor Levering APIis:
POST https://{{CLIENT_CODE}}.tt.omtrdc.net/rest/v1/delivery
-
Let op: de clientcode is vereist. Ter herinnering, uw clientcode kunt u vinden in Adobe Target door naar Recommendations > Settings te navigeren. Noteer de waarde van de Code van de 0} Cliënt in de Symbolische van Aanbeveling API sectie.
-
Zodra u uw cliëntcode hebt, construeer uw levering API vraag. Het voorbeeld hieronder begint met Web Batched Mboxes Delivery API Call die in de levering API inzameling van Postmanwordt verstrekt, die relevante wijzigingen aanbrengen. Bijvoorbeeld:
-
de browser en adres voorwerpen werden verwijderd uit het Lichaam, aangezien zij niet voor niet-HTML gebruiksgevallen worden vereist
-
api_charter is vermeld als plaatsnaam in dit voorbeeld
-
de entiteit.id wordt opgegeven, omdat deze aanbeveling is gebaseerd op Content Gelijksheid, waarvoor een huidige itemsleutel moet worden doorgegeven aan Target.
Herinner me om uw vraagparameters correct te vormen. Stel bijvoorbeeld dat u{{CLIENT_CODE}}opgeeft als dat nodig is. <!— Q: In de bijgewerkte vraagsyntaxis, wordt entity.id vermeld als profileParameter in plaats van een mboxParameter zoals in oudere versies. —> <!— Q: Oude beeld
-
-
Verzend de aanvraag. Dit voert tegen api_charter plaats uit, die een actieve aanbeveling heeft die op het loopt, die met uw ontwerp JSON wordt bepaald dat een lijst van geadviseerde entiteiten zal uitvoeren.
-
Ontvang een reactie op basis van het JSON-ontwerp.
De reactie omvat de sleutel-id en de entiteit-id's van de aanbevolen entiteiten.
Als u de API voor levering op deze manier gebruikt met aanbevelingen, kunt u aanvullende stappen uitvoeren voordat u aanbevelingen weergeeft aan de bezoeker op het niet-HTML-apparaat. U kunt bijvoorbeeld de reactie van de API voor aflevering gebruiken om een extra, realtime zoekopdracht uit te voeren naar de details van de entiteitskenmerken (inventarisatie, prijs, classificatie, enzovoort) van een ander systeem (zoals een CMS-, PIM- of e-commerce-platform) voordat u de uiteindelijke resultaten weergeeft.
Met behulp van de aanpak die in deze handleiding wordt beschreven, kunt u elke toepassing gebruiken om de reactie van Target te benutten en persoonlijke aanbevelingen te doen!
Voorbeeldimplementaties
De volgende bronnen bieden voorbeelden van verschillende implementaties die niet gericht zijn op HTML. Houd er rekening mee dat elke implementatie uniek zal zijn, vanwege het systeem en de apparaten in kwestie.
Installatie van aanbevelingen beheren met API's
Meestal worden aanbevelingen geconfigureerd in de gebruikersinterface van Adobe Target en vervolgens gebruikt of benaderd via de doel-API's, om redenen zoals die vermeld zijn in de bovenstaande secties. Deze UI-API-coördinatie komt veel voor. Soms willen gebruikers echter wel alle handelingen uitvoeren via API's, zowel de setup als het gebruik van resultaten. Hoewel veel minder gemeenschappelijk, kunnen de gebruikers absoluut vormen, uitvoeren, en hefboomwerking de resultaten van aanbevelingen volledig gebruikend APIs.
Wij leerden in een vroegere sectiehoe te om de entiteiten van de Aanbevelingen van Adobe Target te beheren en hen server-kant te leveren. Op dezelfde manier Adobe Developer Consolestaat u toe om criteria, bevorderingen, inzamelingen, en ontwerpmalplaatjes te beheren zonder het moeten login aan Adobe Target. Een volledige lijst van alle Aanbevelingen APIs kan hierworden gevonden, maar hier is een samenvatting voor verwijzing.
Referentiedocumentatie
Samenvatting en revisie
Gefeliciteerd! Door deze gids in te vullen, hebt u geleerd hoe te: