Target API reference

Target API reference

clearPrefetchCache

This API clears the in-memory cache that contains the prefetched offers.

Android
iOS (AEP 3.x)
iOS (ACP 2.x)
React Native
Android

Syntax

public static void clearPrefetchCache()

Example

Target.clearPrefetchCache();
iOS (AEP 3.x)

Syntax

static func clearPrefetchCache()

Example

Swift

Target.clearPrefetchCache()

Objective-C

[AEPMobileTarget clearPrefetchCache];
iOS (ACP 2.x)

Syntax

+ (void) clearPrefetchCache;

Example

Swift

ACPTarget.clearPrefetchCache

Objective-C

[ACPTarget clearPrefetchCache];
React Native

Signature

clearPrefetchCache();

Example usage

ACPTarget.clearPrefetchCache();

clickedLocation

This API sends a location click notification for an mbox to the configured Target server and can be invoked in the following cases:

  • For a prefetched mbox, after the mbox content is retrieved using the retrieveLocationContent API.

  • For a regular mbox, where no previous prefetch request is made, and the mbox content is retrieved using the retrieveLocationContent API.

Android
iOS (AEP 3.x)
iOS (ACP 2.x)
React Native
Android

Syntax

public static void locationClicked(final String mboxName, final TargetParameters parameters)
  • mboxName is a String that contains the mbox location for which the click notification will be sent to Target.

  • parameters is the configured TargetParameters for the request.

Example

// Mbox parameters
Map<String, String> mboxParameters = new HashMap<>();
mboxParameters.put("membership", "prime");
// Product parameters
TargetProduct targetProduct = new TargetProduct("CEDFJC", "Electronics");
// Order parameters
List<String> purchasedIds = new ArrayList<String>();
purchasedIds.add("81");
purchasedIds.add("123");
purchasedIds.add("190");
TargetOrder targetOrder = new TargetOrder("NJJICK", "650", purchasedIds);
// Profile parameters
Map<String, String> profileParameters = new HashMap<>();
profileParameters.put("ageGroup", "20-32");
// Create Target Parameters
TargetParameters targetParameters = new TargetParameters.Builder(mboxParameters)
.profileParameters(profileParameters)
.order(targetOrder)
.product(targetProduct)
.build();
Target.locationClicked("cartLocation", targetParameters);
iOS (AEP 3.x)

Syntax

static func clickedLocation(_ name: String, targetParameters: TargetParameters?)
  • name : a String that contains the mbox location for which the click notification will be sent to Target.

  • targetParameters : the configured TargetParameters for the request.

Example

Swift

Target.clickedLocation("aep-loc-1", targetParameters: TargetParameters(parameters: ["mbox_parameter_key": "mbox_parameter_value"], profileParameters: ["name": "Smith"], order: TargetOrder(id: "id1", total: 1.0, purchasedProductIds: ["ppId1"]), product: TargetProduct(productId: "pId1", categoryId: "cId1")))

Objective-C

AEPTargetOrder *order = [[AEPTargetOrder alloc] initWithId:@"id1" total:1.0 purchasedProductIds:@[@"ppId1"]];
AEPTargetProduct *product =[[AEPTargetProduct alloc] initWithProductId:@"pId1" categoryId:@"cId1"];
AEPTargetParameters * targetParams = [[AEPTargetParameters alloc] initWithParameters:@{@"mbox_parameter_key":@"mbox_parameter_value"} profileParameters:@{@"name":@"Smith"} order:order product:product];
[AEPMobileTarget clickedLocation:@"aep-loc-1" withTargetParameters:targetParams];
iOS (ACP 2.x)

Syntax

+ (void) locationClickedWithName: (nonnull NSString*) name targetParameters: (nullable ACPTargetParameters*) parameters;
  • name is an NSString that contains the mbox location for which the click notification will be sent to Target.

  • parameters is the configured ACPTargetParameters for the request.

Example

Swift

// Mbox parameters
let mboxParameters = [
"membership": "prime"
]
// Product parameters
let productParameters = [
"id": "CEDFJC",
"categoryId": "Electronics"
]
// Order parameters
let orderParameters = [
"id": "NJJICK",
"total": "650",
"purchasedProductIds": "81, 123, 190"
]
// Profile parameters
let profileParameters = [
"ageGroup": "20-32"
]
// Create Target parameters
let product = ACPTargetProduct(id: "24D334", categoryId: "Stationary")
let order = ACPTargetOrder(id: "ADCKKBC", total: NSNumber(value: 400.50), purchasedProductIds: ["34", "125"])
let targetParameters = ACPTargetParameters(parameters: nil, profileParameters: nil, product: product, order: order)
ACPTarget.locationClicked(withName: "cartLocation", targetParameters: targetParameters)

Objective-C

// Mbox parameters
NSDictionary *mboxParameters = @{@"membership":@"prime"};
// Product parameters
NSDictionary *productParameters = @{@"id":@"CEDFJC",
@"categoryId":@"Electronics"};
// Order parameters
NSDictionary *orderParameters = @{@"id":@"NJJICK",
@"total":@"650",
@"purchasedProductIds":@"81, 123, 190"};
// Profile parameters
NSDictionary *profileParameters = @{@"ageGroup":@"20-32"};
// Create Target parameters
ACPTargetProduct *product = [ACPTargetProduct targetProductWithId:@"24D334" categoryId:@"Stationary"];
ACPTargetOrder *order = [ACPTargetOrder targetOrderWithId:@"ADCKKBC" total:@(400.50) purchasedProductIds:@[@"34", @"125"]];
ACPTargetParameters *targetParameters = [ACPTargetParameters targetParametersWithParameters:nil
profileParameters:nil
product:product
order:order];
[ACPTarget locationClickedWithName:@"cartLocation" targetParameters:targetParameters];
React Native

Syntax

