Target Raw API reference

executeRawRequest

This API can be used to retrieve prefetch or execute responses for mbox locations from the configured Target server.

Android

Java

Syntax

public static void executeRawRequest(final Map<String, Object> request, final AdobeCallback<Map<String, Object>> callback)
Copied to your clipboard
public static void executeRawRequest(final Map<String, Object> request, final AdobeCallback<Map<String, Object>> callback)

request: A map containing prefetch or execute request data in the Target v1 delivery API request format.
callback: An AdobeCallback instance which will be called after the Target request is completed. The parameter in the callback will contain the response data if the request executed successfully, or it will contain null otherwise.

Example

final Map<String, Object> executeMbox1 = new HashMap<String, Object>() {
    {
        put("index", 0);
        put("name", "mbox1");
        put("parameters", new HashMap<String, String>() {
            {
                put("mbox_parameter_key1", "mbox_parameter_value1");
            }
        });
        put("profileParameters", new HashMap<String, String>() {
            {
                put("subscription", "premium");
            }
        });
        put("order", new HashMap<String, Object>() {
            {
                put("id", "id1");
                put("total", 100.34);
                put("purchasedProductIds", new ArrayList<String>() {
                    {
                        add("pId1");
                    }
                });
            }
        });
        put("product", new HashMap<String, String>() {
            {
                put("id", "pId1");
                put("categoryId", "cId1");
            }
        });
    }
};

final Map<String, Object> executeMbox2 = new HashMap<String, Object>() {
    {
        put("index", 1);
        put("name", "mbox2");
        put("parameters", new HashMap<String, String>() {
            {
                put("mbox_parameter_key2", "mbox_parameter_value2");
            }
        });
    }
};

final List<Map<String, Object>> executeMboxes = new ArrayList<>();
executeMboxes.add(executeMbox1);
executeMboxes.add(executeMbox2);

final Map<String, Object> request = new HashMap<String, Object>() {
    {
        put("execute", new HashMap<String, Object>() {
            {
                put("mboxes", executeMboxes);
            }
        });
    }
};

Target.executeRawRequest(request, response -> {
    System.out.println("Received Target raw response.");

    if (response == null) {
        System.out.println("Null Target response!");
        return;
    }

    // handle response
});
Copied to your clipboard
final Map<String, Object> executeMbox1 = new HashMap<String, Object>() {
    {
        put("index", 0);
        put("name", "mbox1");
        put("parameters", new HashMap<String, String>() {
            {
                put("mbox_parameter_key1", "mbox_parameter_value1");
            }
        });
        put("profileParameters", new HashMap<String, String>() {
            {
                put("subscription", "premium");
            }
        });
        put("order", new HashMap<String, Object>() {
            {
                put("id", "id1");
                put("total", 100.34);
                put("purchasedProductIds", new ArrayList<String>() {
                    {
                        add("pId1");
                    }
                });
            }
        });
        put("product", new HashMap<String, String>() {
            {
                put("id", "pId1");
                put("categoryId", "cId1");
            }
        });
    }
};

final Map<String, Object> executeMbox2 = new HashMap<String, Object>() {
    {
        put("index", 1);
        put("name", "mbox2");
        put("parameters", new HashMap<String, String>() {
            {
                put("mbox_parameter_key2", "mbox_parameter_value2");
            }
        });
    }
};

final List<Map<String, Object>> executeMboxes = new ArrayList<>();
executeMboxes.add(executeMbox1);
executeMboxes.add(executeMbox2);

final Map<String, Object> request = new HashMap<String, Object>() {
    {
        put("execute", new HashMap<String, Object>() {
            {
                put("mboxes", executeMboxes);
            }
        });
    }
};

Target.executeRawRequest(request, response -> {
    System.out.println("Received Target raw response.");

    if (response == null) {
        System.out.println("Null Target response!");
        return;
    }

    // handle response
});

iOS

Swift

Syntax

static func executeRawRequest(_ request: [[String: Any]], _ completion: @escaping ([[String: Any]]?, Error?) -> Void)
Copied to your clipboard
static func executeRawRequest(_ request: [[String: Any]], _ completion: @escaping ([[String: Any]]?, Error?) -> Void)

