Raccolta di dati personalizzati con il criterio DataCapture

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Oltre ai soli dati API raccolti da Apigee, puoi anche raccogliere dati personalizzati utilizzando il criterio DataCapture. È necessario eseguire due passaggi principali, come descritto nelle sezioni seguenti:

1. Crea una risorsa REST raccoglitore dati.
2. Specifica i dati da raccogliere utilizzando l'elemento <Collect> del criterio Data Capture.

Nota:se hai un'organizzazione Apigee con fatturazione con pagamento a consumo, devi abilitare il componente aggiuntivo di analisi delle API Apigee per utilizzare questo criterio. Per maggiori informazioni, consulta Gestire il componente aggiuntivo di analisi delle API Apigee.

Se non hai la certezza che stai utilizzando un'organizzazione Apigee con abbonamento o pagamento a consumo, contatta l'amministratore della tua organizzazione Apigee.

Creazione di una risorsa REST raccoglitore dati

Per utilizzare il criterio DataCapture, devi prima creare una risorsa REST Raccoglitore dati. Per farlo, invia una richiesta API come la seguente:

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -X POST -H "content-type:application/json" \
  -d '
{
  "name": "dc_my_custom_data",
  "description": "Collects data for analysis.",
  "type": "STRING",
}' \
  "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/datacollectors"

Viene creata una risorsa denominata dc_my_custom_data, che puoi utilizzare con il criterio DataCapture.

Note:

• Il nome della risorsa raccoglitore dati deve iniziare con il prefisso dc_.
• Se utilizzi un raccoglitore dati in più criteri, i dati acquisiti verranno sovrascritti dall'ultimo criterio eseguito.

Avviso: non creare due raccoglitori dati i cui nomi differiscono solo per caso, ad esempio dc_my_data e dc_My_Data, dato che l'esportazione dei dati genererà un errore di tipo "nomi di colonna duplicati".

Specifica i dati da raccogliere

Puoi specificare i dati da raccogliere utilizzando l'elemento <Collect> del criterio Data Capture. Puoi farlo in vari modi, come mostrato nella sezione Esempi della pagina di riferimento di DataCapure. Un modo è specificare una variabile di flusso che archivia i dati trasmessi nelle richieste e nelle risposte dell'API. Ad esempio, potresti raccogliere i dati che i clienti inseriscono in un modulo di pagina web utilizzando la variabile di flusso message.formparam.param_name.values, dove param_name è il nome di un parametro nel modulo. Supponiamo che il modulo abbia un parametro denominato payment_amount. La variabile di flusso corrispondente sarà message.formparam.payment_amount.values.

Il codice seguente specifica questa variabile tramite l'attributo ref dell'elemento <Collect>.

<DataCapture name="capturepayment">
    <Capture>
        <DataCollector>dc_my_custom_data</DataCollector>
        <Collect ref="message.form_param.payment_amount.values" >
    </Capture>
</DataCapture>

Con questa impostazione, i dati inseriti nel campo payment_amount del modulo verranno raccolti da Data Capture e archiviati in una variabile denominata dc_my_custom_data.

Creazione di un report personalizzato dai dati raccolti con Data Capture

Dopo aver configurato la raccolta dei dati con il criterio Data Capture, puoi utilizzare i dati per creare un report personalizzato seguendo la procedura descritta in Aggiungere un report personalizzato. Per farlo, quando selezioni una metrica per il report, come mostrato nel passaggio 4 della procedura, scegli la variabile che ha lo stesso nome della risorsa REST Raccoglitore dati che hai creato per Data Capture, ad esempio dc_my_custom_data, come mostrato di seguito.

Puoi anche utilizzare la stessa variabile di una dimensione in un report personalizzato. Poiché le dimensioni raggruppano i dati in base ai valori della variabile, in genere è preferibile che questa sia una stringa che accetta solo un numero limitato di valori.