Panoramica dell'API di esportazione di Mobile EngagementMobile Engagement Export API Overview

IntroduzioneIntroduction

In questo documento verranno illustrate le nozioni di base sull'esportazione dei dati non elaborati generati da dispositivi dell'utente per l'uso in strumenti personalizzati.In this document, you will learn the basics about exporting your raw data generated by your user's devices to leverage it in your own tools.

PrerequisitiPre-requisites

Per esportare i dati non elaborati da Mobile Engagement, è necessario:Exporting the raw data from Mobile Engagement requires:

Nota

È anche consigliabile avvalersi di Esplora archivi di Microsoft Azure, almeno durante la fase di sviluppo in quanto offre un'interfaccia utente facile da usare per interagire con Archiviazione di Azure.We also advise the excellent Microsoft Azure Storage Explorer, at least during the development phase as it provides an easy to use UI for interacting with Azure Storage.

Cosa può essere esportatoWhat can be exported?

Mobile Engagement consente agli utenti di raccogliere molti tipi di dati e pertanto offre diversi tipi di esportazione appropriati per questi tipi di dati diversi.Mobile Engagement allows its users to collect many types of data and therefore has several types of export suited to these different data types. Esistono due tipi fondamentali di esportazione:There are 2 essential types of export:

  • Snapshot: usata in genere per esportare i dati che rappresentano uno stato e per cui Mobile Engagement non ha una cronologia.Snapshot: used typically to export data that represents a state and for which Mobile Engagement does not have a history. Tali dati includono tag (app-info), token o commenti e suggerimenti di campagne push.This includes Tags (app-info), tokens or push campaign feedbacks for example. Di conseguenza questi tipi di esportazione non sono correlati a una data.As a consequence these types of export are not related to a date.
  • Cronologica: questo tipo di esportazione viene usato per i dati che si accumulano nel tempo, ad esempio eventi o attività.historical: this export type is used for data that accumulates over time such as Events or Activities for example.

Nella tabella seguente vengono descritte con attenzione tutte le esportazioni possibili:The table below describes exhaustively all the possible exports:

Export TypeExport Type Tipo di datiData Type DescrizioneDescription
SnapshotSnapshot PushPush Genera un'esportazione di commenti e suggerimenti di campagne push in base all'ID dispositivo o all'utenteGenerates an export of Push Campaigns feedbacks on a per deviceid/userid basis
SnapshotSnapshot TagTag Genera un'esportazione dei tag (app-info) associati a ogni dispositivoGenerates an export of the tags (app-info) associated to each devices
SnapshotSnapshot DispositivoDevice Genera un'esportazione della maggior parte dei dati sui dispositivi, ad esempio i dati tecnici quali modello, impostazioni locali, fuso orario e così via, i tag, la data di produzione e altri ancora.Generates an export of most of the data about devices such as the technicals (model, locale, timezone, ...), the tags, first seen time, ...
SnapshotSnapshot TokenToken Genera un'esportazione di tutti i token validiGenerates an export of all the valid tokens
CronologicaHistorical AttivitàActivity Genera un'esportazione di tutte le attività per ogni dispositivo in un determinato periodo di tempoGenerates an export of all the activities for each devices on a given time period
CronologicaHistorical EventoEvent Genera un'esportazione di tutte le attività per ogni dispositivo in un determinato periodo di tempoGenerates an export of all the activities for each devices on a given time period
CronologicaHistorical JobJob Genera un'esportazione di tutti i processi per ogni dispositivo in un determinato periodo di tempoGenerates an export of all the jobs for each devices on a given time period
CronologicaHistorical ErroreError Genera un'esportazione di tutti gli errori per ogni dispositivo in un determinato periodo di tempoGenerates an export of all the errors for each devices on a given time period

Come funziona?How does it work?

Le esportazioni sono attività a esecuzione prolungata che potrebbero generare file di dati di grandi dimensioni.Exports are long running tasks that may produce large data files. Per questo motivo, la loro chiamata non può restituire immediatamente un file da scaricare.For that reason, they cannot be invoked to return immediately a file to download. Per esportare i dati da Mobile Engagement, è necessario creare un processo di esportazione tramite API in cui specificare:In order to export data from Mobile Engagement, you will have to create an Export Job via API where you specify generally:

  • Il tipo di esportazione (snapshot o cronologica),The type of export (snapshot or historical),
  • Il tipo di dati,The data type,
  • Il contenitore dell'Archiviazione di Azure , con inclusa una firma di accesso condiviso valida con accesso in scrittura, dove verranno scritti i risultati dell'esportazione.The Azure Storage Container (including a valid SAS with write access) where the result of the export will be written.
  • Il parametro dell'URL del contenitore sarà ad esempio https://[NomeAccountArchiviazione].blob.core.windows.net/[NomeContenitore]?[TokenAutorizzazioniScritturaFirmaAccessoCondiviso]e.g. Example Container URL parameter would be https://[StorageAccountName].blob.core.windows.net/[ContainerName]?[SASWritePermissionsToken]

Ecco un esempio reale:Here is a real world example. https://testazmeexport.blob.core.windows.net/test1234azme?sv=2015-12-11&ss=b&srt=sco&sp=rwdlac&se=2016-12-17T04:59:26Z&st=2016-12-16T20:59:26Z&spr=https&sig=KRF3aVWjp2NEJDzjlmoplmu0M9HHlLdkBWRPAFmw90Q%3Dhttps://testazmeexport.blob.core.windows.net/test1234azme?sv=2015-12-11&ss=b&srt=sco&sp=rwdlac&se=2016-12-17T04:59:26Z&st=2016-12-16T20:59:26Z&spr=https&sig=KRF3aVWjp2NEJDzjlmoplmu0M9HHlLdkBWRPAFmw90Q%3D

Si noti che l'avvio del processo potrebbe richiedere alcuni minuti e che la sua esecuzione potrebbe richiedere da qualche secondo per le app molto piccole ad alcune ore per le app con diversi utenti e attività.Please note that it may take a few minutes for your job to be started, and then it may run from a few seconds for tiny apps to several hours for apps with a lot of users or activity.

Una volta creato il processo, è possibile controllarne lo stato per vedere se è ancora in esecuzione o se è stato completato.Once the job is created, it is possible to check its status to see if it is still running or if it has completed.

Una volta che il processo è stato completato correttamente, il file di dati risultante è disponibile nel contenitore di archiviazione specificato.Once the job is SUCCEEDED, the resulting data file is available on the provided storage container.