request: A dictionary containing prefetch or execute request data in the Target v1 delivery API request format.
completion: A callback which will be invoked with the Target response data or error message after the request is completed.

Example

let request: [String: Any] = [ 
    "execute": [ 
        "mboxes": [ 
            [
                "index": 0, 
                "name": "mbox1", 
                "parameters": [ 
                    "mbox_parameter_key1": "mbox_parameter_value1" 
                ], 
                "profileParameters": [ 
                    "subscription": "premium" 
                ], 
                "order": [ 
                    "id": "id1", 
                    "total": 100.34, 
                    "purchasedProductIds":[ 
                        "pId1"
                    ] 
                ], 
                "product": [ 
                    "id": "pId1", 
                    "categoryId": "cId1" 
                ]
            ], 
            [
                "index": 1, 
                "name": "mbox2", 
                "parameters": [ 
                    "mbox_parameter_key2": "mbox_parameter_value2" 
                ]
            ]
        ]
    ]
] 

Target.executeRawRequest(request) { responseData, error in 
    if error != nil { 
        return 
    } 
    guard let responseData = responseData, 
          !responseData.isEmpty else { 
        return 
    } 

    // handle the response   

} 
Copied to your clipboard
let request: [String: Any] = [ 
    "execute": [ 
        "mboxes": [ 
            [
                "index": 0, 
                "name": "mbox1", 
                "parameters": [ 
                    "mbox_parameter_key1": "mbox_parameter_value1" 
                ], 
                "profileParameters": [ 
                    "subscription": "premium" 
                ], 
                "order": [ 
                    "id": "id1", 
                    "total": 100.34, 
                    "purchasedProductIds":[ 
                        "pId1"
                    ] 
                ], 
                "product": [ 
                    "id": "pId1", 
                    "categoryId": "cId1" 
                ]
            ], 
            [
                "index": 1, 
                "name": "mbox2", 
                "parameters": [ 
                    "mbox_parameter_key2": "mbox_parameter_value2" 
                ]
            ]
        ]
    ]
] 

Target.executeRawRequest(request) { responseData, error in 
    if error != nil { 
        return 
    } 
    guard let responseData = responseData, 
          !responseData.isEmpty else { 
        return 
    } 

    // handle the response   

}

Objective-C

Syntax

+ (void)executeRawRequest:(nonnull NSDictionary<NSString *, id> *)request completion:(void (nonnull ^)(nullable NSDictionary<NSString *, id> *, nullable NSError *))completion
Copied to your clipboard
+ (void)executeRawRequest:(nonnull NSDictionary<NSString *, id> *)request completion:(void (nonnull ^)(nullable NSDictionary<NSString *, id> *, nullable NSError *))completion

request: A dictionary containing prefetch or execute request data in the Target v1 delivery API request format.
completion: A callback which will be invoked with the Target response data or error message after the request is completed.

Example

NSDictionary *request = @{ 
    @"execute": @{ 
        @"mboxes": @[ 
            @{ 
                @"index": @(0), 
                @"name": @"mbox1", 
                @"parameters": @{ 
                    @"mbox_parameter_key1": @"mbox_parameter_value1" 
                }, 
                @"profileParameters": @{ 
                    @"subscription": @"premium" 
                }, 
                @"order": @{ 
                    @"id": @"id1", 
                    @"total": @(100.34), 
                    @"purchasedProductIds": @[ 
                        @"pId1" 
                    ]
                }, 
                @"product": @{ 
                    @"id": @"pId1", 
                    @"categoryId": @"cId1" 
                } 
            }, 
            @{ 
                @"index": @(1), 
                @"name": @"mbox2", 
                @"parameters": @{ 
                    @"mbox_parameter_key2": @"mbox_parameter_value2" 
                } 
            } 
        ] 
    } 
}; 

