Sociomantic

You can integrate the Adjust SDK with Sociomantic events.

Set up your environment

CocoaPods
Carthage

Add the following line to your Podfile:

pod 'Adjust/Sociomantic'

Add following line to your Cartfile:

github "adjust/ios_sdk" "sociomantic"

Install from source

You can add the Adjust Sociomantic plugin to your project manually by doing the following:

Locate the plugin/Sociomantic folder inside the archive you downloaded from the release page.
Drag the ADJSociomantic.h and ADJSociomantic.m files into the Adjust folder inside your project.
When the Choose options for adding these files dialog appears, check the Copy items if needed checkbox and select the radio button to Create groups.

Sociomantic events

Once you have installed the Sociomantic plugin, you will have access to the Sociomantic events methods as well as the following constants. You should use these as the property names of your dictionaries.

NSString *const SCMCategory;
NSString *const SCMProductName;
NSString *const SCMSalePrice;
NSString *const SCMProductURL;
NSString *const SCMProductImageURL;
NSString *const SCMBrand;
NSString *const SCMDescription;
NSString *const SCMTimestamp;
NSString *const SCMValidityTimestamp;
NSString *const SCMQuantity;
NSString *const SCMScore;
NSString *const SCMProductID;
NSString *const SCMAmount;
NSString *const SCMCurrency;
NSString *const SCMActionConfirmed;
NSString *const SCMActionConfirmed;
NSString *const SCMCustomerAgeGroup;
NSString *const SCMCustomerEducation;
NSString *const SCMCustomerGender;
NSString *const SCMCustomerID;
NSString *const SCMCustomerMHash;
NSString *const SCMCustomerSegment;
NSString *const SCMCustomerTargeting;

Before sending any Sociomantic events, you should set a partner ID as shown below:

Swift
Objective-C

1
ADJSociomantic.injectPartnerId(intoSociomanticEvents: "{sociomanticPartnerId}")

1
#import "ADJSociomantic.h"
2

3
[ADJSociomantic injectPartnerIdIntoSociomanticEvents:@"{sociomanticPartnerId}"];

Once you have set your partner ID, you can integrate the different Sociomantic events.

Examples

1
let event = ADJEvent(eventToken: ANY_TOKEN)
2
let customerData = [
3
    SCMCustomerID: "123456"
4
]
5

6
ADJSociomantic.injectCustomerData(into: event, withData: customerData)
7
Adjust.trackEvent(event)

1
#import "ADJSociomantic.h"
2

3
ADJEvent *event = [ADJEvent eventWithEventToken:ANY_TOKEN];
4
NSDictionary *customerData = @{
5
    SCMCustomerID: @"123456"
6
};
7

8
[ADJSociomantic injectCustomerDataIntoEvent:event withData:customerData];
9
[Adjust trackEvent:event];

View home page

Swift

1
let event = ADJEvent(eventToken: HOMEPAGE_TOKEN)
2

3
ADJSociomantic.injectHomePage(into: event)
4
Adjust.trackEvent(event)

1
#import "ADJSociomantic.h"
2

3
ADJEvent *event = [ADJEvent eventWithEventToken:HOMEPAGE_TOKEN];
4

5
[ADJSociomantic injectHomePageIntoEvent:event];
6
[Adjust trackEvent:event];

View listing

Swift
Objective-C

1
let event = ADJEvent(eventToken: LISTING_TOKEN)
2
let categories = ["category_1", "category_2", "category_3"]
3
let date = "1427792434"
4

5
ADJSociomantic.injectViewListing(into: event, withCategories: categories)
6
// You also can provide a date like this
7
ADJSociomantic.injectViewListing(into: event, withCategories: categories, withDate: date)
8
Adjust.trackEvent(event)

1
#import "ADJSociomantic.h"
2

3
ADJEvent *event = [ADJEvent eventWithEventToken:LISTING_TOKEN];
4
NSArray *categories = @[@"category_1", @"category_2", @"category_3"];
5
NSString *date = @"1427792434";
6

