Benutzerdefinierte Daten mit der DataCapture-Richtlinie erfassen

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Zusätzlich zu den von API erfassten üblichen API-Daten können Sie auch mithilfe der DataCapture benutzerdefinierte Daten erfassen. Es sind zwei Hauptschritte erforderlich, wie in den folgenden Abschnitten beschrieben:

1. Erstellen Sie eine Data Collector REST-Ressource.
2. Geben Sie die zu erfassenden Daten mit dem Element <Collect> der DataCapture-Richtlinie an.

Hinweis: Wenn Sie eine Apigee-Organisation mit „Pay as you go“-Abrechnung haben, müssen Sie das Apigee API Analytics-Add-on aktivieren, um diese Richtlinie zu verwenden. Weitere Informationen finden Sie unter Add-on für API-Analysen von Apigee verwalten.

Wenn Sie sich nicht sicher sind, ob Sie ein Abo oder eine „Pay as you go“-Apigee-Organisation verwenden, wenden Sie sich an den Administrator Ihrer Apigee-Organisation.

Erstellen Sie eine Data Collector REST-Ressource.

Sie müssen zuerst eine REST-Ressource vom Typ Data Collector erstellen, um die Richtlinie DataCapture verwenden zu können. Senden Sie dazu eine API-Anfrage wie die folgende:

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"

Dadurch wird eine Ressource mit dem Namen dc_my_custom_data erstellt, die Sie in der DataCapture-Richtlinie verwenden können.

Hinweise:

• Der Name der Data Collector-Ressource muss mit dem Präfix dc_ beginnen.
• Wenn Sie einen Data Collector in mehreren Richtlinien verwenden, werden die erfassten Daten mit der letzten ausgeführten Richtlinie überschrieben.

Warnung: Erstellen Sie keine zwei Daten-Collectors, deren Namen sich nur durch Großschreibung wie dc_my_data und dc_My_Data unterscheiden, weil sonst der Datenexport zum Fehler "Doppelte Spaltennamen" führt.

Zu erfassende Daten angeben

Sie können die zu erfassenden Daten mit dem Element <Collect> der DataCapture-Richtlinie angeben. Dafür gibt es verschiedene Möglichkeiten, wie im Abschnitt Beispiele auf der DataCapure-Referenzseite gezeigt. Eine Möglichkeit besteht darin, eine Ablaufvariable anzugeben, die in API-Anfragen und -Antworten übergebene Daten speichert. Sie können beispielsweise Daten erfassen, die Kunden in ein Webseitenformular eingeben, indem Sie die Ablaufvariable message.formparam.param_name.values verwenden, wobei param_name der Name eines Parameters im Formular ist. Angenommen, das Formular hat einen Parameter mit dem Namen payment_amount. Die entsprechende Ablaufvariable wäre message.formparam.payment_amount.values.

Der folgende Code gibt diese Variable durch das Attribut ref des Elements <Collect> an.

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

Mit dieser Einstellung werden die im Feld payment_amount des Formulars eingegebenen Daten von DataCapture erfasst und in einer Variablen mit dem Namen dc_my_custom_data gespeichert.

Benutzerdefinierten Bericht aus Daten erstellen, die mit DataCapture erfasst wurden

Sobald Sie die Datenerfassung mit der DataCapture-Richtlinie eingerichtet haben, können Sie die Daten verwenden, um einen benutzerdefinierten Bericht zu erstellen. Gehen Sie dazu so vor, wie unter Benutzerdefinierten Bericht hinzufügen beschrieben. Wenn Sie, wie in Schritt 4 des Verfahrens gezeigt, einen Messwert für den Bericht auswählen, wählen Sie die Variable aus, die denselben Namen wie die Data Collector REST-Ressource hat, die Sie für DataCapture erstellt haben, z. B. dc_my_custom_data, wie unten gezeigt.

Sie können auch dieselbe Variable als eine Dimension in einem benutzerdefinierten Bericht verwenden. Da Dimensionen Daten nach den Werten der Variablen gruppieren, ist es in der Regel besser, wenn die Variable ein String ist, der nur eine begrenzte Anzahl von Werten akzeptiert.