[AEPMobileTarget executeRawRequest:request completion:^(NSDictionary<NSString *,id> * _Nullable data, NSError * _Nullable err) { 
    if (err != nil) { 
        NSLog(@"Error: %@", err); 
        return; 
    } 

    NSLog(@"Target raw response >> %@", data); 

    // handle response 
}]; 
Copied to your clipboard
NSDictionary *request = @{ 
    @"execute": @{ 
        @"mboxes": @[ 
            @{ 
                @"index": @(0), 
                @"name": @"mbox1", 
                @"parameters": @{ 
                    @"mbox_parameter_key1": @"mbox_parameter_value1" 
                }, 
                @"profileParameters": @{ 
                    @"subscription": @"premium" 
                }, 
                @"order": @{ 
                    @"id": @"id1", 
                    @"total": @(100.34), 
                    @"purchasedProductIds": @[ 
                        @"pId1" 
                    ]
                }, 
                @"product": @{ 
                    @"id": @"pId1", 
                    @"categoryId": @"cId1" 
                } 
            }, 
            @{ 
                @"index": @(1), 
                @"name": @"mbox2", 
                @"parameters": @{ 
                    @"mbox_parameter_key2": @"mbox_parameter_value2" 
                } 
            } 
        ] 
    } 
}; 

[AEPMobileTarget executeRawRequest:request completion:^(NSDictionary<NSString *,id> * _Nullable data, NSError * _Nullable err) { 
    if (err != nil) { 
        NSLog(@"Error: %@", err); 
        return; 
    } 

    NSLog(@"Target raw response >> %@", data); 

    // handle response 
}];

Java

Syntax

public static void executeRawRequest(final Map<String, Object> request, final AdobeCallback<Map<String, Object>> callback)
Copied to your clipboard
public static void executeRawRequest(final Map<String, Object> request, final AdobeCallback<Map<String, Object>> callback)

request: A map containing prefetch or execute request data in the Target v1 delivery API request format.
callback: An AdobeCallback instance which will be called after the Target request is completed. The parameter in the callback will contain the response data if the request executed successfully, or it will contain null otherwise.

Example

final Map<String, Object> executeMbox1 = new HashMap<String, Object>() {
    {
        put("index", 0);
        put("name", "mbox1");
        put("parameters", new HashMap<String, String>() {
            {
                put("mbox_parameter_key1", "mbox_parameter_value1");
            }
        });
        put("profileParameters", new HashMap<String, String>() {
            {
                put("subscription", "premium");
            }
        });
        put("order", new HashMap<String, Object>() {
            {
                put("id", "id1");
                put("total", 100.34);
                put("purchasedProductIds", new ArrayList<String>() {
                    {
                        add("pId1");
                    }
                });
            }
        });
        put("product", new HashMap<String, String>() {
            {
                put("id", "pId1");
                put("categoryId", "cId1");
            }
        });
    }
};

final Map<String, Object> executeMbox2 = new HashMap<String, Object>() {
    {
        put("index", 1);
        put("name", "mbox2");
        put("parameters", new HashMap<String, String>() {
            {
                put("mbox_parameter_key2", "mbox_parameter_value2");
            }
        });
    }
};

final List<Map<String, Object>> executeMboxes = new ArrayList<>();
executeMboxes.add(executeMbox1);
executeMboxes.add(executeMbox2);

final Map<String, Object> request = new HashMap<String, Object>() {
    {
        put("execute", new HashMap<String, Object>() {
            {
                put("mboxes", executeMboxes);
            }
        });
    }
};

Target.executeRawRequest(request, response -> {
    System.out.println("Received Target raw response.");

    if (response == null) {
        System.out.println("Null Target response!");
        return;
    }

    // handle response
});
Copied to your clipboard
final Map<String, Object> executeMbox1 = new HashMap<String, Object>() {
    {
        put("index", 0);
        put("name", "mbox1");
        put("parameters", new HashMap<String, String>() {
            {
                put("mbox_parameter_key1", "mbox_parameter_value1");
            }
        });
        put("profileParameters", new HashMap<String, String>() {
            {
                put("subscription", "premium");
            }
        });
        put("order", new HashMap<String, Object>() {
            {
                put("id", "id1");
                put("total", 100.34);
                put("purchasedProductIds", new ArrayList<String>() {
                    {
                        add("pId1");
                    }
                });
            }
        });
        put("product", new HashMap<String, String>() {
            {
                put("id", "pId1");
                put("categoryId", "cId1");
            }
        });
    }
};

