Crea un nuovo processo di esportazione
È possibile creare un nuovo processo di esportazione effettuando una richiesta POST all'endpoint /export/jobs
.
Formato API
POST /export/jobs
Richiesta
La richiesta seguente crea un nuovo processo di esportazione, configurato dai parametri forniti nel payload.
Richiesta di esempio per creare un processo di esportazione.
curl -X POST https://platform.adobe.io/data/core/ups/export/jobs \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"fields": "identities.id,personalEmail.address",
"mergePolicy": {
"id": "timestampOrdered-none-mp",
"version": 1
},
"filter": {
"segments": [
{
"segmentId": "52c26d0d-45f2-47a2-ab30-ed06abc981ff",
"segmentNs": "ups",
"status": [
"realized"
]
}
],
"segmentQualificationTime": {
"startTime": "2018-01-01T00:00:00Z",
"endTime": "2018-02-01T00:00:00Z"
},
"fromIngestTimestamp": "2018-01-01T00:00:00Z",
"emptyProfiles": true
},
"additionalFields": {
"eventList": {
"fields": "string",
"filter": {
"fromIngestTimestamp": "2018-01-01T00:00:00Z",
"toIngestTimestamp": "2020-01-01T00:00:00Z"
}
}
},
"destination":{
"datasetId": "5b7c86968f7b6501e21ba9df",
"segmentPerBatch": false
},
"schema":{
"name": "_xdm.context.profile"
},
"evaluationInfo": {
"segmentation": true
}
}'
Proprietà | Descrizione |
---|---|
fields | Elenco dei campi esportati, separati da virgole. Se questo campo viene lasciato vuoto, verranno esportati tutti i campi. |
mergePolicy | Specifica il criterio di unione da applicare ai dati esportati. Includi questo parametro quando vengono esportati più segmenti. Se non specificato, l’esportazione accetta lo stesso criterio di unione del segmento specificato. |
filter | Oggetto che specifica i segmenti da includere nel processo di esportazione in base all’ID, al tempo di qualifica o al tempo di acquisizione, a seconda delle sottoproprietà elencate di seguito. Se questo campo viene lasciato vuoto, verranno esportati tutti i dati. |
filter.segments |
Specifica i segmenti da esportare. Omettendo questo valore, tutti i dati di tutti i profili vengono esportati. Accetta un array di oggetti segmento, ciascuno contenente i seguenti campi:
|
filter.segmentQualificationTime | Filtra in base al tempo di qualifica del segmento. È possibile specificare l'ora di inizio e/o di fine. |
filter.segmentQualificationTime.startTime | Ora di inizio della qualifica del segmento per un ID segmento per un determinato stato. Se non specificato, non sarà presente alcun filtro sull’ora di inizio per la qualifica di un ID segmento. Il timestamp deve essere fornito nel formato RFC 3339. |
filter.segmentQualificationTime.endTime | Ora di fine della qualifica del segmento per un ID segmento per un determinato stato. Se non specificato, non sarà presente alcun filtro sull’ora di fine per la qualifica di un ID segmento. Il timestamp deve essere fornito nel formato RFC 3339. |
filter.fromIngestTimestamp |
Limita i profili esportati a includere solo quelli che sono stati aggiornati dopo questa marca temporale. Il timestamp deve essere fornito nel formato RFC 3339.
|
filter.emptyProfiles | Valore booleano che indica se filtrare i profili vuoti. I profili possono contenere record di profilo, record ExperienceEvent o entrambi. I profili senza record di profilo e solo i record ExperienceEvent sono denominati "emptyProfiles". Per esportare tutti i profili nell'archivio profili, inclusi i "emptyProfiles", impostare il valore di emptyProfiles su true . Se emptyProfiles è impostato su false , vengono esportati solo i profili con record di profilo nell'archivio. Per impostazione predefinita, se l'attributo emptyProfiles non è incluso, vengono esportati solo i profili contenenti record di profilo. |
additionalFields.eventList |
Controlla i campi evento della serie temporale esportati per gli oggetti figlio o associati fornendo una o più delle seguenti impostazioni:
|
destination |
(obbligatorio) Informazioni sui dati esportati:
|
schema.name | (Obbligatorio) Il nome dello schema associato al set di dati in cui devono essere esportati i dati. |
evaluationInfo.segmentation | (Facoltativo) Valore booleano che, se non specificato, viene impostato automaticamente su false . Il valore true indica che è necessario eseguire la segmentazione sul processo di esportazione. |
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con i dettagli del nuovo processo di esportazione creato.
Una risposta di esempio durante la creazione di un processo di esportazione.
{
"id": 100,
"jobType": "BATCH",
"destination": {
"datasetId": "5b7c86968f7b6501e21ba9df",
"segmentPerBatch": false,
"batchId": "da5cfb4de32c4b93a09f7e37fa53ad52"
},
"fields": "identities.id,personalEmail.address",
"schema": {
"name": "_xdm.context.profile"
},
"imsOrgId": "{ORG_ID}",
"status": "NEW",
"filter": {
"segments": [
{
"segmentId": "52c26d0d-45f2-47a2-ab30-ed06abc981ff",
"segmentNs": "ups",
"status": [
"realized"
]
}
],
"segmentQualificationTime": {
"startTime": "2018-01-01T00:00:00Z",
"endTime": "2018-02-01T00:00:00Z"
},
"fromIngestTimestamp": "2018-01-01T00:00:00Z",
"emptyProfiles": true
},
"additionalFields": {
"eventList": {
"fields": "_id, _experience",
"filter": {
"fromIngestTimestamp": "2018-01-01T00:00:00Z"
}
}
},
"mergePolicy": {
"id": "timestampOrdered-none-mp",
"version": 1
},
"profileInstanceId": "ups",
"metrics": {
"totalTime": {
"startTimeInMs": 123456789000,
}
},
"computeGatewayJobId": {
"exportJob": ""
},
"creationTime": 1538615973895,
"updateTime": 1538616233239,
"requestId": "d995479c-8a08-4240-903b-af469c67be1f"
}
Proprietà | Descrizione |
---|---|
id | Valore di sola lettura generato dal sistema che identifica il processo di esportazione appena creato. |
In alternativa, se destination.segmentPerBatch
fosse stato impostato su true
, l'oggetto destination
di cui sopra avrebbe un array batches
, come illustrato di seguito:
"destination": {
"dataSetId": "{DATASET_ID}",
"segmentPerBatch": true,
"batches": [
{
"segmentId": "segment1",
"segmentNs": "ups",
"status": ["realized"],
"batchId": "da5cfb4de32c4b93a09f7e37fa53ad52"
},
{
"segmentId": "segment2",
"segmentNs": "AdCloud",
"status": "exited",
"batchId": "df4gssdfb93a09f7e37fa53ad52"
}
]
}
Recuperare un processo di esportazione specifico
Per recuperare informazioni dettagliate su un processo di esportazione specifico, eseguire una richiesta GET all'endpoint /export/jobs
e specificare l'ID del processo di esportazione che si desidera recuperare nel percorso della richiesta.
Formato API
GET /export/jobs/{EXPORT_JOB_ID}
Parametro | Descrizione |
---|---|
{EXPORT_JOB_ID} | id del processo di esportazione a cui desideri accedere. |
Richiesta
Richiesta di esempio per recuperare un processo di esportazione.
curl -X GET https://platform.adobe.io/data/core/ups/export/jobs/11037 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con informazioni dettagliate sul processo di esportazione specificato.
Una risposta di esempio durante il recupero di un processo di esportazione.
{
"id": 11037,
"jobType": "BATCH",
"destination": {
"datasetId": "5b7c86968f7b6501e21ba9df",
"segmentPerBatch": false,
"batchId": "da5cfb4de32c4b93a09f7e37fa53ad52"
},
"fields": "identities.id,personalEmail.address",
"schema": {
"name": "_xdm.context.profile"
},
"imsOrgId": "{ORG_ID}",
"status": "SUCCEEDED",
"filter": {
"segments": [
{
"segmentId": "52c26d0d-45f2-47a2-ab30-ed06abc981ff",
"segmentNs": "ups",
"status":[
"realized"
]
}
]
},
"mergePolicy": {
"id": "timestampOrdered-none-mp",
"version": 1
},
"profileInstanceId": "ups",
"metrics": {
"totalTime": {
"startTimeInMs": 123456789000,
"endTimeInMs": 123456799000,
"totalTimeInMs": 10000
},
"profileExportTime": {
"startTimeInMs": 123456789000,
"endTimeInMs": 123456799000,
"totalTimeInMs": 10000
},
"totalExportedProfileCounter": 20,
"exportedProfileByNamespaceCounter": {
"namespace1": 10,
"namespace2": 5
}
},
"computeGatewayJobId": {
"exportJob": "f3058161-7349-4ca9-807d-212cee2c2e94"
},
"creationTime": 1538615973895,
"updateTime": 1538616233239,
"requestId": "d995479c-8a08-4240-903b-af469c67be1f"
}
Proprietà | Descrizione |
---|---|
destination |
Informazioni sulla destinazione dei dati esportati:
|
fields | Elenco dei campi esportati, separati da virgole. |
schema.name | Nome dello schema associato al set di dati in cui devono essere esportati i dati. |
filter.segments |
I segmenti esportati. Sono inclusi i seguenti campi:
|
mergePolicy | Informazioni sui criteri di unione per i dati esportati. |
metrics.totalTime | Campo che indica il tempo totale richiesto per l'esecuzione del processo di esportazione. |
metrics.profileExportTime | Un campo che indica il tempo necessario per l’esportazione dei profili. |
totalExportedProfileCounter | Numero totale di profili esportati in tutti i batch. |