Evalueer en open de resultaten van de segmentdefinitie

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

Aan de slag

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

  • Real-Time Customer Profile: Verstrekt een verenigd, klantenprofiel in echt - tijd die op bijeengevoegde gegevens van veelvoudige bronnen wordt gebaseerd.
  • Adobe Experience Platform Segmentation Service: Hiermee kunt u een publiek opbouwen op Real-Time Customer Profile gegevens.
  • Experience Data Model (XDM): Het gestandaardiseerde kader waardoor Platform gegevens van de klantenervaring organiseert. Als u de segmentatie het beste wilt gebruiken, moet u ervoor zorgen dat uw gegevens als profielen en gebeurtenissen worden opgenomen volgens de best practices voor gegevensmodellering.
  • Sandboxen: Experience Platform biedt virtuele sandboxen die één enkele partitie maken Platform in afzonderlijke virtuele omgevingen om toepassingen voor digitale ervaringen te ontwikkelen en te ontwikkelen.

Vereiste koppen

Voor deze zelfstudie hebt u ook het volgende nodig: verificatiezelfstudie om met succes vraag te maken aan Platform API's. Het voltooien van de zelfstudie over verificatie biedt de waarden voor elk van de vereiste kopteksten in alle Experience Platform API-aanroepen, zoals hieronder wordt getoond:

  • Toestemming: houder {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. Verzoeken om Platform API's vereisen een header die de naam aangeeft van de sandbox waarin de bewerking plaatsvindt:

  • x-sandbox-name: {SANDBOX_NAME}
NOTE
Voor meer informatie over sandboxen in Platform, zie de overzichtsdocumentatie van sandbox.

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

  • Inhoudstype: application/json

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 wel 'geplande segmentatie' genoemd) kunt u een terugkerend schema maken voor het uitvoeren van een exporttaak op een bepaald moment, terwijl evaluatie op aanvraag betekent dat u een segmenttaak maakt om het publiek direct op te bouwen. De stappen voor elk worden hieronder geschetst.

Als u nog niet de een segmentdefinitie maken met de segmentatie-API zelfstudie of definitie van segment maken met Segment Builder, doe dit voordat u verdergaat met deze zelfstudie.

Geplande evaluatie scheduled-evaluation

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

NOTE
De geplande evaluatie kan voor zandbakken met een maximum van vijf (5) fusiebeleid voor worden toegelaten XDM Individual Profile. Als uw organisatie meer dan vijf samenvoegbeleidsregels heeft voor XDM Individual Profile binnen één sandboxomgeving kunt u geen geplande evaluatie gebruiken.

Een schema maken

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

Meer gedetailleerde informatie over het gebruik van dit eindpunt vindt u in de plannings eindgids

Een schema inschakelen

Een schema is standaard inactief wanneer het wordt gemaakt, tenzij het state eigenschap is ingesteld op active in de create (POST) aanvraaginstantie. U kunt een programma inschakelen (stel de state tot active) door een PATCH-verzoek aan de /config/schedules en met inbegrip van identiteitskaart van het programma in de weg.

Meer gedetailleerde informatie over het gebruik van dit eindpunt vindt u in de plannings eindgids

Werk de planningstijd bij

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

Meer gedetailleerde informatie over het gebruik van dit eindpunt vindt u in de plannings eindgids

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 evenals om het even welk samenvoegbeleid dat controleert hoe Real-Time Customer Profile Hiermee voegt u overlappende kenmerken samen in uw profielfragmenten. 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 segmentbaan tot stand brengen door een verzoek van de POST aan /segment/jobs in de Real-Time Customer Profile API.

Meer gedetailleerde informatie over het gebruik van dit eindpunt vindt u in de eindgids voor segmenttaken

Status segmenttaak opzoeken

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

Meer gedetailleerde informatie over het gebruik van dit eindpunt vindt u in de eindgids voor segmenttaken

Resultaten van segmenttaken interpreteren

Wanneer segmenttaken correct worden uitgevoerd, wordt segmentMembership De kaart wordt bijgewerkt voor elk profiel inbegrepen binnen de segmentdefinitie. segmentMembership slaat ook om het even welk vooraf geëvalueerd publiek op dat in wordt opgenomen Platform, waardoor integratie met andere oplossingen zoals Adobe Audience Manager.