final Map<String, Object> executeMbox2 = new HashMap<String, Object>() {
    {
        put("index", 1);
        put("name", "mbox2");
        put("parameters", new HashMap<String, String>() {
            {
                put("mbox_parameter_key2", "mbox_parameter_value2");
            }
        });
    }
};

final List<Map<String, Object>> executeMboxes = new ArrayList<>();
executeMboxes.add(executeMbox1);
executeMboxes.add(executeMbox2);

final Map<String, Object> request = new HashMap<String, Object>() {
    {
        put("execute", new HashMap<String, Object>() {
            {
                put("mboxes", executeMboxes);
            }
        });
    }
};

Target.executeRawRequest(request, response -> {
    System.out.println("Received Target raw response.");

    if (response == null) {
        System.out.println("Null Target response!");
        return;
    }

    // handle response
});

Swift

Syntax

static func executeRawRequest(_ request: [[String: Any]], _ completion: @escaping ([[String: Any]]?, Error?) -> Void)
Copied to your clipboard
static func executeRawRequest(_ request: [[String: Any]], _ completion: @escaping ([[String: Any]]?, Error?) -> Void)

request: A dictionary containing prefetch or execute request data in the Target v1 delivery API request format.
completion: A callback which will be invoked with the Target response data or error message after the request is completed.

Example

let request: [String: Any] = [ 
    "execute": [ 
        "mboxes": [ 
            [
                "index": 0, 
                "name": "mbox1", 
                "parameters": [ 
                    "mbox_parameter_key1": "mbox_parameter_value1" 
                ], 
                "profileParameters": [ 
                    "subscription": "premium" 
                ], 
                "order": [ 
                    "id": "id1", 
                    "total": 100.34, 
                    "purchasedProductIds":[ 
                        "pId1"
                    ] 
                ], 
                "product": [ 
                    "id": "pId1", 
                    "categoryId": "cId1" 
                ]
            ], 
            [
                "index": 1, 
                "name": "mbox2", 
                "parameters": [ 
                    "mbox_parameter_key2": "mbox_parameter_value2" 
                ]
            ]
        ]
    ]
] 

Target.executeRawRequest(request) { responseData, error in 
    if error != nil { 
        return 
    } 
    guard let responseData = responseData, 
          !responseData.isEmpty else { 
        return 
    } 

    // handle the response   

} 
Copied to your clipboard
let request: [String: Any] = [ 
    "execute": [ 
        "mboxes": [ 
            [
                "index": 0, 
                "name": "mbox1", 
                "parameters": [ 
                    "mbox_parameter_key1": "mbox_parameter_value1" 
                ], 
                "profileParameters": [ 
                    "subscription": "premium" 
                ], 
                "order": [ 
                    "id": "id1", 
                    "total": 100.34, 
                    "purchasedProductIds":[ 
                        "pId1"
                    ] 
                ], 
                "product": [ 
                    "id": "pId1", 
                    "categoryId": "cId1" 
                ]
            ], 
            [
                "index": 1, 
                "name": "mbox2", 
                "parameters": [ 
                    "mbox_parameter_key2": "mbox_parameter_value2" 
                ]
            ]
        ]
    ]
] 

Target.executeRawRequest(request) { responseData, error in 
    if error != nil { 
        return 
    } 
    guard let responseData = responseData, 
          !responseData.isEmpty else { 
        return 
    } 

    // handle the response   

}

Objective-C

Syntax

+ (void)executeRawRequest:(nonnull NSDictionary<NSString *, id> *)request completion:(void (nonnull ^)(nullable NSDictionary<NSString *, id> *, nullable NSError *))completion
Copied to your clipboard
+ (void)executeRawRequest:(nonnull NSDictionary<NSString *, id> *)request completion:(void (nonnull ^)(nullable NSDictionary<NSString *, id> *, nullable NSError *))completion

request: A dictionary containing prefetch or execute request data in the Target v1 delivery API request format.
completion: A callback which will be invoked with the Target response data or error message after the request is completed.

Example