locationClickedWithName(name: string, parameters?: ACPTargetParameters)
  • name is a string that contains the mbox location for which the click notification will be sent to Target.

  • parameters is the configured ACPTargetParameters for the request.

Example

// Mbox parameters
var mboxParameters = {"membership": "prime"};
// Product parameters
var productParameters = new ACPTargetProduct("CEDFJC", "Electronics");
// Order parameters
var orderParameters = new ACPTargetOrder("NJJICK", 650, ["81","123","190"]);
// Profile parameters
var profileParameters = {"ageGroup": "20-32"};
// Create Target parameters
var product = new ACPTargetProduct("24D334", "Stationary");
var order = new ACPTargetOrder("ADCKKBC", 400.50, ["34","125"]);
var targetParameters = new ACPTargetParameters(null, null, product, order);
ACPTarget.locationClickedWithName("cartLocation", targetParameters);

displayedLocations

This API sends a location display notification for an mbox to the configured Target server. The API should be invoked for a prefetched mbox after the mbox content is retrieved using the retrieveLocationContent API. If no previous prefetch request is made, and the mbox content is retrieved using the retrieveLocationContent API, calling this API does not trigger a notification request to the Target server.

Android
iOS (AEP 3.x)
iOS (ACP 2.x)
React Native
Android

Syntax

public static void locationsDisplayed(final List<String> mboxNames, final TargetParameters targetParameters)
  • mboxNames is a list of the mbox locations for which the display notification will be sent to Target.

  • targetParameters is the configured TargetParameters for the request.

Example

List<String> purchasedProductIds = new ArrayList<String>();
purchasedProductIds.add("34");
purchasedProductIds.add("125");
TargetOrder targetOrder = new TargetOrder("123", 567.89, purchasedProductIds);
TargetProduct targetProduct = new TargetProduct("123", "Books");
TargetParameters targetParameters = new TargetParameters.Builder()
.parameters(new HashMap<String, String>())
.profileParameters(new HashMap<String, String>())
.product(targetProduct)
.order(targetOrder)
.build();
List<String> mboxList = new ArrayList<>();
mboxList.add("mboxName1");
Target.locationsDisplayed(mboxList, targetParameters);
iOS (AEP 3.x)

Syntax

static func displayedLocations(_ names: [String], targetParameters: TargetParameters?)
  • names : is an array of the mbox locations for which the display notification will be sent to Target.

  • targetParameters : is the configured TargetParameters for the request.

Example

Swift

Target.displayedLocations(
["mboxName1", "mboxName2"],
targetParameters: TargetParameters(
parameters: nil,
profileParameters: nil,
order: TargetOrder(id: "ADCKKBC", total: 400.50, purchasedProductIds: ["34", "125"]),
product: TargetProduct(productId: "24D334", categoryId: "Stationary")
)
)

Objective-C

AEPTargetOrder *order = [[AEPTargetOrder alloc] initWithId:@"ADCKKBC" total:400.50 purchasedProductIds:@[@"34", @"125"]];
AEPTargetProduct *product =[[AEPTargetProduct alloc] initWithProductId:@"24D334" categoryId:@"Stationary"];
AEPTargetParameters * targetParams = [[AEPTargetParameters alloc] initWithParameters:nil profileParameters:nil order:order product:product];
[AEPMobileTarget displayedLocations:@[@"mboxName1", @"mboxName2"] withTargetParameters:targetParams];
iOS (ACP 2.x)

Syntax

+ (void) locationsDisplayed: (nonnull NSArray<NSString*>*) mboxNames
withTargetParameters: (nullable ACPTargetParameters*) targetParameters;
  • mboxNames is an NSArray of the mbox locations for which the display notification will be sent to Target.

  • targetParameters is the configured ACPTargetParameters for the request.

Example

Swift

let product = ACPTargetProduct(id: "24D334", categoryId: "Stationary")
let order = ACPTargetOrder(id: "ADCKKBC", total: NSNumber(value: 400.50), purchasedProductIds: ["34", "125"])
let targetParameters = ACPTargetParameters(parameters: nil, profileParameters: nil, product: product, order: order)
ACPTarget.locationsDisplayed(["mboxName1", "mboxName2"], with: targetParameters)

Objective-C

ACPTargetProduct *product = [ACPTargetProduct targetProductWithId:@"24D334" categoryId:@"Stationary"];
ACPTargetOrder *order = [ACPTargetOrder targetOrderWithId:@"ADCKKBC" total:@(400.50) purchasedProductIds:@[@"34", @"125"]];
ACPTargetParameters *targetParameters = [ACPTargetParameters targetParametersWithParameters:nil
profileParameters:nil
product:product
order:order];
[ACPTarget locationsDisplayed:@[@"mboxName1", @"mboxName2"] withTargetParameters:targetParameters];
React Native

Syntax

locationsDisplayed(mboxNames: Array<string>, parameters?: ACPTargetParameters)
  • mboxNames is an Array of the mbox locations for which the display notification will be sent to Target.

  • targetParameters is the configured ACPTargetParameters for the request.

Example

var product = new ACPTargetProduct("24D334", "Stationary");
var order = new ACPTargetOrder("ADCKKBC", 400.50, ["34", "125"]);
var targetParameters = new ACPTargetParameters(null, null, product, order);
ACPTarget.locationsDisplayed(["mboxName1", "mboxName2"], targetParameters);

extensionVersion

Returns the running version of the Target extension.

Android
iOS (AEP 3.x)
iOS (ACP 2.x)
React Native
Android

Syntax

public String extensionVersion()

Example

Target.extensionVersion();
iOS (AEP 3.x)

Syntax

static var extensionVersion: String

Example

Swift

let targetVersion = Target.extensionVersion

Objective-C

NSString *targetVersion = [AEPMobileTarget extensionVersion];
iOS (ACP 2.x)

Syntax

+ (nonnull NSString*) extensionVersion;

Example

Swift