7
[ADJSociomantic injectViewListingIntoEvent:event withCategories:categories];
8
// You also can provide a date like this
9
[ADJSociomantic injectViewListingIntoEvent:event withCategories:categories withDate:date];
10
[Adjust trackEvent:event];

View product

Swift
Objective-C

1
let event = ADJEvent(eventToken: PRODUCT_VIEW_TOKEN)
2
let params = [
3
    SCMCategory: ["cat1", "cat2"],
4
    SCMProductName: "stuff",
5
    SCMDescription: "pure awesomeness"
6
]
7

8
ADJSociomantic.injectViewProduct(into: event, productId: "productId_4", withParameters: params)
9
Adjust.trackEvent(event)

1
#import "ADJSociomantic.h"
2

3
ADJEvent *event      = [ADJEvent eventWithEventToken:PRODUCT_VIEW_TOKEN];
4
NSDictionary *params = @{
5
    SCMCategory     : @[@"cat1", @"cat2"],
6
    SCMProductName  : @"stuff",
7
    SCMDescription  : @"pure awesomeness"
8
};
9

10
[ADJSociomantic injectViewProductIntoEvent:event productId:@"productId_4" withParameters:params];
11
[Adjust trackEvent:event];

Available product parameters

Parameter name	Requirement	Description	Note
`SCMCategory`	Required	Product category (entire category path)	Category information provided in the tracking code on category or listing pages should match the category information provided in the feed or in the tracking code of product pages.
`SCMProductName`	Required	Product name	Special characters shouldn’t be encoded but provided in proper UTF-8. Don’t use any HTML markup.
`SCMSalePrice`	Required	Sale price as decimal value (For example: 2.99)	Please use a dot as a decimal separator and don’t use any thousand separators.
`SCMAmount`	Required	Regular price as decimal value (For example: 3.99)	Please use a dot as a decimal separator and don’t use any thousand separators.
`SCMCurrency`	Required	Currency code in ISO 4217 format (For example: EUR)	Fixed currency code. Should have been provided to you in the tracking code examples.
`SCMProductURL`	Required	Product URL (deeplink)	Please provide a working deeplink ideally without any click tracking parameter (Google Analytics, HURRA, Eulerian, etc.), Please always use deeplinks with `http://`
`SCMProductImageURL`	Required	Product image URL	Please provide images in a reasonable size. For an optimal appearance in the ads the images should be at least 200x200px and should have the same aspect ratio.
`SCMBrand`	Required	Product brand	Special characters shouldn’t be encoded but provided in proper UTF-8 (Same as SCMProductName above). Don’t use any HTML markup.
`SCMDescription`	Optional	Short product description	Special characters shouldn’t be encoded but provided in proper UTF-8 (Same as SCMProductName above). Don’t use any HTML markup.
`SCMTimestamp`	Optional	Timestamp until when the product is available (please use GMT time)	Please provide the date a visitor has searched for. It should be an NSTimeInterval wrapped in NSNumber (see example).
`SCMValidityTimestamp`	Optional	Timestamp until when the product is available (please use GMT time)	Please provide the unix timestamp until when the product is available. Please use 0 for products that are always available. It should be an NSTimeInterval wrapped in NSNumber (Same as SCMTimestamp above).
`SCMQuantity`	Optional	Number of products in stock	Please integrate this field only after discussion with your personal Sociomantic contact
`SCMScore`	Optional	Priority score of the product (value range is between 0 to 10.0)	Please integrate this field only after discussion with your personal Sociomantic contact

Cart

Swift
Objective-C

1
let event = ADJEvent(eventToken: CART_TOKEN)
2
let product5 = [
3
    SCMAmount: NSNumber(value: 100),
4
    SCMCurrency: "EUR",
5
    SCMQuantity: NSNumber(value: 1),
6
    SCMProductID: "productId_5"
7
]
8
let product6 = "productId_6"
9
let product7 = [
10
    SCMProductID: "productId_7"
11
]
12

