logAnalyticsEvent (JavaScript API-Referenz) für Dynamics 365-Kanalintegrationsframework 2.0
Rufen Sie diese Methode für die Protokollierung von benutzerdefinierten Ereignisse ab.
Syntax
Microsoft.CIFramework.logAnalyticsEvent(data, eventName, correlationId).then(successCallback, errorCallback);
Parameter
| Name des Dataflows | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| data | JSON-Objekt | Ja | JSON-Eingabe |
| eventName | Zeichenfolge | Ja | Name des Ereignisses |
| correlationId | GUID | Nein | Zur Gruppierung aller verwandten API-Aufrufe für die diagnostische Telemetrie. |
| successCallback | Funktion | Nein | Eine Funktion, die aufgerufen wird, wenn das Versprechen erfolgreich zurückgegeben wird. |
| errorCallback | Funktion | Nein | Eine Funktion, die aufgerufen wird, wenn die Anforderung für das Versprechen fehlschlägt. |
Hier ist die Struktur des data Parameter JSON. Achten Sie darauf, die folgenden Felder einzuschließen: conversationId und providerSessionId.
{
"conversationId": "<Conversation identifier>",
"providerSessionId": "<Channel Integration Framework Provider Id>",
"clientSessionId":"<Client session identifier>",
"participantId":"<Participant identifier>",
"events": [
{
"kpiEventName": "<Name of the associated KPI event>",
"kpiEventReason": "<Reason due to which the KPI event was created>",
"eventTimestamp": "<Timestamp at which the event occurred>",
"additionalData": "<Additional data related to the session>",
"notificationResponseAction":"<Agent notification response action value>",
"externalCorrelationId": "<External system correlation Id>",
"customData": [
{
"attribute": "<name>",
"value": "<value>"
}
]
}
]
}
Zurückgegebener Wert
Promise mit dem Wert als Zeichenfolge
Beispiel
//Success callback handler
const successCallback = (result) => {
// result will indicate if the custom analytics event has been logged
console.log(result);
};
//Failure callback handler
const errorCallback = (error) => {
// handling failure
console.error(error)
};
Microsoft.CIFramework.logAnalyticsEvent(data, eventName, correlationId).then(successCallback, errorCallback);