Recolher dados personalizados com a política DataCapture

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

Além dos dados da API habituais recolhidos pelo Apigee, também pode recolher dados personalizados através da política DataCapture. Existem dois passos principais necessários, conforme descrito nas secções seguintes:

1. Crie um recurso REST do coletor de dados.
2. Especifique os dados que quer recolher usando o elemento <Collect> da política DataCapture.

Nota:se tiver uma organização do Apigee com faturação de pagamento por utilização, tem de ativar o suplemento Apigee API Analytics para usar esta política. Para mais informações, consulte o artigo Faça a gestão do suplemento Apigee API Analytics.

Se não tiver a certeza de que está a usar uma organização do Apigee por subscrição ou de pagamento conforme o uso, contacte o administrador da sua organização do Apigee.

Crie um recurso REST do coletor de dados

Para usar a política DataCapture, primeiro tem de criar um recurso REST de coletor de dados. Para o fazer, envie um pedido de API como o seguinte:

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"

Isto cria um recurso denominado dc_my_custom_data, que pode usar com a política DataCapture.

Notas:

• O nome do recurso Data Collector tem de começar com o prefixo dc_.
• Se usar um coletor de dados em várias políticas, os dados capturados são substituídos pela última política executada.

Aviso: não crie dois coletores de dados cujos nomes difiram apenas em maiúsculas/minúsculas, como dc_my_data e dc_My_Data, pois, nesse caso, a exportação de dados vai resultar num erro de "nomes de colunas duplicados".

Especifique os dados a recolher

Pode especificar os dados a recolher através do elemento <Collect> da política DataCapture. Existem várias formas de o fazer, conforme mostrado na secção Exemplos na página de referência DataCapure. Uma forma é especificar uma variável de fluxo, que armazena dados transmitidos em pedidos e respostas da API. Por exemplo, pode recolher dados que os clientes introduzem num formulário de página Web através da variável de fluxo message.formparam.param_name.values, em que param_name é o nome de um parâmetro no formulário. Suponhamos que o formulário tem um parâmetro denominado payment_amount. A variável de fluxo correspondente seria message.formparam.payment_amount.values.

O código seguinte especifica esta variável através do atributo ref do elemento <Collect>.

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

Com esta definição, os dados introduzidos no campo payment_amount do formulário são recolhidos pela DataCapture e armazenados numa variável denominada dc_my_custom_data.

Criar um relatório personalizado a partir de dados recolhidos com o DataCapture

Depois de configurar a recolha de dados com a política DataCapture, pode usar os dados para criar um relatório personalizado através do procedimento descrito em Adicionar um relatório personalizado. Para tal, quando selecionar uma métrica para o relatório, conforme mostrado no passo 4 do procedimento, escolha a variável que tem o mesmo nome que o recurso REST do coletor de dados que criou para o DataCapture, por exemplo, dc_my_custom_data.

Também pode usar a mesma variável como uma dimensão num relatório personalizado. Uma vez que as dimensões agrupam os dados pelos valores da variável, é normalmente preferível que a variável seja uma string que só assume um número limitado de valores.