13

14
let productList = [product5, product6, product7]
15

16
ADJSociomantic.injectCart(into: event, cart: productList)
17
Adjust.trackEvent(event)

1
#import "ADJSociomantic.h"
2

3
ADJEvent *event = [ADJEvent eventWithEventToken:CART_TOKEN];
4
NSDictionary *product5 = @{
5
    SCMAmount    : @100,
6
    SCMCurrency  : @"EUR",
7
    SCMQuantity  : @1,
8
    SCMProductID : @"productId_5",
9
};
10
NSString *product6 = @"productId_6";
11
NSDictionary *product7 = @{
12
    SCMProductID : @"productId_7"
13
};
14

15
NSArray * productList = @[product5, product6, product7];
16

17
[ADJSociomantic injectCartIntoEvent:event cart:productList];
18
[Adjust trackEvent:event];

Available cart parameters

Parameter name	Requirement	Description	Note
`SCMProductID`	Required	Product ID	Please provide the product ID without any subIDs for any color or size variations.
`SCMAmount`	Optional	Product price as decimal value (For example: 2.99)	Please use a dot as a decimal separator and don’t use any thousand separators. Please only provide price per product, even if quantity has a value larger than 1.
`SCMCurrency`	Optional	Currency code in ISO 4217 format (For example: EUR)	Fixed currency code. Should have been provided to you in the tracking code examples.
`SCMQuantity`	Optional	Quantity of the product selected	Please use an integer value.

Unconfirmed transaction

Swift
Objective-C

1
let event = ADJEvent(eventToken: TRANSACTION_TOKEN)
2
let product5 = "productId_5"
3
let product6 = [
4
    SCMQuantity: NSNumber(value: 3),
5
    SCMProductID: "productId_6"
6
]
7
let productList = [product5, product6]
8

9
ADJSociomantic.injectTransaction(into: event, transactionId: "123456", withProducts: productList)
10
Adjust.trackEvent(event)

1
#import "ADJSociomantic.h"
2

3
ADJEvent *event = [ADJEvent eventWithEventToken:TRANSACTION_TOKEN];
4
NSString *product5 =  @"productId_5";
5
NSDictionary *product6 = @{
6
    SCMQuantity  : @3,
7
    SCMProductID : @"productId_6"
8
};
9
NSArray * productList = @[product5, product6];
10

11
[ADJSociomantic injectTransactionIntoEvent:event transactionId:@"123456" withProducts:productList];
12
[Adjust trackEvent:event];

Or with parameters:

Swift
Objective-C

1
let event = ADJEvent(eventToken: TRANSACTION_TOKEN)
2
let product5 = "productId_5"
3
let product6 = [
4
    SCMQuantity: NSNumber(value: 3),
5
    SCMProductID: "productId_6"
6
]
7
let productList = [product5, product6]
8
let parameters = [
9
    SCMQuantity: NSNumber(value: 4 /* 3 times product6 and 1 product5 */)
10
]
11

12
ADJSociomantic.injectTransaction(into: event, transactionId: "123456", withProducts: productList, withParameters: parameters)
13
Adjust.trackEvent(event)

1
#import "ADJSociomantic.h"
2

3
ADJEvent *event = [ADJEvent eventWithEventToken:TRANSACTION_TOKEN];
4
NSString *product5 =  @"productId_5";
5
NSDictionary *product6 = @{
6
    SCMQuantity  : @3,
7
    SCMProductID : @"productId_6"
8
};
9
NSArray *productList = @[product5, product6];
10
NSDictionary *parameters = @{
11
    SCMQuantity: @4  // 3 times product6 and 1 product5
12
};
13

14
[ADJSociomantic injectTransactionIntoEvent:event transactionId:@"123456" withProducts:productList withParameters:parameters];
15
[Adjust trackEvent:event];

Confirmed transactions

Swift
Objective-C

