Code Monkey home page Code Monkey logo

react-native-acpanalytics's Introduction

React Native AEP Analytics Extension

Notice of deprecation

Since April 25, 2023, Apple has required apps submitted to the App Store to be built with Xcode 14.1 or later. The Experience Platform Mobile SDKs and extensions outlined below were built with prior versions of Xcode and are no longer compatible with iOS and iPadOS given Apple’s current App Store requirements. Consequently, on August 31, 2023, Adobe will be deprecating support for the following Experience Platform Mobile SDKs and wrapper extensions:

After August 31, 2023, applications already submitted to the App Store that contain these SDKs and wrapper extensions will continue to operate, however, Adobe will not be providing security updates or bug fixes, and these SDKs and wrapper extensions will be provided as-is exclusive of any warranty, due to the App Store policy outlined above.

We encourage all customers to migrate to the latest Adobe Experience Platform versions of the Mobile SDK to ensure continued compatibility and support. Documentation for the latest versions of the Adobe Experience Platform Mobile SDKs can be found here. The iOS migration guide can be found here.


npm version npm downloads CircleCI license

@adobe/react-native-acpanalytics is a wrapper around the iOS, tvOS and Android AEP Analytics SDK to allow for integration with React Native applications. Functionality to enable Adobe Analytics is provided entirely through JavaScript documented below.

Installation

Install the SDK with npm and configure the native Android/iOS project in your react native project. Before installing the Analytics extension, it is recommended to first install the Core extension.

Note: If you are new to React Native we suggest you follow the React Native Getting Started page before continuing.

1. Create React Native project

First create a React Native project:

react-native init MyReactApp

Note: Follow React Native tvos support to create app with tvos target.

2. Install JavaScript packages

Install and link the @adobe/react-native-acpanalytics package:

cd MyReactApp
npm install @adobe/react-native-acpanalytics

2.1 Link

  • React Native 0.60+

CLI autolink feature links the module while building the app.

  • React Native <= 0.59
react-native link @adobe/react-native-acpanalytics

Note For iOS using cocoapods, run:

cd ios/ && pod install

Tests

This project contains jest unit tests which are contained in the __tests__ directory, to run the tests locally:

make run-tests-locally

Usage

Analytics

Importing the extension:

import {ACPAnalytics} from '@adobe/react-native-acpanalytics';

Getting the extension version:

ACPAnalytics.extensionVersion().then(version => console.log("AdobeExperienceSDK: ACPAnalytics version: " + version));

Registering the extension with ACPCore:

It is recommended to initialize the SDK via native code inside your AppDelegate and MainApplication in iOS and Android respectively.

iOS
#import <ACPAnalytics.h>

[ACPAnalytics registerExtension];
Android:
import com.adobe.marketing.mobile.Analytics;

Analytics.registerExtension();

Get the tracking identifier:

ACPAnalytics.getTrackingIdentifier().then(identifier => console.log("AdobeExperienceSDK: Tracking identifier: " + identifier));

Send queued hits:

ACPAnalytics.sendQueuedHits();

Get the queue size:

ACPAnalytics.getQueueSize().then(size => console.log("AdobeExperienceSDK: Queue size: " + size));

Clear queued hits:

ACPAnalytics.clearQueue();

Set the custom visitor identifier:

ACPAnalytics.setVisitorIdentifier("yourVisitorId");

Get the custom visitor identifier:

ACPAnalytics.getVisitorIdentifier().then(vid => console.log("AdobeExperienceSDK: Visitor identifier: " + vid));

Track app actions:

ACPCore.trackAction("action", {"mytest": "action"});

Track app states:

ACPCore.trackState("state", {"mytest": "state"});

Contributing

See CONTRIBUTING

License

See LICENSE

react-native-acpanalytics's People

Contributors

nporter-adbe avatar dependabot[bot] avatar sbenedicadb avatar shtomar-adb avatar praveek avatar cacheung avatar adobe-bot avatar addb avatar yangyansong-adbe avatar emdobrin avatar matissjanis avatar shtomar-sjsu avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.