Evalueer en open de resultaten van de segmentdefinitie

Dit document bevat een zelfstudie voor het evalueren van segmentdefinities en het openen van deze resultaten met de Segmentation API .

Aan de slag

Deze zelfstudie vereist een goed begrip van de verschillende Adobe Experience Platform -services die betrokken zijn bij het maken van een publiek. Voordat u met deze zelfstudie begint, raadpleegt u de documentatie voor de volgende services:

Vereiste koppen

Dit leerprogramma vereist u ook om het authentificatieleerprogrammate voltooien om vraag aan Platform APIs met succes te maken. 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:

Alle bronnen in Experience Platform zijn geïsoleerd naar specifieke virtuele sandboxen. Voor aanvragen van Platform API's is een header vereist die de naam aangeeft van de sandbox waarin de bewerking plaatsvindt:

Alle POST, PUT, en PATCH verzoeken vereisen een extra kopbal:

Een segmentdefinitie evalueren evaluate-a-segment

Zodra u hebt ontwikkeld, getest en uw segmentdefinitie bewaard, kunt u de segmentdefinitie door of geplande evaluatie of op bestelling evaluatie dan evalueren.

Geplande evaluatie(ook genoemd geworden "geplande segmentatie"wordt bekend) staat u toe om een terugkomende planning voor het runnen van een uitvoerbaan in een specifieke tijd tot stand te brengen, terwijl op bestelling evaluatieimpliceert het creëren van een segmentbaan om het publiek onmiddellijk te bouwen. De stappen voor elk worden hieronder geschetst.

Als u nog niet hebt voltooid creeer een segmentdefinitie gebruikend de Segmentatie APIleerprogramma of creeerde een segmentdefinitie gebruikend de Bouwer van het Segment, gelieve dit te doen alvorens met dit leerprogramma te werk te gaan.

Geplande evaluatie scheduled-evaluation

Door geplande evaluatie, kan uw organisatie een terugkomende planning tot stand brengen om de uitvoerbanen automatisch in werking te stellen.

Een schema maken

Door een verzoek van de POST aan het /config/schedules eindpunt te doen, kunt u een programma tot stand brengen en de specifieke tijd omvatten wanneer het programma zou moeten worden teweeggebracht.

Meer gedetailleerde informatie over het gebruiken van dit eindpunt kan in de gids van het planningseindpuntworden gevonden

Een schema inschakelen

Een schema is standaard niet actief wanneer het wordt gemaakt, tenzij de eigenschap state is ingesteld op active in de aanvraagtekst (POST) create. U kunt een schema inschakelen (stel state in op active ) door een PATCH-aanvraag in te dienen bij het /config/schedules -eindpunt en de id van het schema op te nemen in het pad.

Meer gedetailleerde informatie over het gebruiken van dit eindpunt kan in de gids van het planningseindpuntworden gevonden

Werk de planningstijd bij

De timing van het programma kan worden bijgewerkt door een verzoek van de PATCH aan het /config/schedules eindpunt en met inbegrip van identiteitskaart van het programma in de weg te doen.

Meer gedetailleerde informatie over het gebruiken van dit eindpunt kan in de gids van het planningseindpuntworden gevonden

Evaluatie op aanvraag

De evaluatie op bestelling staat u toe om een segmentbaan tot stand te brengen om een publiek te produceren wanneer u het vereist. In tegenstelling tot geplande evaluatie, zal dit slechts gebeuren wanneer gevraagd en niet terugkerend.

Een segmenttaak maken

Een segmentbaan is een asynchroon proces dat tot een publiekssegment op bestelling leidt. Het verwijst naar een segmentdefinitie en naar elk samenvoegbeleid dat bepaalt hoe Real-Time Customer Profile overlappende kenmerken in uw profielfragmenten samenvoegt. Wanneer een segmentbaan met succes voltooit, kunt u diverse informatie over de segmentdefinitie, zoals om het even welke fouten verzamelen die tijdens verwerking en de uiteindelijke grootte van uw publiek kunnen zijn voorgekomen. Een segmentbaan moet in werking worden gesteld telkens als u het publiek wilt verfrissen dat de segmentdefinitie momenteel kwalificeert.

U kunt een nieuwe segmenttaak maken door een aanvraag voor een POST in te dienen bij het eindpunt /segment/jobs in de Real-Time Customer Profile API.

De meer gedetailleerde informatie over het gebruiken van dit eindpunt kan in de gids van het segmentbaneneindpuntworden gevonden

Status segmenttaak opzoeken

U kunt id voor een specifieke segmentbaan gebruiken om een raadplegingsverzoek (GET) uit te voeren om de huidige status van de baan te bekijken.

De meer gedetailleerde informatie over het gebruiken van dit eindpunt kan in de gids van het segmentbaneneindpuntworden gevonden

Resultaten van segmenttaken interpreteren

Wanneer segmenttaken zijn uitgevoerd, wordt de segmentMembership -kaart bijgewerkt voor elk profiel dat is opgenomen in de segmentdefinitie. segmentMembership slaat ook vooraf beoordeelde soorten publiek op die in Platform worden opgenomen, zodat deze kunnen worden geïntegreerd met andere oplossingen, zoals Adobe Audience Manager .

In het volgende voorbeeld wordt getoond hoe het kenmerk segmentMembership er uitziet voor elke afzonderlijke profielrecord:

