React Native AEP Target Extension


@adobe/react-native-aeptarget is a wrapper around the iOS and Android AEP Target SDK to allow integration with React Native applications.

Peer Dependencies

The Adobe Experience Platform Target extension has the following peer dependency, which must be installed prior to installing the target extension:

- Core
- Edge

Installation

See Requirements and Installation instructions on the main page

Install the @adobe/react-native-aeptarget package:

NPM:

``bash
npm install @adobe/react-native-aeptarget
`

Yarn:

`bash
yarn add @adobe/react-native-aeptarget
`

Usage

$3

To initialize the SDK, use the following methods:
- MobileCore.initializeWithAppId(appId)
- MobileCore.initialize(initOptions)

Refer to the root Readme for more information about the SDK setup.

$3

`typescript
import {
Target,
TargetOrder,
TargetParameters,
TargetPrefetchObject,
TargetProduct,
TargetRequestObject,
} from "@adobe/react-native-aeptarget";
`

API Reference

$3

Syntax

`typescript
extensionVersion(): Promise
`

Example

`typescript
const version = await Target.extensionVersion();
console.log("AdobeExperienceSDK: AEPTarget version: " + version);
`

$3

Syntax

`typescript
getThirdPartyId(): Promise
`

Example

`typescript
const id = await Target.getThirdPartyId();
console.log("AdobeExperienceSDK: Third Party ID: " + id);
`

$3

Syntax

`typescript
setThirdPartyId(): void
`

Example

`typescript
Target.setThirdPartyId("thirdPartyId");
`

$3

Syntax

`typescript
resetExperience(): void
`

Example

`typescript
Target.resetExperience();
`

$3

Syntax

`typescript
getSessionId(): Promise
`

Example

`typescript
const id = await Target.getSessionId();
console.log("AdobeExperienceSDK: Session ID " + id);
`

$3

Syntax

`typescript
getTntId(): Promise
`

Example

`typescript
const id = await Target.getTntId();
console.log("AdobeExperienceSDK: TNT ID " + id);
`

$3

Syntax

`typescript
retrieveLocationContent(Array, ): void
`

Example

`typescript
var mboxParameters1 = { status: "platinum" };
var mboxParameters2 = { userType: "Paid" };
var purchaseIDs = ["34", "125"];

var targetOrder = new TargetOrder("ADCKKIM", 344.3, purchaseIDs);
var targetProduct = new TargetProduct("24D3412", "Books");
var parameters1 = new TargetParameters(mboxParameters1, null, null, null);
var request1 = new TargetRequestObject(
"mboxName2",
parameters1,
"defaultContent1",
(error, content) => {
if (error) {
console.error(error);
} else {
console.log("Adobe content:" + content);
}
}
);

var parameters2 = new TargetParameters(
mboxParameters1,
{ profileParameters: "parameterValue" },
targetProduct,
targetOrder
);
var request2 = new TargetRequestObject(
"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 TargetParameters(
{ parameters: "parametervalue" },
profileParameters1,
targetProduct,
targetOrder
);
Target.retrieveLocationContent(locationRequests, parameters);
`

$3

Syntax

`typescript
prefetchContent(Array, ): Promise
`

Example

`typescript
var mboxParameters1 = { status: "platinum" };
var mboxParameters2 = { userType: "Paid" };
var purchaseIDs = ["34", "125"];

var targetOrder = new TargetOrder("ADCKKIM", 344.3, purchaseIDs);
var targetProduct = new TargetProduct("24D3412", "Books");
var parameters1 = new TargetParameters(mboxParameters1, null, null, null);
var prefetch1 = new TargetPrefetchObject("mboxName2", parameters1);

var parameters2 = new TargetParameters(
mboxParameters1,
{ profileParameters: "parameterValue" },
targetProduct,
targetOrder
);
var prefetch2 = new TargetPrefetchObject("mboxName2", parameters2);

var prefetchList = [prefetch1, prefetch2];
var profileParameters1 = { ageGroup: "20-32" };

var parameters = new TargetParameters(
{ parameters: "parametervalue" },
profileParameters1,
targetProduct,
targetOrder
);
Target.prefetchContent(prefetchList, parameters)
.then((success) => console.log(success))
.catch((err) => console.log(err));
`

$3

Syntax

`typescript
Target.setSessionId(): void
`

Example

`typescript
Target.setSessionId("sessionId");
`

$3

Syntax

`typescript
Target.setTntId(): void
`

Example

`typescript
Target.setTntId("tntId");
`

$3

Syntax

`typescript
setPreviewRestartDeeplink(): void;
`

Example

`typescript
Target.setPreviewRestartDeeplink("https://www.adobe.com");
`

$3

Syntax

`typescript
clickedLocation(, ): void;
`

Example

`typescript
var purchaseIDs = ["34", "125"];

var targetOrder = new TargetOrder("ADCKKIM", 344.3, purchaseIDs);
var targetProduct = new TargetProduct("24D3412", "Books");
var profileParameters1 = { ageGroup: "20-32" };
var parameters = new TargetParameters(
{ parameters: "parametervalue" },
profileParameters1,
targetProduct,
targetOrder
);

Target.clickedLocation("locationName", parameters);
`

$3

Syntax

`typescript
displayedLocations(Array, ): void;
`

Example

`typescript
var purchaseIDs = ["34", "125"];

var targetOrder = new TargetOrder("ADCKKIM", 344.3, purchaseIDs);
var targetProduct = new TargetProduct("24D3412", "Books");
var profileParameters1 = { ageGroup: "20-32" };
var parameters = new TargetParameters(
{ parameters: "parametervalue" },
profileParameters1,
targetProduct,
targetOrder
);

Target.displayedLocations(["locationName", "locationName1"], parameters);
`

$3

The Target extension exports a class TargetPrefetchObject.

`typescript
constructor(name?: string, targetParameters?: TargetParameters);
`

$3

The Target extension exports a class TargetRequestObject, which extends TargetPrefetchObject.

`typescript
constructor(name: string, targetParameters: TargetParameters, defaultContent: string);
`

$3

The Target extension exports a class TargetOrder.

`typescript
constructor(orderId: string, total?: number, purchasedProductIds: Array);
`

$3

The Target extension exports a class TargetOrder.

`typescript
constructor(productId: string, categoryId: string);
`

$3

The Target extension exports a class TargetParameters.

`typescript
constructor(parameters?: Record, profileParameters?: Record, product?: TargetProduct, order?: TargetOrder);
``