Creeer een segmentdefinitie gebruikend de Dienst API van de Segmentatie
Dit document biedt een zelfstudie voor het ontwikkelen, testen, voorvertonen en opslaan van een segmentdefinitie met de Adobe Experience Platform Segmentation Service API .
Voor informatie over hoe te om segmentdefinities te bouwen gebruikend het gebruikersinterface, gelieve de gids van de Bouwer van het Segmentte zien.
Aan de slag
Deze zelfstudie vereist een goed begrip van de verschillende Adobe Experience Platform -services die betrokken zijn bij het maken van segmentdefinities. Voordat u met deze zelfstudie begint, raadpleegt u de documentatie voor de volgende services:
- Real-Time Customer Profile: biedt een uniform, real-time consumentenprofiel dat is gebaseerd op geaggregeerde gegevens van meerdere bronnen.
- Adobe Experience Platform Segmentation Service: Staat u toe om publiek te bouwen gebruikend segmentdefinities of andere externe bronnen van gegevens van het Profiel van de Klant in real time.
- Experience Data Model (XDM): Het gestandaardiseerde framework waarmee Platform gegevens voor de klantervaring indeelt. Om het beste gebruik van Segmentatie te maken, gelieve te verzekeren uw gegevens als profielen en gebeurtenissen volgens de beste praktijken voor gegevens modelleringworden opgenomen.
De volgende secties bevatten aanvullende informatie die u moet weten om aanroepen naar de API's van Platform te kunnen uitvoeren.
API-voorbeeldaanroepen lezen
Deze zelfstudie biedt voorbeeld-API-aanroepen om aan te tonen hoe uw verzoeken moeten worden opgemaakt. Dit zijn paden, vereiste kopteksten en correct opgemaakte ladingen voor aanvragen. Voorbeeld-JSON die wordt geretourneerd in API-reacties, wordt ook verschaft. Voor informatie over de overeenkomsten die in documentatie voor steekproef API vraag worden gebruikt, zie de sectie op hoe te om voorbeeld API vraagin de Experience Platform het oplossen van problemengids te lezen.
Waarden verzamelen voor vereiste koppen
Om vraag aan Platform APIs te maken, moet u het authentificatieleerprogrammaeerst voltooien. Als u de zelfstudie over verificatie voltooit, krijgt u de waarden voor elk van de vereiste headers in alle API-aanroepen van Experience Platform , zoals hieronder wordt getoond:
- Autorisatie: Drager
{ACCESS_TOKEN} - x-api-key:
{API_KEY} - x-gw-ims-org-id:
{ORG_ID}
Alle bronnen in Experience Platform zijn geïsoleerd naar specifieke virtuele sandboxen. Alle aanvragen naar Platform API's vereisen een header die de naam van de sandbox opgeeft waarin de bewerking plaatsvindt:
- x-sandbox-name:
{SANDBOX_NAME}
Alle verzoeken die een nuttige lading (POST, PUT, PATCH) bevatten vereisen een extra kopbal:
- Inhoudstype: application/json
Een segmentdefinitie ontwikkelen
De eerste stap in segmentatie is een segmentdefinitie te bepalen. Een segmentdefinitie is een object dat een query omvat die is geschreven in Profile Query Language (PQL). Dit object wordt ook wel een PQL-voorspelling genoemd. PQL voorspelt de regels voor de segmentdefinitie op basis van voorwaarden die gerelateerd zijn aan record- of tijdreeksgegevens die u aan Real-Time Customer Profile opgeeft. Zie de gids van PQLvoor meer informatie bij het schrijven van de vragen van PQL.
U kunt een nieuwe segmentdefinitie maken door een aanvraag voor een POST in te dienen bij het eindpunt /segment/definitions in de Segmentation API. Het volgende voorbeeld schetst hoe te om een definitieverzoek te formatteren, die welke informatie wordt vereist opdat een segmentdefinitie met succes wordt bepaald.
Voor een gedetailleerde verklaring op hoe te om een segmentdefinitie te bepalen, te lezen gelieve de gids van de de ontwikkelaar van de segmentdefinitie.
Een publiek schatten en voorvertonen estimate-and-preview-an-audience
Terwijl u de segmentdefinitie ontwikkelt, kunt u de schatting- en voorvertoningsgereedschappen in Real-Time Customer Profile gebruiken om informatie op overzichtsniveau weer te geven, zodat u zeker weet dat u het verwachte publiek isoleert. Schattingen verschaffen statistische informatie over een segmentdefinitie, zoals de geprojecteerde publieksgrootte en het betrouwbaarheidsinterval. De voorproeven verstrekken gepagineerde lijsten van kwalificerende profielen voor een segmentdefinitie, die u toestaat om de resultaten tegen te vergelijken wat u verwacht.
Door een schatting en voorvertoning van uw publiek te maken, kunt u uw PQL-voorspellingen testen en optimaliseren totdat ze een gewenste uitkomst opleveren. Vervolgens kunt u deze gebruiken in een bijgewerkte segmentdefinitie.
Er zijn twee vereiste stappen om een voorvertoning van uw segmentdefinitie weer te geven of een schatting van uw segmentdefinitie te krijgen:
- Een voorbeeldtaak maken
- de schatting of voorproef van de Meninggebruikend identiteitskaart van de voorproefbaan
Hoe schattingen worden gegenereerd
Aangezien gegevens die voor het Profiel van de Klant in real time worden toegelaten in Platform worden opgenomen, wordt het opgeslagen binnen de gegevensopslag van het Profiel. Wanneer de opname van records in het archief Profiel het totale aantal profielen met meer dan 5% verhoogt of verlaagt, wordt een samplingtaak geactiveerd om het aantal bij te werken. Als het aantal profielen niet met meer dan 5% verandert, wordt de samplingtaak automatisch wekelijks uitgevoerd.
De wijze waarop het monster wordt geactiveerd, hangt af van het type inname dat wordt gebruikt:
- Voor het stromen gegevenswerkschema's, wordt een controle uitgevoerd op uurbasis om te bepalen als de 5% verhoging of dalingsdrempel is voldaan. Als aan deze drempel is voldaan, wordt automatisch een voorbeeldtaak geactiveerd om de telling bij te werken.
- Voor batch-opname wordt binnen 15 minuten na het correct innemen van een batch in de profielopslag een taak uitgevoerd om het aantal bij te werken als aan de drempel van 5% voor verhogen of verlagen is voldaan. Met behulp van de profiel-API kunt u een voorvertoning weergeven van de meest recente voorbeeldtaak en de distributie van het lijstprofiel via gegevensset en naamruimte op naam.
De voorbeeldgrootte is afhankelijk van het totale aantal entiteiten in de profielopslag. Deze steekproefgrootte wordt vertegenwoordigd in de volgende lijst:
De schattingen lopen over het algemeen over 10-15 seconden, beginnend met een ruwe schatting en raffinage aangezien meer verslagen worden gelezen.
Een voorbeeldtaak maken
U kunt een nieuwe voorproefbaan tot stand brengen door een verzoek van de POST aan het /preview eindpunt te doen.
De gedetailleerde instructies bij het creëren van een voorproefbaan kunnen in de voorproeven en de gids van ramingen eindpuntenworden gevonden.
Een schatting of voorvertoning weergeven
De schattings- en voorvertoningsprocessen worden asynchroon uitgevoerd, omdat verschillende query's verschillende tijdsduur kunnen duren. Nadat een query is gestart, kunt u API-aanroepen gebruiken om de huidige status van de schatting of voorvertoning tijdens het uitvoeren op te halen (GET).
Met de API Segmentation Service kunt u de huidige status van een voorbeeldtaak opzoeken aan de hand van de id. Als de status "RESULT_READY" is, kunt u de resultaten bekijken. Om omhoog de huidige staat van een voorproefbaan te kijken, te lezen gelieve de sectie op het terugwinnen van een sectie van de voorproefbaanin de voorproeven en de gids van ramingen eindpunten. Om omhoog de huidige staat van een geschatte baan te kijken, te lezen gelieve de sectie over het terugwinnen van een geschatte baanin de voorproeven en de gids van schattingen eindpunten.
Volgende stappen
Nadat u de segmentdefinitie hebt ontwikkeld, getest en opgeslagen, kunt u een segmenttaak maken om een publiek op te bouwen met de API Segmentation Service . Zie het leerprogramma op beoordelend en tot segmentresultatenvoor gedetailleerde stappen op hoe te om dit te verwezenlijken.