Cordova Ionic Phonegap Branch Deep Linking Attribution 项目教程
1. 项目目录结构及介绍
cordova-ionic-phonegap-branch-deep-linking-attribution/
├── .github/
├── src/
│ ├── ios/
│ ├── android/
│ └── www/
├── .gitignore
├── .npmignore
├── CHANGELOG.md
├── LICENSE.md
├── README.md
├── SECURITY.md
├── package.json
└── plugin.xml
目录结构介绍
- .github/: 包含GitHub相关的配置文件,如Issue模板、Pull Request模板等。
- src/: 项目的源代码目录,包含iOS、Android和Web平台的代码。
- ios/: iOS平台的源代码。
- android/: Android平台的源代码。
- www/: Web平台的源代码。
- .gitignore: Git忽略文件,指定哪些文件或目录不需要被Git跟踪。
- .npmignore: npm忽略文件,指定哪些文件或目录不需要被npm发布。
- CHANGELOG.md: 项目更新日志,记录每个版本的变更内容。
- LICENSE.md: 项目许可证文件,说明项目的开源许可证类型。
- README.md: 项目说明文件,包含项目的简介、安装和使用说明等。
- SECURITY.md: 项目安全相关说明,包含如何报告安全漏洞等信息。
- package.json: npm包配置文件,包含项目的依赖、脚本等信息。
- plugin.xml: Cordova插件配置文件,定义插件的元数据、平台配置等。
2. 项目的启动文件介绍
启动文件
- src/www/branch.js: 这是项目的主要启动文件,包含了Branch SDK的初始化和配置代码。
启动文件介绍
branch.js
文件主要负责初始化Branch SDK,并配置相关的深度链接和归因功能。以下是该文件的主要内容:
// 初始化Branch SDK
Branch.initSession(function(data) {
if (data["+clicked_branch_link"]) {
// 处理深度链接
}
});
// 配置Branch SDK
Branch.setIdentity('user_id');
Branch.trackCommerceEvent('purchase', {
'revenue': 1.00,
'currency': 'USD'
}, function(err, data) {
console.log(err, data);
});
3. 项目的配置文件介绍
配置文件
- plugin.xml: Cordova插件配置文件,定义插件的元数据、平台配置等。
- package.json: npm包配置文件,包含项目的依赖、脚本等信息。
配置文件介绍
plugin.xml
plugin.xml
文件是Cordova插件的核心配置文件,定义了插件的名称、版本、依赖关系、平台配置等。以下是该文件的部分内容:
<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
id="cordova-ionic-phonegap-branch-deep-linking-attribution"
version="2.0.0">
<name>Branch Deep Linking Attribution</name>
<description>Cordova Ionic Phonegap SDK for deep linking and attribution</description>
<license>MIT</license>
<keywords>cordova, ionic, phonegap, deep-linking, attribution</keywords>
<platform name="ios">
<config-file target="config.xml" parent="/*">
<feature name="Branch">
<param name="ios-package" value="BranchSDK"/>
</feature>
</config-file>
<source-file src="src/ios/BranchSDK.m"/>
</platform>
<platform name="android">
<config-file target="res/xml/config.xml" parent="/*">
<feature name="Branch">
<param name="android-package" value="io.branch.sdk.Branch"/>
</feature>
</config-file>
<source-file src="src/android/BranchSDK.java"/>
</platform>
</plugin>
package.json
package.json
文件是npm包的配置文件,定义了项目的名称、版本、依赖、脚本等信息。以下是该文件的部分内容:
{
"name": "cordova-ionic-phonegap-branch-deep-linking-attribution",
"version": "2.0.0",
"description": "Cordova Ionic Phonegap SDK for deep linking and attribution",
"main": "src/www/branch.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking-attribution.git"
},
"keywords": [
"cordova",
"ionic",
"phonegap",
"deep-linking",
"attribution"
],
"author": "Branch Metrics",
"license": "MIT",
"bugs": {
"url": "https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking-attribution/issues"
},
"homepage": "https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking-attribution#readme"
}
通过以上配置文件,开发者可以了解项目的依赖关系、平台配置以及如何初始化和配置Branch SDK。