let targetVersion = ACPTarget.extensionVersion()

Objective-C

NSString *targetVersion = [ACPTarget extensionVersion];
React Native

Syntax

extensionVersion(): Promise<string>

Example

ACPTarget.extensionVersion().then(version => {
// read Target extension version
});

getThirdPartyId

This API gets the custom visitor ID for Target. If no third-party ID was previously set, or if the ID was reset by calling resetExperience API, it will have a nil value.

Android
iOS (AEP 3.x)
iOS (ACP 2.x)
React Native
Android

Syntax

public static void getThirdPartyId(final AdobeCallback<String> callback)
  • callback is invoked with the thirdPartyId value. If no third-party ID was set, this value will be null.

Example

Target.getThirdPartyId(new AdobeCallback<String>() {
@Override
public void call(String thirdPartyId) {
// read Target thirdPartyId
}
});
iOS (AEP 3.x)

Syntax

static func getThirdPartyId(_ completion: @escaping (String?, Error?) -> Void)
  • completion : invoked with the thirdPartyId value. If no third-party ID was set, this value will be nil.

Example

Swift

Target.getThirdPartyId { (id, err) in
// read Target thirdPartyId
}

Objective-C

[AEPMobileTarget getThirdPartyId:^(NSString *thirdPartyID, NSError *error){
// read Target thirdPartyId
}];
iOS (ACP 2.x)

Syntax

+ (void) getThirdPartyId: (nonnull void (^) (NSString* __nullable thirdPartyId)) callback;
  • callback is invoked with the thirdPartyId value. If no third-party ID was set, this value will be nil.

Example

Swift

ACPTarget.getThirdPartyId({thirdPartyID in
// read Target thirdPartyId
})

Objective-C

[ACPTarget getThirdPartyId:^(NSString *thirdPartyId){
// read Target thirdPartyId
}];
React Native

Syntax

getThirdPartyId(): Promise<string>
  • A Promise object is returned and is resolved with the thirdPartyId value.

Example

ACPTarget.getThirdPartyId().then(thirdPartyId => {
// read Target thirdPartyId
});

getTntId

This API gets the Target user ID (also known as the tntId) from the Target service. The tntId is returned in the network response after a successful call to prefetchContent or retrieveLocationContent, which is then persisted in the SDK. This ID is preserved between app upgrades, is saved and restored during the standard application backup process, and is removed at uninstall or when the resetExperience API is used.

Android
iOS (AEP 3.x)
iOS (ACP 2.x)
React Native
Android

Syntax

public static void getTntId(final AdobeCallback<String> callback)
  • callback is invoked with the tntId value. If no Target ID was set, this value will be null.

Example

Target.getTntId(new AdobeCallback<String>() {
@Override
public void call(String tntId) {
// read target's tntid
}
});
iOS (AEP 3.x)

Syntax

static func getTntId(_ completion: @escaping (String?, Error?) -> Void)
  • completion : invoked with the tntId value. If no Target ID was set, this value will be nil.

Example

Swift

Target.getTntId({ (id, err) in
// read target's tntId
})

Objective-C

[AEPMobileTarget getTntId:^(NSString *tntID, NSError *error){
// read target's tntId
}];
iOS (ACP 2.x)

Syntax

+ (void) getTntId: (nonnull void (^) (NSString* __nullable tntId)) callback;
  • callback is invoked with the tntId value. If no Target ID was set, this value will be nil.

Example

Swift

ACPTarget.getTntId({tntId in
// read target's tntId
})

Objective-C

[ACPTarget getTntId:^(NSString *tntId){
// read target's tntId
}];
React Native

Syntax

getTntId(): Promise<string>
  • A Promise object is returned and is resolved with the thirdPartyId value.

Example

ACPTarget.getTntId().then(tntId => {
// read target's tntId
});

prefetchContent

This API sends a prefetch request to your configured Target server. The prefetch request is sent with the prefetch objects array and the specified Target parameters.

Android
iOS (AEP 3.x)
iOS (ACP 2.x)
React Native
Android

Syntax

public static void prefetchContent(final List<TargetPrefetch> mboxPrefetchList, final TargetParameters parameters, final AdobeCallback<String> callback)
  • mboxPrefetchList is a list of TargetPrefetch objects for various mbox locations.

  • parameters is the configured TargetParameters for the prefetch request.

  • If the prefetch is successful, callback is invoked with a null value. If the prefetch is not successful, an error message is returned.

Example

// first prefetch request
Map<String, String> mboxParameters1 = new HashMap<>();
mboxParameters1.put("status", "platinum");
TargetParameters targetParameters1 = new TargetParameters.Builder()
.parameters(mboxParameters1)
.build();
TargetPrefetch prefetchRequest1 = new TargetPrefetch("mboxName1", targetParameters1);
// second prefetch request
Map<String, String> mboxParameters2 = new HashMap<>();
mboxParameters2.put("userType", "paid");
List<String> purchasedIds = new ArrayList<String>();
purchasedIds.add("34");
purchasedIds.add("125");
TargetOrder targetOrder = new TargetOrder("ADCKKIM", 344.30, purchasedIds);
TargetProduct targetProduct = new TargetProduct("24D3412", "Books");
TargetParameters targetParameters2 = new TargetParameters.Builder()
.parameters(mboxParameters2)
.product(targetProduct)
.order(targetOrder)
.build();
TargetPrefetch prefetchRequest2 = new TargetPrefetch("mboxName2", targetParameters2);
List<TargetPrefetch> prefetchMboxesList = new ArrayList<>();
prefetchMboxesList.add(prefetchRequest1);
prefetchMboxesList.add(prefetchRequest2);
// Call the prefetchContent API.
TargetParamters targetParameters = null;
Target.prefetchContent(prefetchMboxesList, targetParameters, prefetchStatusCallback);
iOS (AEP 3.x)

Syntax

