Het eindpunt van segmentexporttaken
De banen van de uitvoer zijn asynchrone processen die worden gebruikt om de leden van het publiekssegment aan datasets voort te zetten. U kunt het /export/jobs
eindpunt in de Adobe Experience Platform Segmentation API gebruiken, die u toestaat programmatically om, uitvoerbanen terug te winnen tot stand te brengen en te annuleren.
Aan de slag
De eindpunten die in deze handleiding worden gebruikt, maken deel uit van de API van Adobe Experience Platform Segmentation Service . Alvorens verder te gaan, te herzien gelieve begonnen gidsvoor belangrijke informatie die u moet kennen om vraag aan API met succes te maken, met inbegrip van vereiste kopballen en hoe te om voorbeeld API vraag te lezen.
Een lijst met exporttaken ophalen retrieve-list
U kunt een lijst van alle uitvoerbanen voor uw organisatie terugwinnen door een verzoek van de GET tot het /export/jobs
eindpunt te richten.
API formaat
Het /export/jobs
eindpunt steunt verscheidene vraagparameters helpen uw resultaten filtreren. Hoewel deze parameters optioneel zijn, wordt het gebruik ervan sterk aanbevolen om kostbare overhead te helpen verminderen. Het maken van een vraag aan dit eindpunt zonder parameters zal alle uitvoerbanen beschikbaar voor uw organisatie terugwinnen. De veelvoudige parameters kunnen worden omvat, die door ampersands (&
) worden gescheiden.
GET /export/jobs
GET /export/jobs?{QUERY_PARAMETERS}
de parameters van de Vraag
table 0-row-3 1-row-3 2-row-3 3-row-3 | ||
---|---|---|
Parameter | Beschrijving | Voorbeeld |
limit |
Hiermee geeft u het aantal geretourneerde exporttaken op. | limit=10 |
offset |
Hiermee bepaalt u de verschuiving van de resultatenpagina's. | offset=1540974701302_96 |
status |
Hiermee filtert u de resultaten op basis van de status. De ondersteunde waarden zijn NEW, SUCCEEDED en FAILED. | status=NEW |
Verzoek
Het volgende verzoek zal de laatste twee uitvoerbanen binnen uw organisatie terugwinnen.
code language-shell |
---|
|
Reactie
De volgende reactie keert HTTP status 200 met een lijst van met succes voltooide uitvoerbanen terug, die op de vraagparameter wordt gebaseerd in de verzoekweg wordt verstrekt.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 | |
---|---|
Eigenschap | Beschrijving |
destination |
Doelgegevens voor de geëxporteerde gegevens:
|
fields |
Een lijst met de geëxporteerde velden, gescheiden door komma's. |
schema.name |
De naam van het schema verbonden aan de dataset waar het gegeven moet worden uitgevoerd. |
filter.segments |
De segmenten die worden geëxporteerd. De volgende velden worden opgenomen:
|
mergePolicy |
Voeg beleidsinformatie voor de uitgevoerde gegevens samen. |
metrics.totalTime |
Een veld dat de totale tijd aangeeft waarop de exporttaak is uitgevoerd. |
metrics.profileExportTime |
Een veld waarin de exporttijd van de profielen wordt aangegeven. |
page |
Informatie over de paginering van de gewenste exporttaken. |
link.next |
Een koppeling naar de volgende pagina met exporttaken. |
Een nieuwe exporttaak maken create
U kunt een nieuwe exportbaan tot stand brengen door een verzoek van de POST aan het /export/jobs
eindpunt te doen.
API formaat
POST /export/jobs
Verzoek
Het volgende verzoek leidt tot een nieuwe uitvoerbaan, die door de parameters wordt gevormd die in de lading worden verstrekt.
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 | |
---|---|
Eigenschap | Beschrijving |
fields |
Een lijst met de geëxporteerde velden, gescheiden door komma's. Als deze optie leeg blijft, worden alle velden geëxporteerd. |
mergePolicy |
Hier geeft u het samenvoegbeleid op dat van toepassing is op de geëxporteerde gegevens. Neem deze parameter op wanneer er meerdere segmenten worden geëxporteerd. Als deze optie niet wordt opgegeven, zal het exportbeleid hetzelfde zijn als het opgegeven segment. |
filter |
Een object dat aangeeft welke segmenten afhankelijk van de hieronder vermelde subeigenschappen in de exporttaak moeten worden opgenomen op basis van id, kwalificatietijd of ingangstijd. Als deze optie leeg blijft, worden alle gegevens geëxporteerd. |
filter.segments |
Hiermee geeft u de segmenten op die u wilt exporteren. Als u deze waarde weglaat, worden alle gegevens van alle profielen geëxporteerd. Accepteert een array van segmentobjecten die elk de volgende velden bevatten:
|
filter.segmentQualificationTime |
Filter op basis van segmentkwalificatietijd. De begintijd en/of eindtijd kunnen worden opgegeven. |
filter.segmentQualificationTime.startTime |
Begintijd van segmentkwalificatie voor een segment-id voor een bepaalde status. Er is geen filter voor de begintijd van een segment-id-kwalificatie opgegeven. Tijdstempel moet in RFC 3339formaat worden verstrekt. |
filter.segmentQualificationTime.endTime |
Eindtijd van segmentkwalificatie voor een segment-id voor een bepaalde status. Er is geen filter voor de eindtijd van een segment-id-kwalificatie opgegeven. Tijdstempel moet in RFC 3339formaat worden verstrekt. |
filter.fromIngestTimestamp |
Hiermee worden geëxporteerde profielen beperkt tot profielen die na deze tijdstempel zijn bijgewerkt. Tijdstempel moet in RFC 3339formaat worden verstrekt.
|
filter.emptyProfiles |
Een booleaanse waarde die aangeeft of er voor lege profielen moet worden gefilterd. Profielen kunnen profielrecords, ExperienceEvent-records of beide bevatten. Profielen zonder profielrecords en alleen ExperienceEvent-records worden 'emptyProfiles' genoemd. Als u alle profielen wilt exporteren in het profielarchief, inclusief de "emptyProfiles", stelt u de waarde van emptyProfiles in op true . Als emptyProfiles is ingesteld op false , worden alleen profielen met profielrecords in de winkel geëxporteerd. Als het kenmerk emptyProfiles niet is opgenomen, worden standaard alleen profielen met profielrecords geëxporteerd. |
additionalFields.eventList |
Bepaalt de tijdlijngebeurtenisvelden die worden geëxporteerd voor onderliggende of gekoppelde objecten door een of meer van de volgende instellingen op te geven:
|
destination |
(Vereist) Informatie over de uitgevoerde gegevens:
|
schema.name |
(Vereist) De naam van het schema verbonden aan de dataset waar het gegeven moet worden uitgevoerd. |
evaluationInfo.segmentation |
(Optioneel) Een Booleaanse waarde die, indien niet opgegeven, standaard op false wordt ingesteld. De waarde true geeft aan dat segmentatie moet worden uitgevoerd op de exporttaak. |
Reactie
Een geslaagde reactie retourneert HTTP-status 200 met details van de nieuwe exporttaak.
code language-json |
---|
|
table 0-row-2 1-row-2 | |
---|---|
Eigenschap | Beschrijving |
id |
Een door het systeem gegenereerde alleen-lezen waarde die de exporttaak identificeert die zojuist is gemaakt. |
Als destination.segmentPerBatch
was ingesteld op true
, heeft het bovenstaande destination
-object een batches
array, zoals hieronder wordt getoond:
code language-json |
---|
|
Een specifieke exporttaak ophalen get
U kunt gedetailleerde informatie over een specifieke uitvoerbaan terugwinnen door een verzoek van de GET aan het /export/jobs
eindpunt te richten en identiteitskaart van de de uitvoerbaan te verstrekken u in de verzoekweg wenst terug te winnen.
API formaat
GET /export/jobs/{EXPORT_JOB_ID}
{EXPORT_JOB_ID}
id
van de exporttaak die u wilt openen.Verzoek
code language-shell |
---|
|
Reactie
Een geslaagde reactie retourneert HTTP-status 200 met gedetailleerde informatie over de opgegeven exporttaak.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 | |
---|---|
Eigenschap | Beschrijving |
destination |
Doelgegevens voor de geëxporteerde gegevens:
|
fields |
Een lijst met de geëxporteerde velden, gescheiden door komma's. |
schema.name |
De naam van het schema verbonden aan de dataset waar het gegeven moet worden uitgevoerd. |
filter.segments |
De segmenten die worden geëxporteerd. De volgende velden worden opgenomen:
|
mergePolicy |
Voeg beleidsinformatie voor de uitgevoerde gegevens samen. |
metrics.totalTime |
Een veld dat de totale tijd aangeeft waarop de exporttaak is uitgevoerd. |
metrics.profileExportTime |
Een veld waarin de exporttijd van de profielen wordt aangegeven. |
totalExportedProfileCounter |
Het totale aantal profielen dat is geëxporteerd naar alle batches. |
Een specifieke exporttaak annuleren of verwijderen delete
U kunt verzoeken om de opgegeven exporttaak te verwijderen door een DELETE-aanvraag in te dienen bij het /export/jobs
-eindpunt en de id op te geven van de exporttaak die u wilt verwijderen in het aanvraagpad.
API formaat
DELETE /export/jobs/{EXPORT_JOB_ID}
{EXPORT_JOB_ID}
id
van de exporttaak die u wilt verwijderen.Verzoek
code language-shell |
---|
|
Reactie
Een succesvolle reactie retourneert HTTP-status 204 met het volgende bericht:
{
"status": true,
"message": "Export job has been marked for cancelling"
}
Volgende stappen
Na het lezen van deze handleiding hebt u nu een beter inzicht in hoe exporttaken werken.