NSDictionary *request = @{ 
    @"execute": @{ 
        @"mboxes": @[ 
            @{ 
                @"index": @(0), 
                @"name": @"mbox1", 
                @"parameters": @{ 
                    @"mbox_parameter_key1": @"mbox_parameter_value1" 
                }, 
                @"profileParameters": @{ 
                    @"subscription": @"premium" 
                }, 
                @"order": @{ 
                    @"id": @"id1", 
                    @"total": @(100.34), 
                    @"purchasedProductIds": @[ 
                        @"pId1" 
                    ]
                }, 
                @"product": @{ 
                    @"id": @"pId1", 
                    @"categoryId": @"cId1" 
                } 
            }, 
            @{ 
                @"index": @(1), 
                @"name": @"mbox2", 
                @"parameters": @{ 
                    @"mbox_parameter_key2": @"mbox_parameter_value2" 
                } 
            } 
        ] 
    } 
}; 

[AEPMobileTarget executeRawRequest:request completion:^(NSDictionary<NSString *,id> * _Nullable data, NSError * _Nullable err) { 
    if (err != nil) { 
        NSLog(@"Error: %@", err); 
        return; 
    } 

    NSLog(@"Target raw response >> %@", data); 

    // handle response 
}]; 
Copied to your clipboard
NSDictionary *request = @{ 
    @"execute": @{ 
        @"mboxes": @[ 
            @{ 
                @"index": @(0), 
                @"name": @"mbox1", 
                @"parameters": @{ 
                    @"mbox_parameter_key1": @"mbox_parameter_value1" 
                }, 
                @"profileParameters": @{ 
                    @"subscription": @"premium" 
                }, 
                @"order": @{ 
                    @"id": @"id1", 
                    @"total": @(100.34), 
                    @"purchasedProductIds": @[ 
                        @"pId1" 
                    ]
                }, 
                @"product": @{ 
                    @"id": @"pId1", 
                    @"categoryId": @"cId1" 
                } 
            }, 
            @{ 
                @"index": @(1), 
                @"name": @"mbox2", 
                @"parameters": @{ 
                    @"mbox_parameter_key2": @"mbox_parameter_value2" 
                } 
            } 
        ] 
    } 
}; 

[AEPMobileTarget executeRawRequest:request completion:^(NSDictionary<NSString *,id> * _Nullable data, NSError * _Nullable err) { 
    if (err != nil) { 
        NSLog(@"Error: %@", err); 
        return; 
    } 

    NSLog(@"Target raw response >> %@", data); 

    // handle response 
}];

sendRawNotifications

This API sends notification request(s) to the configured Target server for click or display notifications. The event tokens required for the Target click or display notifications can be retrieved from a previous executeRawRequest API response.

Android

Java

Syntax

public static void sendRawNotifications(final Map<String, Object> request)
Copied to your clipboard
public static void sendRawNotifications(final Map<String, Object> request)

request: A map containing notifications data in the Target v1 delivery API request format.

Example

final List<Map<String, Object>> notifications = new ArrayList<>();
final Map<String, Object> notification = new HashMap<String, Object>() {
    {
        put("id", "0");
        put("timestamp", (long)(System.currentTimeMillis()));
        put("type", "click");
        put("mbox", new HashMap<String, Object>() {
            {
                put("name", "mbox1");
            }
        });
        put("tokens", new ArrayList<String>() {
            {
                add("someClickToken");
            }
        });
        put("parameters", new HashMap<String, Object>() {
            {
                put("mbox_parameter_key3", "mbox_parameter_value3");
            }
        });
    }
};
notifications.add(notification);
final Map<String, Object> request = new HashMap<>();
request.put("notifications", notifications);
Target.sendRawNotifications(request);
Copied to your clipboard
final List<Map<String, Object>> notifications = new ArrayList<>();
final Map<String, Object> notification = new HashMap<String, Object>() {
    {
        put("id", "0");
        put("timestamp", (long)(System.currentTimeMillis()));
        put("type", "click");
        put("mbox", new HashMap<String, Object>() {
            {
                put("name", "mbox1");
            }
        });
        put("tokens", new ArrayList<String>() {
            {
                add("someClickToken");
            }
        });
        put("parameters", new HashMap<String, Object>() {
            {
                put("mbox_parameter_key3", "mbox_parameter_value3");
            }
        });
    }
};
notifications.add(notification);
final Map<String, Object> request = new HashMap<>();
request.put("notifications", notifications);
Target.sendRawNotifications(request);

