Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SpellChucker/capacitor-plugin-facebook-analytics
https://github.com/SpellChucker/capacitor-plugin-facebook-analytics
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/SpellChucker/capacitor-plugin-facebook-analytics
- Owner: SpellChucker
- Created: 2020-07-23T11:29:58.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-08-12T18:53:05.000Z (about 3 years ago)
- Last Synced: 2024-07-05T02:05:31.729Z (4 months ago)
- Language: Java
- Size: 13.1 MB
- Stars: 5
- Watchers: 2
- Forks: 25
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-capacitor - Facebook Analytics - Facebook Analytics Plugin for Capacitor. (Other plugins)
README
## Installation
```bash
$ npm i --save capacitor-plugin-facebook-analytics
```
To use yarn
```bash
yarn add capacitor-plugin-facebook-analytics
```
## Android configuration
In file `android/app/src/main/java/**/**/MainActivity.java`, add the plugin to the initialization list:
```diff
this.init(savedInstanceState, new ArrayList>() {{
[...]
+ add(com.vrba.plugins.facebookanalytics.FacebookAnalytics.class);
[...]
}});
```
In file `android/app/src/main/AndroidManifest.xml`, add the following XML elements under `` :
```diff
+
```
In file `android/app/src/main/res/values/strings.xml` add the following lines :
```diff
+ [APP_ID]
```
Don't forget to replace `[APP_ID]` by your Facebook application Id.
More information can be found here: https://developers.facebook.com/docs/app-events/getting-started-app-events-android
## iOS configuration
Add the following in the `ios/App/App/info.plist` file:
```diff
+ FacebookAppID
+ [APP_ID]
+ FacebookDisplayName
+ [APP_NAME]
```
More information can be found here: https://developers.facebook.com/docs/app-events/getting-started-app-events-ios
## Supported methods
| Name | Android | iOS | Web |
| :-------------------- | :------ | :-- | :-- |
| logEvent | ✅ | ✅ | ❌ |
## API
### logEvent
```ts
import { Plugins } from '@capacitor/core';
const { FacebookAnalytics } = Plugins;
// Example commands.
await FacebookAnalytics.logEvent(options: { event: string, params?: any }): Promise;
await FacebookAnalytics.logPurchase(options: {amount: number, currency: string, params: any}): Promise;
await FacebookAnalytics.logAddPaymentInfo(options: {success: number}): Promise;
await FacebookAnalytics.logAddToCart(options: {amount: number, currency: string, params?: any}): Promise;
await FacebookAnalytics.logCompleteRegistration(options: {params?: any}): Promise;
await FacebookAnalytics.logInitiatedCheckout(options: {amount: number, params?: any}): Promise;
```