Getting Started

GitHub

Kopieren Sie einen Einrichtungsvorschlag mit den Installationsanweisungen und der vollständigen Markdown-Guideline für diesen Plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-contentsquare`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/contentsquare/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Installieren Sie das Plugin
- npm
- pnpm
- yarn
- bun
Terminalfenster
npm i @capgo/capacitor-contentsquare
Terminalfenster
pnpm add @capgo/capacitor-contentsquare
Terminalfenster
yarn add @capgo/capacitor-contentsquare
Terminalfenster
bun add @capgo/capacitor-contentsquare
Natives Plattformen synchronisieren
- npm
- pnpm
- yarn
- bun
Terminalfenster
npx cap sync
Terminalfenster
pnpm cap sync
Terminalfenster
yarn cap sync
Terminalfenster
bunx cap sync
Überprüfen Sie die Produktkonfiguration des upstream-Produkts
- Folgen Sie der offiziellen Inhalte von Contentsquare Capacitor für Projekt-Schlüssel, Wiedergabe-Einstellungen und Dashboard-Einrichtung.

Grundlegende Verwendung

import { ContentsquarePlugin, CurrencyCode } from '@capgo/capacitor-contentsquare';

await ContentsquarePlugin.optIn();

await ContentsquarePlugin.sendScreenName('Home');

await ContentsquarePlugin.sendTransaction({
  transactionValue: 29.99,
  transactionCurrency: CurrencyCode.EUR,
  transactionId: 'order-123',
});

await ContentsquarePlugin.sendDynamicVar({
  dynVarKey: 'store',
  dynVarValue: 'rome',
});

Tipps zur Bildschirmbezeichnung

Verwenden Sie stattdessen stabile Namen anstelle von Benutzerspezifischen Werten.
Halten Sie die gleichen Namenskonventionen über die iOS- und Android-Navigationsstacks hinweg.
Wenn das App zurückkehrt in den Vordergrund, senden Sie den Bildschirmnamen und alle kritischen dynamischen Variablen erneut.

Replay-Ergebnisse schützen

Verwenden Sie die integrierten Maskierungshilfen, um sensitive Inhalte aus der Session Replay fernzuhalten:

await ContentsquarePlugin.excludeURLForReplay('/checkout/');

await ContentsquarePlugin.setCapturedElementsSelector('[data-cs-capture]');

await ContentsquarePlugin.setPIISelectors({
  PIISelectors: ['input[type="email"]', '.credit-card'],
  Attributes: [{ selector: 'input[name="email"]', attrName: 'value' }],
});

Plattformseinstellungen

Für iOS-In-App-Funktionen müssen Sie die zusätzliche Deeplink-Verkabelung auf der iOS-Einstellungen Seite abgeschlossen haben.
Für Android ist keine zusätzliche Manifest-Verkabelung für den Plugin selbst erforderlich; siehe Android-Hinweise für Tipps zu Protokollierung und Validierung.

Hinweise

Diese Erweiterung ist eine Capacitor 8 Gemeinschaftsübertragung des offiziellen Contentsquare Capacitor Pakets.
Das JavaScript API bleibt mit den aktuellen Contentsquare Capacitor Dokumentationen synchron, während die Verpackung und die native Build-Einstellungen auf Capacitor 8 ausgerichtet sind.

Weiter von Anleitung zum Starten

Wenn Sie native Plugin-Arbeiten planen, verbinden Sie sie mit Anleitung zum Starten um native Plugin-Arbeiten zu planen, verbinden Sie sie mit Mit @capgo/capacitor-contentsquare für die native Fähigkeit in Mit @capgo/capacitor-contentsquare Capgo Plugin-Verzeichnis für den Produktworkflow in Capgo Plugin-Verzeichnis, Capacitor Plugins von Capgo für die Implementierungsdetails in Capacitor Plugins von Capgo, Hinzufügen oder Aktualisieren von Plugins für die Implementierungsdetails in Hinzufügen oder Aktualisieren von Plugins, und Ionic Enterprise Plugin Alternativen für den Produktworkflow in Ionic Enterprise Plugin Alternativen.