static func prefetchContent(_ prefetchArray: [TargetPrefetch], with targetParameters: TargetParameters? = nil, _ completion: ((Error?) -> Void)?)
  • prefetchArray - is an array of TargetPrefetch objects for various mbox locations.

  • targetParameters - is the configured TargetParameters for the prefetch request.

  • If the prefetch is successful, completion is invoked with a nil value. If the prefetch is not successful, an error message is returned.

Example

Swift

let TargetParameters1 = TargetParameters(
parameters: ["status": "platinum"],
profileParameters: ["age": "20"],
order: TargetOrder(id: "ADCKKIM", total: 344.30, purchasedProductIds: ["34", "125"]),
product: TargetProduct(productId: "24D3412", categoryId:"Books")
)
let TargetParameters2 = TargetParameters(
parameters: ["userType": "Paid"],
profileParameters: nil,
order: TargetOrder(id: "ADCKKIM", total: 344.30, purchasedProductIds: ["id1", "id2"]),
product: TargetProduct(productId: "764334", categoryId:"Online")
)
let globalTargetParameters = TargetParameters(
parameters: ["status": "progressive"],
profileParameters: ["age": "20-32"],
order: TargetOrder(id: "ADCKKBC", total: 400.50, purchasedProductIds: ["34", "125"]),
product: TargetProduct(productId: "24D334", categoryId:"Stationary")
)
Target.prefetchContent([
TargetPrefetch(name: "mboxName1", targetParameters: TargetParameters1),
TargetPrefetch(name: "mboxName2", targetParameters: TargetParameters2),
],
with: globalTargetParameters
){ error in
// do something with the callback response
}

Objective-C

NSDictionary *mboxParameters1 = @{@"status":@"platinum"};
NSDictionary *profileParameters1 = @{@"age":@"20"};
AEPTargetProduct *product1 = [[AEPTargetProduct alloc] initWithProductId:@"24D3412" categoryId:@"Books"];
AEPTargetOrder *order1 = [[AEPTargetOrder alloc] initWithId:@"ADCKKIM" total:[@(344.30) doubleValue] purchasedProductIds:@[@"34", @"125"]];
AEPTargetParameters *targetParameters1 = [[AEPTargetParameters alloc] initWithParameters:mboxParameters1 profileParameters:profileParameters1 order:order1 product:product1 ];
NSDictionary *mboxParameters2 = @{@"userType":@"Paid"};
AEPTargetProduct *product2 = [[AEPTargetProduct alloc] initWithProductId:@"764334" categoryId:@"Online"];
AEPTargetOrder *order2 = [[AEPTargetOrder alloc] initWithId:@"ADCKKIM" total:[@(344.30) doubleValue] purchasedProductIds:@[@"id1",@"id2"]];
AEPTargetParameters *targetParameters2 = [[AEPTargetParameters alloc] initWithParameters:mboxParameters2 profileParameters:nil order:order2 product:product2 ];
// Creating Prefetch Objects
AEPTargetPrefetchObject *prefetch1 = [[AEPTargetPrefetchObject alloc] initWithName: @"logo" targetParameters:targetParameters1];
AEPTargetPrefetchObject *prefetch2 = [[AEPTargetPrefetchObject alloc] initWithName: @"buttonColor" targetParameters:targetParameters2];
// Creating prefetch Array
NSArray *prefetchArray = @[prefetch1,prefetch2];
// Creating Target parameters
NSDictionary *mboxParameters = @{@"status":@"progressive"};
NSDictionary *profileParameters = @{@"age":@"20-32"};
AEPTargetProduct *product = [[AEPTargetProduct alloc] initWithProductId:@"24D334" categoryId:@"Stationary"];
AEPTargetOrder *order = [[AEPTargetOrder alloc] initWithId:@"ADCKKBC" total:[@(400.50) doubleValue] purchasedProductIds:@[@"34", @"125"]];
AEPTargetParameters *targetParameters = [[AEPTargetParameters alloc] initWithParameters:mboxParameters
profileParameters:profileParameters
order:order
product:product];
// Target API Call
[AEPMobileTarget prefetchContent:prefetchArray withParameters:targetParameters callback:^(NSError * _Nullable error){
// do something with the callback response
}];
iOS (ACP 2.x)

Syntax

+ (void) prefetchContent: (nonnull NSArray<ACPTargetPrefetchObject*>*) prefetchObjectArray
withParameters: (nullable ACPTargetParameters*) parameters
callback: (nullable void (^) (NSError* _Nullable error)) callback;

Example

Swift

let mboxParameters1 = [
"status": "platinum"
]
let profileParameters1 = [
"age": "20"
]
let product1 = ACPTargetProduct(id: "24D3412", categoryId: "Books")
let order1 = ACPTargetOrder(id: "ADCKKIM", total: NSNumber(value: 344.30), purchasedProductIds: ["34", "125"])
let targetParameters1 = ACPTargetParameters(parameters: mboxParameters1, profileParameters: profileParameters1, product: product1, order: order1)
let mboxParameters2 = [
"userType": "Paid"
]
let product2 = ACPTargetProduct(id: "764334", categoryId: "Online")
let order2 = ACPTargetOrder(id: "ADCKKIM", total: NSNumber(value: 344.30), purchasedProductIds: ["id1", "id2"])
let targetParameters2 = ACPTargetParameters(parameters: mboxParameters2, profileParameters: nil, product: product2, order: order2)
// Creating Prefetch Objects
let prefetch1 = ACPTargetPrefetchObject(name: "logo", targetParameters: targetParameters1)
let prefetch2 = ACPTargetPrefetchObject(name: "buttonColor", targetParameters: targetParameters2)
// Creating prefetch Array
let prefetchArray = [prefetch1, prefetch2]
// Creating Target parameters
let mboxParameters = [
"status": "progressive"
]
let profileParameters = [
"age": "20-32"
]
let product = ACPTargetProduct(id: "24D334", categoryId: "Stationary")
let order = ACPTargetOrder(id: "ADCKKBC", total: NSNumber(value: 400.50), purchasedProductIds: ["34", "125"])
let targetParameters = ACPTargetParameters(parameters: mboxParameters, profileParameters: profileParameters, product: product, order: order)
// Target API Call
ACPTarget.prefetchContent(prefetchArray, with: targetParameters, callback: { error in
// do something with the callback response
})

