-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d09c6dc
commit 524d5bc
Showing
3 changed files
with
83 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
## 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<Class<? extends Plugin>>() {{ | ||
[...] | ||
+ add(com.vrba.plugins.facebookanalytics.FacebookAnalytics.class); | ||
[...] | ||
}}); | ||
``` | ||
|
||
In file `android/app/src/main/AndroidManifest.xml`, add the following XML elements under `<manifest><application>` : | ||
|
||
```diff | ||
+ <meta-data android:name="com.facebook.sdk.ApplicationId" | ||
+ android:value="@string/facebook_app_id"/> | ||
``` | ||
|
||
In file `android/app/src/main/res/values/strings.xml` add the following lines : | ||
|
||
```diff | ||
+ <string name="facebook_app_id">[APP_ID]</string> | ||
``` | ||
|
||
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 | ||
+ <key>FacebookAppID</key> | ||
+ <string>[APP_ID]</string> | ||
+ <key>FacebookDisplayName</key> | ||
+ <string>[APP_NAME]</string> | ||
``` | ||
|
||
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; | ||
|
||
// With Params. | ||
await FacebookAnalytics.logEvent({ event: 'some_event', params: { someParam: 'someParam' } }); | ||
|
||
// Without Params. | ||
await FacebookAnalytics.logEvent({ event: 'some_event' }); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters