Recopila datos personalizados con la política DataCapture

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Además de los datos de API habituales que recopila Apigee, también puedes recopilar datos personalizados con la política DataCapture. Se requieren dos pasos principales, como se describe en las siguientes secciones:

1. Crea un recurso de REST de recopilación de datos.
2. Especifica los datos que deseas recopilar mediante el elemento <Collect> de la política DataCapture.

Nota: Si tienes una organización de Apigee con facturación de pago por uso, debes habilitar el complemento de estadísticas de la API de Apigee para usar esta política. Para obtener más información, consulta Administra el complemento de estadísticas de la API de Apigee.

Si no estás seguro de si usas una organización de suscripción de Apigee o de pago por uso, comunícate con el administrador de tu organización de Apigee.

Crea un recurso de REST de recopilación de datos.

Para usar la política DataCapture, primero debes crear un recurso de REST de Recopilador de datos. Para ello, envía una solicitud a la API como la siguiente:

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"

Esto crea un recurso llamado dc_my_custom_data, que puedes usar con la política DataCapture.

Notas:

• El nombre del recurso del colector de datos debe comenzar con el prefijo dc_.
• Si usas un recopilador de datos en varias políticas, la última política que se ejecuta reemplazará los datos capturados.

Advertencia: No crees dos recopiladores de datos cuyos nombres solo difieran en las mayúsculas, como dc_my_data y dc_My_Data, ya que luego exportar datos dará como resultado un error de “nombres de columna duplicados”.

Especifica los datos que se recopilarán

Puedes especificar los datos que se recopilarán mediante el elemento <Collect> de la política de DataCapture. Existen varias formas de hacerlo, como se muestra en la sección Ejemplos en la página de referencia de DataCapure. Una forma es especificar una variable de flujo, que almacena los datos que se pasan en las solicitudes y respuestas a la API. Por ejemplo, puedes recopilar datos que los clientes ingresen en un formulario de página web mediante la variable de flujo message.formparam.param_name.values, en la que param_name es el nombre de un parámetro del formulario. Supongamos que el formulario tiene un parámetro llamado payment_amount. La variable de flujo correspondiente sería message.formparam.payment_amount.values.

El siguiente código especifica esta variable mediante el atributo ref del elemento <Collect>.

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

Con esta configuración, DataCapture recopilará y almacenará los datos ingresados en el campo payment_amount del formulario en una variable llamada dc_my_custom_data.

Crea un informe personalizado a partir de los datos recopilados con DataCapture

Una vez que configures la recopilación de datos con la política DataCapture, puedes usar los datos para crear un informe personalizado mediante el procedimiento descrito en Agrega un informe personalizado. Para hacerlo, cuando selecciones una métrica para el informe, como se muestra en el paso 4 del procedimiento, elige la variable que tiene el mismo nombre que el recurso de REST del colector de datos que creaste para DataCapture, por ejemplo, dc_my_custom_data, como se muestra a continuación.

También puedes usar la misma variable que una dimensión en un informe personalizado. Debido a que las dimensiones agrupan datos por los valores de la variable, por lo general, es preferible que la variable sea una string que solo tome una cantidad limitada de valores.