Objective-C

NSDictionary *mboxParameters1 = @{@"status":@"platinum"};
NSDictionary *profileParameters1 = @{@"age":@"20"};
ACPTargetProduct *product1 = [ACPTargetProduct targetProductWithId:@"24D3412" categoryId:@"Books"];
ACPTargetOrder *order1 = [ACPTargetOrder targetOrderWithId:@"ADCKKIM" total:@(344.30) purchasedProductIds:@[@"34", @"125"]];
ACPTargetParameters *targetParameters1 = [ACPTargetParameters targetParametersWithParameters:mboxParameters1
profileParameters:profileParameters1
product:product1
order:order1];
NSDictionary *mboxParameters2 = @{@"userType":@"Paid"};
ACPTargetProduct *product2 = [ACPTargetProduct targetProductWithId:@"764334" categoryId:@"Online"];
ACPTargetOrder *order2 = [ACPTargetOrder targetOrderWithId:@"ADCKKIM" total:@(344.30) purchasedProductIds:@[@"id1",@"id2"]];
ACPTargetParameters *targetParameters2 = [ACPTargetParameters targetParametersWithParameters:mboxParameters2
profileParameters:nil
product:product2
order:order2];
// Creating Prefetch Objects
ACPTargetPrefetchObject *prefetch1 = [ACPTargetPrefetchObject targetPrefetchObjectWithName:@"logo"
targetParameters:targetParameters1];
ACPTargetPrefetchObject *prefetch2 = [ACPTargetPrefetchObject targetPrefetchObjectWithName:@"buttonColor"
targetParameters:targetParameters2];
// Creating prefetch Array
NSArray *prefetchArray = @[prefetch1,prefetch2];
// Creating Target parameters
NSDictionary *mboxParameters = @{@"status":@"progressive"};
NSDictionary *profileParameters = @{@"age":@"20-32"};
ACPTargetProduct *product = [ACPTargetProduct targetProductWithId:@"24D334" categoryId:@"Stationary"];
ACPTargetOrder *order = [ACPTargetOrder targetOrderWithId:@"ADCKKBC" total:@(400.50) purchasedProductIds:@[@"34", @"125"]];
ACPTargetParameters *targetParameters = [ACPTargetParameters targetParametersWithParameters:mboxParameters
profileParameters:profileParameters
product:product
order:order];
// Target API Call
[ACPTarget prefetchContent:prefetchArray withParameters:targetParameters callback:^(NSError * _Nullable error){
// do something with the callback response
}];
React Native

Syntax

prefetchContent(prefetchObjectArray: Array<ACPTargetPrefetchObject>, parameters?: ACPTargetParameters): Promise<any>
  • prefetchObjectArray is an Array of ACPTargetPrefetchObject objects for various mbox locations.

  • parameters is the configured ACPTargetParameters for the prefetch request.

  • A Promise object is returned and is resolved with true value or is rejected with the reason for the error.

Example

var mboxParameters1 = {"status": "platinum"};
var profileParameters1 = {"age": "20"};
var product1 = new ACPTargetProduct("24D3412", "Books");
var order1 = new ACPTargetOrder("ADCKKIM", 344.30, ["34","125"]);
var targetParameters1 = new ACPTargetParameters(mboxParameters1, profileParameters1, product1, order1);
var mboxParameters2 = {"userType": "Paid"};
var product2 = new ACPTargetProduct("764334", "Online");
var order2 = new ACPTargetOrder("ADCKKIM", 344.30, ["id1","id2"]);
var targetParameters2 = new ACPTargetParameters(mboxParameters2, null, product2, order2);
// Creating Prefetch Objects
var prefetch1 = new ACPTargetPrefetchObject("logo", targetParameters1);
var prefetch2 = new ACPTargetPrefetchObject("buttonColor", targetParameters2);
// Creating prefetch Array
var prefetchList = [prefetch1, prefetch2];
// Creating Target parameters
var mboxParameters = {"status": "progressive"};
var profileParameters = {"age": "20-32"};
var product = new ACPTargetProduct("24D334", "Stationary");
var order = new ACPTargetOrder("ADCKKBC", 400.50, ["34","125"]);
var targetParameters = new ACPTargetParameters(mboxParameters, profileParameters, product, order);
// Target API Call
ACPTarget.prefetchContent(prefetchList, targetParameters).then(success => console.log(success)).catch(err => console.log(err));

registerExtension

Registers the Target extension with the Mobile Core.

Android
iOS (AEP 3.x)
iOS (ACP 2.x)
React Native
Android

Syntax

public static void registerExtension()

Example

Target.registerExtension();
iOS (AEP 3.x)

This API no longer exists in Target. Instead, the extension should be registered by calling the registerExtensions API in the MobileCore. Please see the updated SDK initialization steps at the migrate to Swift tutorial.

iOS (ACP 2.x)

Syntax

+ (void) registerExtension;

Example

Swift

ACPTarget.registerExtension()

Objective-C

[ACPTarget registerExtension];
React Native

When using React Native, register the Target extension with Mobile Core in native code as shown on the Android and iOS tabs.

resetExperience

This API resets the user's experience by removing the visitor identifiers and resetting the Target session. Invoking this API also removes previously set Target user ID and custom visitor IDs, Target Edge Host, and the session information from persistent storage.

Android
iOS (AEP 3.x)
iOS (ACP 2.x)
React Native
Android

Syntax

public static void resetExperience()