{
  "segmentMembership": {
    "UPS": {
      "04a81716-43d6-4e7a-a49c-f1d8b3129ba9": {
        "timestamp": "2018-04-26T15:52:25+00:00",
        "status": "realized"
      },
      "53cba6b2-a23b-454a-8069-fc41308f1c0f": {
        "lastQualificationTime": "2018-04-26T15:52:25+00:00",
        "status": "realized"
      }
    },
    "Email": {
      "abcd@adobe.com": {
        "lastQualificationTime": "2017-09-26T15:52:25+00:00",
        "status": "exited"
      }
    }
  }
}

Resultaten van segmenttaken openen

De resultaten van een segmentbaan kunnen op één van twee manieren worden betreden: u kunt tot individuele profielen toegang hebben of een volledig publiek naar een dataset uitvoeren.

In de volgende secties worden deze opties gedetailleerder beschreven.

Een profiel opzoeken

Als u het specifieke profiel kent waartoe u toegang wilt hebben, kunt u dit doen door de Real-Time Customer Profile API te gebruiken. De volledige stappen voor de toegang tot van individuele profielen zijn beschikbaar in de Realtime gegevens van het Profiel van de Klant van de Toegang gebruikend het profiel APIleerprogramma.

Een segment exporteren export

Nadat een segmentatietaak is voltooid (de waarde van het kenmerk status is "SUCCEEDED"), kunt u uw publiek exporteren naar een dataset waar toegang tot de taak mogelijk is en waarop u kunt reageren.

De volgende stappen zijn vereist om uw publiek te exporteren:

Een doelgegevensset maken create-dataset

Wanneer het uitvoeren van een publiek, moet een doeldataset eerst worden gecreeerd. Het is belangrijk dat de dataset correct wordt gevormd om de uitvoer succesvol te verzekeren.

Één van de belangrijkste overwegingen is het schema waarop de dataset (schemaRef.id in het API steekproefverzoek hieronder) wordt gebaseerd. Om een segmentdefinitie uit te voeren, moet de dataset op XDM Individual Profile Union Schema (https://ns.adobe.com/xdm/context/profile__union) worden gebaseerd. Een verenigingsschema is een systeem-geproduceerd, read-only schema dat de gebieden van schema's samenvoegt die de zelfde klasse delen, in dit geval dat de Individuele klasse van het Profiel XDM is. Voor meer informatie over de schema's van de verenigingsmening, zie gelieve de sectie van het Profiel van de Klant in real time van de Ontwikkelaar van het Registratie van het Schema gids.

Er zijn twee manieren om de noodzakelijke dataset tot stand te brengen:

Als u reeds een compatibele dataset hebt en zijn identiteitskaart kent, kunt u aan de stap voor direct te werk gaan die publieksprofielenproduceert.

API formaat

POST /dataSets

Verzoek

Het volgende verzoek leidt tot een nieuwe dataset, die configuratieparameters in de lading verstrekken.

curl -X POST \
  https://platform.adobe.io/data/foundation/catalog/dataSets \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "name": "Segment Export",
    "schemaRef": {
        "id": "https://ns.adobe.com/xdm/context/profile__union",
        "contentType": "application/vnd.adobe.xed+json;version=1"
    }
}'

Reactie

Een succesvolle reactie keert een serie terug die read-only, systeem-geproduceerde unieke identiteitskaart van de pas gecreëerde dataset bevat. Een behoorlijk gevormde dataset identiteitskaart wordt vereist om publieksleden met succes uit te voeren.

[
  "@/datasets/5b020a27e7040801dedba61b"
]

Profielen genereren voor publieksleden generate-profiles

Zodra u een unie-persisterende dataset hebt, kunt u een de uitvoerbaan tot stand brengen om de publieksleden aan de dataset door een verzoek van de POST aan het /export/jobs eindpunt in Real-Time Customer Profile API voort te zetten en de dataset ID en de informatie van de segmentdefinitie voor de segmentdefinities te verstrekken die u wenst uit te voeren.

De meer gedetailleerde informatie over het gebruiken van dit eindpunt kan in de gids van het de baneneindpunt van de uitvoertakenworden gevonden

Exportvoortgang volgen

Tijdens het uitvoeren van een exporttaak kunt u de status controleren door een aanvraag voor een GET in te dienen bij het eindpunt van /export/jobs en de id van de exporttaak op te nemen in het pad. De exporttaak is voltooid wanneer het veld status de waarde "SUCCEEDED" retourneert.

De meer gedetailleerde informatie over het gebruiken van dit eindpunt kan in de gids van het de baneneindpunt van de uitvoertakenworden gevonden

Volgende stappen

Nadat het exporteren is voltooid, zijn uw gegevens beschikbaar in de map Data Lake in Experience Platform . U kunt Data Access API dan gebruikenom tot de gegevens toegang te hebben gebruikend batchId verbonden aan de uitvoer. Afhankelijk van de grootte van de segmentdefinitie, kunnen de gegevens in brokken zijn en de partij kan uit verscheidene dossiers bestaan.

Voor geleidelijke instructies op hoe te om Data Access API te gebruiken om tot partijdossiers toegang te hebben en te downloaden, volg het leerprogramma van de Toegang van Gegevens.

U kunt geëxporteerde segmentdefinitiegegevens ook benaderen met Adobe Experience Platform Query Service . Met de UI of RESTful API kunt u in Query Service query's schrijven, valideren en uitvoeren op gegevens binnen Data Lake .

Raadpleeg de documentatie bij Query Service voor meer informatie over het uitvoeren van query's op publieksgegevens.