iOS

Swift

Syntax

static func sendRawNotifications(_ request: [String: Any]) 
Copied to your clipboard
static func sendRawNotifications(_ request: [String: Any])

request: A dictionary containing notifications data in the Target v1 delivery API request format.

Example

var notifications: [[String: Any]] = [] 

let notification: [String: Any] = [
    "id": "0", 
    "timestamp": Int64(Date().timeIntervalSince1970 * 1000.0), 
    "type": "click", 
    "mbox": [ 
        "name": "mbox1" 
    ], 
    "tokens": [ 
        "someClickToken" 
    ], 
    "parameters": [ 
        "mbox_parameter_key3": "mbox_parameter_value3" 
    ] 

] 
notifications.append(notification) 

Target.sendRawNotifications([ 
    "notifications": notifications 
]) 
Copied to your clipboard
var notifications: [[String: Any]] = [] 

let notification: [String: Any] = [
    "id": "0", 
    "timestamp": Int64(Date().timeIntervalSince1970 * 1000.0), 
    "type": "click", 
    "mbox": [ 
        "name": "mbox1" 
    ], 
    "tokens": [ 
        "someClickToken" 
    ], 
    "parameters": [ 
        "mbox_parameter_key3": "mbox_parameter_value3" 
    ] 

] 
notifications.append(notification) 

Target.sendRawNotifications([ 
    "notifications": notifications 
])

Objective-C

Syntax

+ (void)sendRawNotifications:(nonnull NSDictionary<NSString *, id> *)request
Copied to your clipboard
+ (void)sendRawNotifications:(nonnull NSDictionary<NSString *, id> *)request

request: A dictionary containing notifications data in the Target v1 delivery API request format.

Example

NSMutableArray *notifications = [[NSMutableArray alloc] init]; 

NSDictionary* notification = @{ 

    @"id": @"0", 
    @"timestamp": @((long)([[NSDate date] timeIntervalSince1970] * 1000.0)), 
    @"type": @"click", 
    @"mbox": @{ 
        @"name": @"mbox1", 
    }, 
    @"tokens": @[ @"someClickToken" ], 
    @"parameters": @{ 
        @"mbox_parameter_key3": @"mbox_parameter_value3" 
    } 

}; 
[notifications addObject:notification]; 

NSDictionary *request = @{ 
    @"notifications": notifications 
}; 
[AEPMobileTarget sendRawNotifications:request];  
Copied to your clipboard
NSMutableArray *notifications = [[NSMutableArray alloc] init]; 

NSDictionary* notification = @{ 

    @"id": @"0", 
    @"timestamp": @((long)([[NSDate date] timeIntervalSince1970] * 1000.0)), 
    @"type": @"click", 
    @"mbox": @{ 
        @"name": @"mbox1", 
    }, 
    @"tokens": @[ @"someClickToken" ], 
    @"parameters": @{ 
        @"mbox_parameter_key3": @"mbox_parameter_value3" 
    } 

}; 
[notifications addObject:notification]; 

NSDictionary *request = @{ 
    @"notifications": notifications 
}; 
[AEPMobileTarget sendRawNotifications:request];

Java

Syntax

public static void sendRawNotifications(final Map<String, Object> request)
Copied to your clipboard
public static void sendRawNotifications(final Map<String, Object> request)

request: A map containing notifications data in the Target v1 delivery API request format.

Example

final List<Map<String, Object>> notifications = new ArrayList<>();
final Map<String, Object> notification = new HashMap<String, Object>() {
    {
        put("id", "0");
        put("timestamp", (long)(System.currentTimeMillis()));
        put("type", "click");
        put("mbox", new HashMap<String, Object>() {
            {
                put("name", "mbox1");
            }
        });
        put("tokens", new ArrayList<String>() {
            {
                add("someClickToken");
            }
        });
        put("parameters", new HashMap<String, Object>() {
            {
                put("mbox_parameter_key3", "mbox_parameter_value3");
            }
        });
    }
};
notifications.add(notification);
final Map<String, Object> request = new HashMap<>();
request.put("notifications", notifications);
Target.sendRawNotifications(request);
Copied to your clipboard
final List<Map<String, Object>> notifications = new ArrayList<>();
final Map<String, Object> notification = new HashMap<String, Object>() {
    {
        put("id", "0");
        put("timestamp", (long)(System.currentTimeMillis()));
        put("type", "click");
        put("mbox", new HashMap<String, Object>() {
            {
                put("name", "mbox1");
            }
        });
        put("tokens", new ArrayList<String>() {
            {
                add("someClickToken");
            }
        });
        put("parameters", new HashMap<String, Object>() {
            {
                put("mbox_parameter_key3", "mbox_parameter_value3");
            }
        });
    }
};
notifications.add(notification);
final Map<String, Object> request = new HashMap<>();
request.put("notifications", notifications);
Target.sendRawNotifications(request);