Example

Target.resetExperience();
iOS (AEP 3.x)

Syntax

static func resetExperience()

Example

Swift

Target.resetExperience()

Objective-C

[AEPMobileTarget resetExperience];
iOS (ACP 2.x)

Syntax

+ (void) resetExperience;

Example

Swift

ACPTarget.resetExperience()

Objective-C

[ACPTarget resetExperience];
React Native

Syntax

resetExperience()

Example

ACPTarget.resetExperience();

retrieveLocationContent

This API sends a batch request to the configured Target server for multiple mbox locations.

A request will be sent to the configured Target server for mbox locations in the requests array for Target requests that have not been previously prefetched. The content for the mbox locations that have been prefetched in a previous request are returned from the SDK, and no additional network request is made. Each Target request object in the list contains a callback function, which is invoked when content is available for its given mbox location.

When using contentWithData callback to instantiate TargetRequest object, the following keys can be used to read response tokens and Analytics for Target (A4T) info from the data payload, if available in the Target response.

  • responseTokens (Response tokens)

  • analytics.payload (A4T payload)

  • clickmetric.analytics.payload (Click tracking A4T payload)

Android
iOS (AEP 3.x)
iOS (ACP 2.x)
React Native
Android

Syntax

public static void retrieveLocationContent(final List<TargetRequest> targetRequestList, final TargetParameters parameters)
  • targetRequestList is a list of TargetRequest objects for various mbox locations.

  • parameters is the configured TargetParameters for the retrieve location request.

Example

// define parameters for first request
Map<String, String> mboxParameters1 = new HashMap<>();
mboxParameters1.put("status", "platinum");
TargetParameters parameters1 = new TargetParameters.Builder().parameters(mboxParameters1).build();
TargetRequest request1 = new TargetRequest("mboxName1", parameters1, "defaultContent1",
new AdobeCallback<String>() {
@Override
public void call(String value) {
// do something with target content.
}
});
// define parameters for second request
Map<String, String> mboxParameters2 = new HashMap<>();
mboxParameters2.put("userType", "paid");
List<String> purchasedIds = new ArrayList<String>();
purchasedIds.add("34");
purchasedIds.add("125");
TargetOrder targetOrder = new TargetOrder("ADCKKIM", 344.30, purchasedIds);
TargetProduct targetProduct = new TargetProduct("24D3412", "Books");
TargetParameters parameters2 = new TargetParameters.Builder()
.parameters(mboxParameters2)
.product(targetProduct)
.order(targetOrder)
.build();
TargetRequest request2 = new TargetRequest("mboxName2", parameters2, "defaultContent2",
new AdobeTargetDetailedCallback() {
@Override
public void call(final String content, final Map<String, Object> data) {
if (content != null && !content.isEmpty()) {
// do something with the target content.
}
// Read the data Map containing one or more of response tokens, analytics payload
// and click metric analytics payload, if available
if (data != null && !data.isEmpty()) {
Map<String, String> responseTokens = data.containsKey("responseTokens") ?
(Map<String, String>) data.get("responseTokens") :
null;
Map<String, String> analyticsPayload = data.containsKey("analytics.payload") ?
(Map<String, String>) data.get("analytics.payload") :
null;
Map<String, String> clickMetricAnalyticsPayload = data.containsKey("clickmetric.analytics.payload") ?
(Map<String, String>) data.get("clickmetric.analytics.payload") :
null;
...
}
}
@Overrides
void fail(final AdobeError error) {
// take appropriate action upon error.
}
});
// Creating Array of Request Objects
List<TargetRequest> locationRequests = new ArrayList<>();
locationRequests.add(request1);
locationRequests.add(request2);
// Define the profile parameters map.
Map<String, String> profileParameters1 = new HashMap<>();
profileParameters1.put("ageGroup", "20-32");
TargetParameters parameters = new TargetParameters.Builder().profileParameters(profileParameters1).build();
// Call the targetRetrieveLocationContent API.
Target.retrieveLocationContent(locationRequests, parameters);
iOS (AEP 3.x)

Syntax

static func retrieveLocationContent(_ requestArray: [TargetRequest], with targetParameters: TargetParameters? = nil)
  • requestArray - an array of TargetRequest objects to retrieve content

  • targetParameters - a TargetParameters object containing parameters for all locations in the requests array

Example

Swift

let TargetParameters1 = TargetParameters(
parameters: ["status": "platinum"],
profileParameters: ["age": "20"],
order: TargetOrder(id: "ADCKKIM", total: 344.30, purchasedProductIds: ["34", "125"]),
product: TargetProduct(productId: "24D3412", categoryId: "Books")
)
let TargetParameters2 = TargetParameters(
parameters: ["userType": "Paid"],
profileParameters: nil,
order: TargetOrder(id: "ADCKKIM", total: 344.30, purchasedProductIds: ["id1", "id2"]),
product: TargetProduct(productId: "764334", categoryId: "Online")
)
let globalTargetParameters = TargetParameters(
parameters: ["status": "progressive"],
profileParameters: ["age": "20-32"],
order: TargetOrder(id: "ADCKKBC", total: 400.50, purchasedProductIds: ["34", "125"]),
product: TargetProduct(productId: "24D334", categoryId: "Stationary")
)
let request1 = TargetRequest(mboxName: "logo", defaultContent: "BlueWhale", targetParameters: TargetParameters1) { content in
if let content = content {
// do something with the target content.
}
}
let request2 = TargetRequest(mboxName: "logo", defaultContent: "red", targetParameters: TargetParameters2) { content, data in
if let content = content {
// do something with the target content.
}
// Read the data dictionary containing one or more of response tokens, analytics payload and click-tracking analytics payload, if available.
if let data = data {
let responseTokens = data["responseTokens"] as? [String: String] ?? [:]
let analyticsPayload = data["analytics.payload"] as? [String: String] ?? [:]
let clickMetricAnalyticsPayload = data["clickmetric.analytics.payload"] as? [String: String] ?? [:]
...
}
}
Target.retrieveLocationContent([request1, request2], with: globalTargetParameters)