In het volgende voorbeeld wordt getoond wat de segmentMembership Het kenmerk ziet er zo uit 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"
      }
    }
  }
}
Eigenschap
Beschrijving
lastQualificationTime
Het tijdstempel waarin de bevestiging van segmentlidmaatschap werd gemaakt en het profiel de segmentdefinitie inging of verwierp.
status

De deelnamestatus van de segmentdefinitie als onderdeel van de huidige aanvraag. Moet gelijk zijn aan een van de volgende bekende waarden:

  • realized: Entiteit komt in aanmerking voor de segmentdefinitie.
  • exited: Entiteit sluit de segmentdefinitie af.
NOTE
Om het even welk segmentlidmaatschap dat in is exited gedurende meer dan 30 dagen, op basis van de lastQualificationTime, worden geschrapt.

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 Real-Time Customer Profile API. De volledige stappen voor toegang tot individuele profielen zijn beschikbaar in het dialoogvenster Toegang krijgen tot realtime klantprofielgegevens met de profiel-API zelfstudie.

Een segment exporteren export

Nadat een segmentatietaak is voltooid (de waarde van de opdracht status attribuut is "SUCCEEDED"), kunt u uw publiek naar een dataset uitvoeren waar het kan worden betreden en op gehandeld.

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 wordt gebaseerd (schemaRef.id in de API voorbeeldaanvraag hieronder). Om een segmentdefinitie uit te voeren, moet de dataset op XDM Individual Profile Union Schema (https://ns.adobe.com/xdm/context/profile__union). 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 uniview, gelieve te zien Realtime sectie van het Profiel van de Klant van de Klant van het Registratie van het Schema ontwikkelaarsgids.

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

  • API's gebruiken: De stappen die in deze zelfstudie volgen schetsen hoe te om een dataset tot stand te brengen die verwijzingen XDM Individual Profile Union Schema met de Catalog API.
  • De gebruikersinterface gebruiken: Als u de opdracht Adobe Experience Platform gebruikersinterface om een dataset tot stand te brengen die verwijzingen het unieschema, de stappen in UI-zelfstudie en ga vervolgens terug naar deze zelfstudie om door te gaan met de stappen voor profielen voor publiek genereren.

Als u reeds een compatibele dataset hebt en zijn identiteitskaart kent, kunt u aan de stap rechtstreeks te werk gaan voor profielen voor publiek genereren.

API-indeling

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"
    }
}'
Eigenschap
Beschrijving
name
Een beschrijvende naam voor de gegevensset.
schemaRef.id
Identiteitskaart van de verenigingsmening (schema) dat de dataset zal worden geassocieerd met.

Antwoord

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 uitvoerbaan tot stand brengen om de publieksleden aan de dataset voort te zetten door een verzoek van de POST aan het /export/jobs in de Real-Time Customer Profile API en het verstrekken van dataset identiteitskaart en de informatie van de segmentdefinitie voor de segmentdefinities die u wenst uit te voeren.

Meer gedetailleerde informatie over het gebruik van dit eindpunt vindt u in de eindgebruikershandleiding exporttaken

Exportvoortgang volgen

Als exporttaakprocessen kunt u de status controleren door een GET-aanvraag in te dienen bij de /export/jobs en met inbegrip van de id van de exporttaak in het pad. De exporttaak is voltooid zodra de status retourneert de waarde "SUCCEEDED".

Meer gedetailleerde informatie over het gebruik van dit eindpunt vindt u in de eindgebruikershandleiding exporttaken

Volgende stappen

Nadat het exporteren is voltooid, zijn uw gegevens beschikbaar in het dialoogvenster Data Lake in Experience Platform. U kunt dan de Data Access API om toegang te krijgen tot de gegevens met de batchId die aan de export zijn gekoppeld. Afhankelijk van de grootte van de segmentdefinitie, kunnen de gegevens in brokken zijn en de partij kan uit verscheidene dossiers bestaan.

Voor stapsgewijze instructies over het gebruik van de Data Access API voor toegang tot en download batchbestanden Zelfstudie over gegevenstoegang.

U hebt ook toegang tot geëxporteerde segmentdefinitiegegevens met Adobe Experience Platform Query Service. Gebruikend UI of RESTful API, Query Service staat u toe om, vragen over gegevens te schrijven te bevestigen en in werking te stellen binnen Data Lake.

Voor meer informatie over het vragen van publieksgegevens raadpleegt u de documentatie over Query Service.

recommendation-more-help
770bc05d-534a-48a7-9f07-017ec1e14871