Swift

Syntax

static func sendRawNotifications(_ request: [String: Any]) 
Copied to your clipboard
static func sendRawNotifications(_ request: [String: Any])

request: A dictionary containing notifications data in the Target v1 delivery API request format.

Example

var notifications: [[String: Any]] = [] 

let notification: [String: Any] = [
    "id": "0", 
    "timestamp": Int64(Date().timeIntervalSince1970 * 1000.0), 
    "type": "click", 
    "mbox": [ 
        "name": "mbox1" 
    ], 
    "tokens": [ 
        "someClickToken" 
    ], 
    "parameters": [ 
        "mbox_parameter_key3": "mbox_parameter_value3" 
    ] 

] 
notifications.append(notification) 

Target.sendRawNotifications([ 
    "notifications": notifications 
]) 
Copied to your clipboard
var notifications: [[String: Any]] = [] 

let notification: [String: Any] = [
    "id": "0", 
    "timestamp": Int64(Date().timeIntervalSince1970 * 1000.0), 
    "type": "click", 
    "mbox": [ 
        "name": "mbox1" 
    ], 
    "tokens": [ 
        "someClickToken" 
    ], 
    "parameters": [ 
        "mbox_parameter_key3": "mbox_parameter_value3" 
    ] 

] 
notifications.append(notification) 

Target.sendRawNotifications([ 
    "notifications": notifications 
])

Objective-C

Syntax

+ (void)sendRawNotifications:(nonnull NSDictionary<NSString *, id> *)request
Copied to your clipboard
+ (void)sendRawNotifications:(nonnull NSDictionary<NSString *, id> *)request

request: A dictionary containing notifications data in the Target v1 delivery API request format.

Example

NSMutableArray *notifications = [[NSMutableArray alloc] init]; 

NSDictionary* notification = @{ 

    @"id": @"0", 
    @"timestamp": @((long)([[NSDate date] timeIntervalSince1970] * 1000.0)), 
    @"type": @"click", 
    @"mbox": @{ 
        @"name": @"mbox1", 
    }, 
    @"tokens": @[ @"someClickToken" ], 
    @"parameters": @{ 
        @"mbox_parameter_key3": @"mbox_parameter_value3" 
    } 

}; 
[notifications addObject:notification]; 

NSDictionary *request = @{ 
    @"notifications": notifications 
}; 
[AEPMobileTarget sendRawNotifications:request];  
Copied to your clipboard
NSMutableArray *notifications = [[NSMutableArray alloc] init]; 

NSDictionary* notification = @{ 

    @"id": @"0", 
    @"timestamp": @((long)([[NSDate date] timeIntervalSince1970] * 1000.0)), 
    @"type": @"click", 
    @"mbox": @{ 
        @"name": @"mbox1", 
    }, 
    @"tokens": @[ @"someClickToken" ], 
    @"parameters": @{ 
        @"mbox_parameter_key3": @"mbox_parameter_value3" 
    } 

}; 
[notifications addObject:notification]; 

NSDictionary *request = @{ 
    @"notifications": notifications 
}; 
[AEPMobileTarget sendRawNotifications:request];

API reference

Event reference

Was this helpful?

Yes

Target Raw API reference

executeRawRequest.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Java.css-jmmyhj{margin-left:var(--spectrum-global-dimension-size-50);}

Swift

Objective-C

Java

Swift

Objective-C

sendRawNotifications

Java

Swift

Objective-C

Java

Swift

Objective-C

executeRawRequest

Java