Objective-C

NSDictionary *mboxParameters1 = @{@"status":@"platinum"};
NSDictionary *profileParameters1 = @{@"age":@"20"};
AEPTargetProduct *product1 = [[AEPTargetProduct alloc] initWithProductId:@"24D3412" categoryId:@"Books"];
AEPTargetOrder *order1 = [[AEPTargetOrder alloc] initWithId:@"ADCKKIM" total:[@(344.30) doubleValue] purchasedProductIds:@[@"34", @"125"]];
AEPTargetParameters *targetParameters1 = [[AEPTargetParameters alloc] initWithParameters:mboxParameters1 profileParameters:profileParameters1 order:order1 product:product1 ];
NSDictionary *mboxParameters2 = @{@"userType":@"Paid"};
AEPTargetProduct *product2 = [[AEPTargetProduct alloc] initWithProductId:@"764334" categoryId:@"Online"];
AEPTargetOrder *order2 = [[AEPTargetOrder alloc] initWithId:@"ADCKKIM" total:[@(344.30) doubleValue] purchasedProductIds:@[@"id1",@"id2"]];
AEPTargetParameters *targetParameters2 = [[AEPTargetParameters alloc] initWithParameters:mboxParameters2 profileParameters:nil order:order2 product:product2 ];
AEPTargetRequestObject *request1 = [[AEPTargetRequestObject alloc] initWithMboxName: @"logo" defaultContent: @"BlueWhale" targetParameters: targetParameters1 contentCallback:^(NSString * _Nullable content) {
// do something with the received content
NSString *targetContent = content ?: @"";
}];
AEPTargetRequestObject *request2 = [[AEPTargetRequestObject alloc] initWithMboxName: @"logo" defaultContent: @"red" targetParameters: targetParameters2 contentWithDataCallback:^(NSString * _Nullable content, NSDictionary<NSString *,id> * _Nullable data) {
// do something with the target content.
NSString *targetContent = content ?: @"";
// Read the data dictionary containing one or more of response tokens, analytics payload and click-tracking analytics payload, if available.
if ([data count] > 0) {
if ([data objectForKey:@"responseTokens"]) {
// read response tokens
}
if ([data objectForKey:@"analytics.payload"]) {
// read analytics payload
}
if ([data objectForKey:@"clickmetric.analytics.payload"]) {
// read click-tracking analytics payload
}
}
}];
// Create request object array
NSArray *requestArray = @[request1,request2];
// Creating Target parameters
NSDictionary *mboxParameters = @{@"status":@"progressive"};
NSDictionary *profileParameters = @{@"age":@"20-32"};
AEPTargetProduct *product = [[AEPTargetProduct alloc] initWithProductId:@"24D334" categoryId:@"Stationary"];
AEPTargetOrder *order = [[AEPTargetOrder alloc] initWithId:@"ADCKKBC" total:[@(400.50) doubleValue] purchasedProductIds:@[@"34", @"125"]];
AEPTargetParameters *targetParameters = [[AEPTargetParameters alloc] initWithParameters:mboxParameters
profileParameters:profileParameters
order:order
product:product];
[AEPMobileTarget retrieveLocationContent: requestArray withParameters: targetParameters];
iOS (ACP 2.x)

Syntax

+ (void) retrieveLocationContent: (nonnull NSArray<ACPTargetRequestObject*>*) requests
withParameters: (nullable ACPTargetParameters*) parameters;
  • requests is an NSArray of ACPTargetRequestObject objects for various mbox locations.

  • parameters is the configured ACPTargetParameters for the load request.

Example

Swift

let mboxParameters1 = [
"status": "platinum"
]
let product1 = ACPTargetProduct(id: "24D3412", categoryId: "Books")
let order1 = ACPTargetOrder(id: "ADCKKIM", total: NSNumber(value: 344.30), purchasedProductIds: ["a", "b"])
let mboxParameters2 = [
"userType": "Paid"
]
let product2 = ACPTargetProduct(id: "764334", categoryId: "Online")
let order2 = ACPTargetOrder(id: "4t4uxksa", total: NSNumber(value: 54.90), purchasedProductIds: ["id1", "id2"])
let params1 = ACPTargetParameters(parameters: mboxParameters1, profileParameters: nil, product: product1, order: order1)
let request1 = ACPTargetRequestObject(name: "logo", targetParameters: params1, defaultContent: "BlueWhale", callback: { content in
// do something with the received content
})
let params2 = ACPTargetParameters(parameters: mboxParameters2, profileParameters: nil, product: product2, order: order2)
let request2 = ACPTargetRequestObject(name: "logo", targetParameters: params2, defaultContent: "red", callback: { content in
// do something with the received content
})
// Create request object array
let requestArray = [request1, request2]
// Creating Target parameters
let mboxParameters = [
"status": "progressive"
]
let profileParameters = [
"age": "20-32"
]
let product = ACPTargetProduct(id: "24D334", categoryId: "Stationary")
let order = ACPTargetOrder(id: "ADCKKBC", total: NSNumber(value: 400.50), purchasedProductIds: ["34", "125"])
let targetParameters = ACPTargetParameters(parameters: mboxParameters, profileParameters: profileParameters, product: product, order: order)
// Call the API
ACPTarget.retrieveLocationContent(requestArray, with: targetParameters)

Objective-C