1
let event = ADJEvent(eventToken: TRANSACTION_TOKEN)
2
let product5 = "productId_5"
3
let product6 = [
4
    SCMQuantity: NSNumber(value: 3),
5
    SCMProductID: "productId_6"
6
]
7
let productList = [product5, product6]
8

9
ADJSociomantic.injectConfirmedTransaction(into: event, transactionId: "123456", withProducts: productList)
10
Adjust.trackEvent(event)

1
#import "ADJSociomantic.h"
2

3
ADJEvent *event = [ADJEvent eventWithEventToken:TRANSACTION_TOKEN];
4
NSString *product5 =  @"productId_5";
5
NSDictionary *product6 = @{
6
    SCMQuantity  : @3,
7
    SCMProductID : @"productId_6"
8
};
9
NSArray * productList = @[product5, product6];
10

11
[ADJSociomantic injectConfirmedTransactionIntoEvent:event transactionId:@"123456" withProducts:productList];
12
[Adjust trackEvent:event];

Or with parameters:

Swift
Objective-C

1
let event = ADJEvent(eventToken: TRANSACTION_TOKEN)
2
let product5 = "productId_5"
3
let product6 = [
4
    SCMQuantity: NSNumber(value: 3),
5
    SCMProductID: "productId_6"
6
]
7
let productList = [product5, product6]
8
let parameters = [
9
    SCMQuantity: NSNumber(value: 4 /* 3 times product6 and 1 product5 */)
10
]
11

12
ADJSociomantic.injectConfirmedTransaction(into: event, transactionId: "123456", withProducts: productList, withParameters: parameters)
13
Adjust.trackEvent(event)

1
#import "ADJSociomantic.h"
2

3
ADJEvent *event = [ADJEvent eventWithEventToken:TRANSACTION_TOKEN];
4
NSString *product5 =  @"productId_5";
5
NSDictionary *product6 = @{
6
    SCMQuantity  : @3,
7
    SCMProductID : @"productId_6"
8
};
9
NSArray *productList = @[product5, product6];
10
NSDictionary *parameters = @{
11
    SCMQuantity: @4  // 3 times product6 and 1 product5
12
};
13

14
[ADJSociomantic injectConfirmedTransactionIntoEvent:event transactionId:@"123456" withProducts:productList withParameters:parameters];
15
[Adjust trackEvent:event];

Available cart parameters

Parameter name	Requirement	Description	Note
`SCMAmount`	Optional	Product price as decimal value (For example: 2.99)	Please use a dot as a decimal separator and don’t use any thousand separators. Please only provide price per product, even if quantity has a value larger than 1.
`SCMCurrency`	Optional	Currency code in ISO 4217 format (For example: EUR)	Fixed currency code. Should have been provided to you in the tracking code examples.
`SCMQuantity`	Optional	Quantity of the product selected	Please use an integer value.

Lead event

Swift
Objective-C

1
let event = ADJEvent(eventToken: LEAD_TOKEN)
2

3
ADJSociomantic.injectLead(into: event, leadID: "123456789")
4
Adjust.trackEvent(event)

1
#import "ADJSociomantic.h"
2

3
ADJEvent *event = [ADJEvent eventWithEventToken:LEAD_TOKEN];
4

5
[ADJSociomantic injectLeadIntoEvent:event leadID:@"123456789"];
6
[Adjust trackEvent:event];

Or confirmed lead:

Swift
Objective-C

1
let event = ADJEvent(eventToken: LEAD_TOKEN)
2

3
ADJSociomantic.injectLead(into: event, leadID: "123456789", andConfirmed: true)
4
Adjust.trackEvent(event)

1
#import "ADJSociomantic.h"
2

3
ADJEvent *event = [ADJEvent eventWithEventToken:LEAD_TOKEN];
4

5
[ADJSociomantic injectLeadIntoEvent:event leadID:@"123456789" andConfirmed:YES];
6
[Adjust trackEvent:event];