Metaframe-Methoden und Ereignisse
window.metaframe -Objekt
Sobald das Skript geladen wurde, ist das metaframe-Objekt im globalen window-Objekt Ihrer Anwendung verfügbar. Das Metaframe-Objekt enthält eine Liste von Methoden, die für die Verwaltung von Metaframe in Ihrer Web-Anwendung erforderlich sind.
Methode window.metaframe.create
Signatur der Methode:
window.metaframe.create: (parameters: {
loginProjectId: string,
merchantId?: number,
projectId?: number,
orbsApiHostId?: string,
isMobile?: boolean,
}) => void;
Initialisiert Metaframe in Ihrer Web-Anwendung. Die Methode akzeptiert das parameters-Objekt mit folgenden Parametern, die für die Ausführung von Metaframe erforderlich sind:
| Parameter | Typ | Beschreibung |
|---|---|---|
loginProjectId | string | Login-ID. Diese finden Sie im Kundenportal unter Login > Dashboard > Ihr Login-Projekt. Erforderlich. |
merchantId | string | Händler-ID. Diesen Parameter finden Sie im Kundenportal:
|
projectID | string | Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.Erforderlich, wenn die Funktion Rucksack in den Projekteinstellungen im Kundenportal aktiviert ist. |
orbsApiHostId | string | Host-ID. Wenden Sie sich dafür an das Integrationsteam integration@xsolla.com oder an Ihren Customer Success Manager csm@xsolla.com, und teilen Sie ihm die Projekt-ID und die Händler-ID mit.Erforderlich, wenn die Funktion virtuelle Währungen in den Projekteinstellungen im Kundenportal aktiviert ist. |
isMobile | boolean | Ob Metaframe standardmäßig das mobile Layout verwendet. |
Methode window.metaframe.setIsMobile
Signatur der Methode:
window.metaframe.setIsMobile(isMobile: boolean)
Wechselt Metaframe von der Desktop- zur mobilen Version und umgekehrt.
| Parameter | Typ | Beschreibung |
|---|---|---|
isMobile | boolean | Ob Metaframe auf die mobile Version umgestellt werden soll. Bei true schaltet Metaframe auf die mobile Version um. Bei false schaltet Metaframe auf die Desktop-Version um. |
window.metaframe.partnerActions -Objekt
Das Objekt enthält Methoden, die Aktionen im Metaframe auslösen.
Bevor Sie Methoden an diesem Objekt anwenden, müssen Sie sicherstellen, dass Metaframe vollständig geladen wurde. Abonnieren Sie dafür das Metaframe Ladeereignis. Wenn das Ereignis verarbeitet wurde, sind die Methoden des Objekts verfügbar.
Beispiel für das Einrichten eines Listeners für das Metaframe-Ladeereignis:
- javascript
window.addEventListener("@metaframe-partner-events:app-loaded", () => {
//Here you can use partner actions
});
Methode window.metaframe.partnerActions.openBackpackItemPage
Signatur der Methode:
window.metaframe.partnerActions.openBackpackItemPage(itemId: string)
Öffnet die Seite für den angegebenen Artikel im Abschnitt
Damit die Methode korrekt funktioniert, müssen folgende Bedingungen erfüllt sein:
- Die Funktion Rucksack ist im Kundenportal aktiviert.
- Der Benutzer ist bei Metaframe authentifiziert.
| Parameter | Typ | Beschreibung |
|---|---|---|
itemId | string | Interne ID des Elements, das während des Aufrufs der API Methode Element erstellen übertragen wird. |
Tracking-Ereignisse
Sie können folgende Metaframe-Ereignisse abonnieren:
| Parameter | Typ |
|---|---|
@metaframe-partner-events:app-loaded | Das Ereignis wird ausgelöst, wenn Metaframe erfolgreich, nachdem die Methode window.metaframe.createaufgerufen wurde, geladen wird. |
@metaframe-partner-events:login-successful | Das Ereignis wird ausgelöst, wenn der Benutzer sich erfolgreich beim Metaframe anmeldet. Es enthält ein detail-Objekt mit dem Authorisierungstoken. |
@metaframe-partner-events:logout-successful | Das Ereignis wird ausgelöst, wenn sich ein Benutzer erfolgreich vom System abmeldet. |
@metaframe:custom-action:<ACTION_ID> | Das Ereignis wird ausgelöst, wenn ein Benutzer einen beliebigen Abschnitt des Typs Action im Metaframe wählt. Weitere Informationen finden Sie unter Ereignisse beliebiger Abschnitte nachverfolgen. |
Ereignisse in benutzerdefinierten Abschnitten nachverfolgen
Sie können einen benutzerdefinierten Abschnitt mit dem Action-Typ zum Metaframe hinzufügen. Dieser Abschnitt erscheint als Schaltfläche, die beim Anklicken eine Aktion ausführt, z. B. das Öffnen einer Website.
Um das Ereignis nachzuverfolgen, bei dem ein benutzerdefinierter Abschnitt angeklickt wird, müssen Sie das Ereignis @metaframe:custom-action:<ACTION_ID> abonnieren, wobei die Aktions-ID <ACTION_ID> im Kundenportal bei der Einrichtung des benutzerdefinierten Abschnitts generiert wird.
Beispiel für das Einrichten eines Listeners für ein Klickereignis eines benutzerdefinierten Abschnitts:
- javascript
document.addEventListener("@metaframe:custom-action:00000000-0000-0000-0000-000000000000", () => {
// Your code here...
})
Haben Sie einen Tippfehler oder einen anderen Textfehler gefunden? Wählen Sie den Text aus und drücken Sie Strg+Eingabe.