NSDictionary *mboxParameters1 = @{@"status":@"platinum"};
ACPTargetProduct *product1 = [ACPTargetProduct targetProductWithId:@"24D3412" categoryId:@"Books"];
ACPTargetOrder *order1 = [ACPTargetOrder targetOrderWithId:@"ADCKKIM" total:@(344.30) purchasedProductIds:@[@"a", @"b"]];
NSDictionary *mboxParameters2 = @{@"userType":@"Paid"};
ACPTargetProduct *product2 = [ACPTargetProduct targetProductWithId:@"764334" categoryId:@"Online"];
ACPTargetOrder *order2 = [ACPTargetOrder targetOrderWithId:@"4t4uxksa" total:@(54.90) purchasedProductIds:@[@"id1",@"id2"]];
ACPTargetParameters *params1 = [ACPTargetParameters targetParametersWithParameters:mboxParameters1
profileParameters:nil
product:product1
order:order1];
ACPTargetRequestObject *request1 = [ACPTargetRequestObject targetRequestObjectWithName:@"logo" targetParameters:params1
defaultContent:@"BlueWhale" callback:^(NSString * _Nullable content) {
// do something with the received content
}];
ACPTargetParameters *params2 = [ACPTargetParameters targetParametersWithParameters:mboxParameters2
profileParameters:nil
product:product2
order:order2];
ACPTargetRequestObject *request2 = [ACPTargetRequestObject targetRequestObjectWithName:@"logo" targetParameters:params2
defaultContent:@"red" callback:^(NSString * _Nullable content) {
// do something with the received content
}];
// Create request object array
NSArray *requestArray = @[request1,request2];
// Creating Target parameters
NSDictionary *mboxParameters = @{@"status":@"progressive"};
NSDictionary *profileParameters = @{@"age":@"20-32"};
ACPTargetProduct *product = [ACPTargetProduct targetProductWithId:@"24D334" categoryId:@"Stationary"];
ACPTargetOrder *order = [ACPTargetOrder targetOrderWithId:@"ADCKKBC" total:@(400.50) purchasedProductIds:@[@"34", @"125"]];
ACPTargetParameters *targetParameters = [ACPTargetParameters targetParametersWithParameters:mboxParameters
profileParameters:profileParameters
product:product
order:order];
// Call the API
[ACPTarget retrieveLocationContent:requestArray withParameters:targetParameters];
React Native

Syntax

retrieveLocationContent(requests: Array<ACPTargetRequestObject>, parameters?: ACPTargetParameters)
  • requests is an Array of ACPTargetRequestObject objects for various mbox locations.

  • parameters is the configured ACPTargetParameters for the load request.

Example

var mboxParameters1 = {"status": "platinum"};
var product1 = new ACPTargetProduct("24D3412", "Books");
var order1 = new ACPTargetOrder("ADCKKIM", 344.30, ["a","b"]);
var mboxParameters2 = {"userType": "Paid"};
var product2 = new ACPTargetProduct("764334", "Online");
var order2 = new ACPTargetOrder("4t4uxksa", 54.90, ["id1","id2"]);
var params1 = new ACPTargetParameters(mboxParameters1, null, product1, order1);
var request1 = new ACPTargetRequestObject("logo", params1, "BlueWhale", (error, content) => {
if (error) {
console.error(error);
} else {
console.log("Target content:" + content);
}
});
var params2 = new ACPTargetParameters(mboxParameters2, null, product2, order2);
var request2 = new ACPTargetRequestObject("logo", params1, "red", (error, content) => {
if (error) {
console.error(error);
} else {
console.log("Target content:" + content);
}
});
// Create request object array
let requestArray = [request1, request2]
// Creating Target parameters
var mboxParameters = {"status": "progressive"};
var profileParameters = {"age": "20-32"};
var product = new ACPTargetProduct("24D334", "Stationary");
var order = new ACPTargetOrder("ADCKKBC", 400.50, ["34","125"]);
var targetParameters = new ACPTargetParameters(mboxParameters, profileParameters, product, order);
// Target API Call
ACPTarget.retrieveLocationContent(requestArray, targetParameters);

This API sets a specific location in the app to be displayed when preview mode selections have been confirmed.

Android
iOS (AEP 3.x)
iOS (ACP 2.x)
React Native
Android

Syntax

public static void setPreviewRestartDeepLink(final Uri deepLink)
  • deeplink is a Uri that contains the preview restart deeplink.

Example

Target.setPreviewRestartDeepLink("myapp://HomePage");
iOS (AEP 3.x)

Syntax

static func setPreviewRestartDeepLink(_ deeplink: URL)
  • deeplink : a URL that contains the preview restart deeplink.

Example

Swift

if let url = URL(string: "myapp://HomePage") {
Target.setPreviewRestartDeepLink(url)
}

Objective-C

[AEPMobileTarget setPreviewRestartDeepLink:@"myapp://HomePage"];
iOS (ACP 2.x)

Syntax

+ (void) setPreviewRestartDeeplink: (nonnull NSURL*) deeplink;
  • deeplink is an NSURL that contains the preview restart deeplink.

Example

Swift

ACPTarget.setPreviewRestartDeepLink("myapp://HomePage")

Objective-C

[ACPTarget setPreviewRestartDeepLink:@"myapp://HomePage"];
React Native

Syntax

setPreviewRestartDeeplink(deepLink: string)
  • deepLink is a string that contains the preview restart deeplink.

Example

ACPTarget.setPreviewRestartDeeplink("myapp://HomePage");

setThirdPartyId

This API sets the custom visitor ID for Target. This ID is preserved between app upgrades, is saved and restored during the standard application backup process, and is removed at uninstall or when the resetExperience API is used.

Android
iOS (AEP 3.x)
iOS (ACP 2.x)
React Native
Android

Syntax

public static void setThirdPartyId(final String thirdPartyId)
  • thirdPartyId is a String that contains the custom visitor ID to be set in Target.

Example

Target.setThirdPartyId("third-party-id");
iOS (AEP 3.x)

Syntax

static func setThirdPartyId(_ id: String)
  • id : a String that contains the custom visitor ID to be set in Target.

Example

Swift

Target.setThirdPartyId("third-party-id")

Objective-C