Notify President Madagascar
    Have ideas to improve npm?Join in the discussion! »

    @adobe/react-native-acptarget

    1.3.0 • Public • Published

    React Native AEP Target Extension

    npm version npm downloads CircleCI license

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

    Installation

    You need to install the SDK with npm and configure the native Android/iOS project in your react native project. Before installing the Target extension it is recommended to begin by installing 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

    2. Install JavaScript packages

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

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

    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-acptarget

    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

    Target

    Importing the extension:
    import {ACPTarget} from '@adobe/react-native-acptarget';
    Getting the extension version:
    ACPTarget.extensionVersion().then(version => console.log("AdobeExperienceSDK: ACPTarget version: " + version));
    Registering the extension with ACPCore:

    Note: It is recommended to initialize the SDK via native code inside your AppDelegate and MainApplication in iOS and Android respectively. However, you can still initialize the SDK in Javascript. For more information see how to initialize Core.

    iOS
    #import <RCTACPTarget/ACPTarget.h>
    
    [ACPTarget registerExtension];
    Android:
    import com.adobe.marketing.mobile.Target;
    
    Target.registerExtension();
    Javascript:
    import {ACPTarget} from '@adobe/react-native-acptarget';
    
    ACPTarget.registerExtension();
    Get custom visitor IDs:
    ACPTarget.getThirdPartyId().then(id => console.log("AdobeExperienceSDK: Third Party ID: " + id));
    Set custom visitor IDs:
    ACPTarget.setThirdPartyId("thirdPartyId");
    Reset user experience:
    ACPTarget.resetExperience();
    Get Target user identifier:
    ACPTarget.getTntId().then(id => console.log("AdobeExperienceSDK: TNT ID " + id));
    Load Target requests:
    var mboxParameters1 = {"status": "platinum"};
    var mboxParameters2 = {"userType": "Paid"};
    var purchaseIDs = ["34","125"];
    
    var targetOrder = new ACPTargetOrder("ADCKKIM", 344.30, purchaseIDs);
    var targetProduct = new ACPTargetProduct("24D3412", "Books");
    var parameters1 = new ACPTargetParameters(mboxParameters1, null, null, null);
    var request1 = new ACPTargetRequestObject("mboxName2", parameters1, "defaultContent1", (error, content) => {
      if (error) {
        console.error(error);
      } else {
        console.log("Adobe content:" + content);
      }
    });
    
    var parameters2 = new ACPTargetParameters(mboxParameters1, {"profileParameters": "parameterValue"}, targetProduct, targetOrder);
    var request2 = new ACPTargetRequestObject("mboxName2", parameters2, "defaultContent2", (error, content) => {
      if (error) {
        console.error(error);
      } else {
        console.log("Adobe content:" + content);
      }
    });
    
    var locationRequests = [request1, request2];
    var profileParameters1 = {"ageGroup": "20-32"};
    
    var parameters = new ACPTargetParameters({"parameters": "parametervalue"}, profileParameters1, targetProduct, targetOrder);
    ACPTarget.retrieveLocationContent(locationRequests, parameters);
    Using the prefetch APIs:
    var mboxParameters1 = {"status": "platinum"};
    var mboxParameters2 = {"userType": "Paid"};
    var purchaseIDs = ["34","125"];
    
    var targetOrder = new ACPTargetOrder("ADCKKIM", 344.30, purchaseIDs);
    var targetProduct = new ACPTargetProduct("24D3412", "Books");
    var parameters1 = new ACPTargetParameters(mboxParameters1, null, null, null);
    var prefetch1 = new ACPTargetPrefetchObject("mboxName2", parameters1);
    
    var parameters2 = new ACPTargetParameters(mboxParameters1, {"profileParameters": "parameterValue"}, targetProduct, targetOrder);
    var prefetch2 = new ACPTargetPrefetchObject("mboxName2", parameters2);
    
    var prefetchList = [prefetch1, prefetch2];
    var profileParameters1 = {"ageGroup": "20-32"};
    
    var parameters = new ACPTargetParameters({"parameters": "parametervalue"}, profileParameters1, targetProduct, targetOrder);
    ACPTarget.prefetchContent(prefetchList, parameters).then(success => console.log(success)).catch(err => console.log(err));
    Set preview restart deep link:
    ACPTarget.setPreviewRestartDeeplink("https://www.adobe.com");
    Send an mbox click notification:
    var purchaseIDs = ["34","125"];
    
    var targetOrder = new ACPTargetOrder("ADCKKIM", 344.30, purchaseIDs);
    var targetProduct = new ACPTargetProduct("24D3412", "Books");
    var profileParameters1 = {"ageGroup": "20-32"};
    var parameters = new ACPTargetParameters({"parameters": "parametervalue"}, profileParameters1, targetProduct, targetOrder);
    
    ACPTarget.locationClickedWithName("locationName", parameters);
    Send an mbox location displayed notification:
    var purchaseIDs = ["34","125"];
    
    var targetOrder = new ACPTargetOrder("ADCKKIM", 344.30, purchaseIDs);
    var targetProduct = new ACPTargetProduct("24D3412", "Books");
    var profileParameters1 = {"ageGroup": "20-32"};
    var parameters = new ACPTargetParameters({"parameters": "parametervalue"}, profileParameters1, targetProduct, targetOrder);
    
    ACPTarget.locationsDisplayed(["locationName", "locationName1"], parameters);
    ACPTargetPrefetchObject:

    The Target extension exports a class ACPTargetPrefetchObject.

    constructor(name?: string, targetParameters?: ACPTargetParameters);
    ACPTargetRequestObject:

    The Target extension exports a class ACPTargetRequestObject, which extends ACPTargetPrefetchObject.

    constructor(name: string, targetParameters: ACPTargetParameters, defaultContent: string);
    ACPTargetOrder:

    The Target extension exports a class ACPTargetOrder.

    constructor(orderId: string, total?: number, purchasedProductIds: Array<string>);
    ACPTargetProduct:

    The Target extension exports a class ACPTargetOrder.

    constructor(productId: string, categoryId: string);
    ACPTargetParameters:

    The Target extension exports a class ACPTargetParameters.

    constructor(parameters?: {string: string}, profileParameters?: {string: string}, product?: ACPTargetProduct, order?: ACPTargetOrder);

    Contributing

    See CONTRIBUTING

    License

    See LICENSE

    Install

    npm i @adobe/react-native-acptarget

    DownloadsWeekly Downloads

    961

    Version

    1.3.0

    License

    Apache-2.0

    Unpacked Size

    22.1 MB

    Total Files

    99

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar