Sociomantic

You can integrate the Adjust SDK with Sociomantic events.

Set up your environment

Maven

If you are using Maven, add the following dependency to your build.gradle file:

dependencies {
   implementation 'com.adjust.sdk:adjust-android:4.38.5'
   implementation 'com.adjust.sdk:adjust-android-criteo:4.38.5'
}

JAR

You can also add the plugin as a JAR file from the releases page.

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.

final static String SCMCategory;
final static String SCMProductName;
final static String SCMSalePrice;
final static String SCMAmount;
final static String SCMCurrency;
final static String SCMProductURL;
final static String SCMProductImageURL;
final static String SCMBrand;
final static String SCMDescription;
final static String SCMTimestamp;
final static String SCMValidityTimestamp;
final static String SCMQuantity;
final static String SCMScore;
final static String SCMProductID;
final static String SCMActionConfirmed;
final static String SCMCustomerAgeGroup;
final static String SCMCustomerEducation;
final static String SCMCustomerGender;
final static String SCMCustomerID;
final static String SCMCustomerMHash;
final static String SCMCustomerSegment;
final static String SCMCustomerTargeting;
final static String SCMTransaction;

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

Java

1
import com.adjust.sdk.plugin.AdjustSociomantic;
2

3
AdjustSociomantic.injectPartnerIdInSociomanticEvents("{sociomanticPartnerId}");

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

Examples

Customer event

Java

1
import com.adjust.sdk.plugin.AdjustSociomantic;
2

3
AdjustEvent event = new AdjustEvent(HOMEPAGE_TOKEN);
4
Map<String, String> customerData = new HashMap<>();
5
customerData.put(AdjustSociomantic.SCMCustomerAgeGroup, "0");
6

7
AdjustSociomantic.injectCustomerDataIntoEvent(event, customerData);
8
Adjust.trackEvent(event);

View home page

Java

1
import com.adjust.sdk.plugin.AdjustSociomantic;
2

3
AdjustEvent event = new AdjustEvent(HOMEPAGE_TOKEN);
4
Adjust.trackEvent(event);

View listing

Java

1
import com.adjust.sdk.plugin.AdjustSociomantic;
2

3
AdjustEvent event = new AdjustEvent(LISTING_TOKEN);
4
List<String> categories = Arrays.asList("cat1", "cat2", "cat3");
5
String date = "1427792434"
6

7
AdjustSociomantic.injectViewListingIntoEvent(event, categories);
8
Adjust.trackEvent(event);
9

10
// You also can provide a date like this.
11
AdjustSociomantic.injectViewListingIntoEvent(event, categories, date);
12
Adjust.trackEvent(event);

View product

Java

1
import com.adjust.sdk.plugin.AdjustSociomantic;
2

3
AdjustEvent event = new AdjustEvent(PRODUCT_VIEW_TOKEN);
4
Map<String, Object> product = new HashMap<>();
5
List<String> categories = Arrays.asList("cat1", "cat2", "cat3");
6
product.put(AdjustSociomantic.SCMCategory, categories);
7

8
AdjustSociomantic.injectProductIntoEvent(event, "123456");
9
Adjust.trackEvent(event);
10

11
// You can also provide product information.
12
AdjustSociomantic.injectProductIntoEvent(event, "123456", product);
13
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

Java

1
import com.adjust.sdk.plugin.AdjustSociomantic;
2

3
AdjustEvent event = new AdjustEvent(BASKET_TOKEN);
4
Map<String, Object> product1 = new HashMap<>();
5
product1.put(AdjustSociomantic.SCMProductID, "1");
6
product1.put(AdjustSociomantic.SCMAmount, 42);
7
product1.put(AdjustSociomantic.SCMCurrency, "EUR");
8
product1.put(AdjustSociomantic.SCMQuantity, 1);
9

10
Map<String, Object> product2 = new HashMap<>();
11
product2.put(AdjustSociomantic.SCMProductID, "2");
12

13
String product3 = "3";
14

15
List<Object> products = Arrays.asList(product1, product2, product3);
16
AdjustSociomantic.injectCartIntoEvent(event, products);
17
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

Java

1
import com.adjust.sdk.plugin.AdjustSociomantic;
2

3
AdjustEvent event = new AdjustEvent(SALE_TOKEN);
4
Map<String, Object> product1 = new HashMap<>();
5
product1.put(AdjustSociomantic.SCMProductID, "1");
6
product1.put(AdjustSociomantic.SCMAmount, 42);
7
product1.put(AdjustSociomantic.SCMQuantity, 1);
8

9
Map<String, Object> product2 = new HashMap<>();
10
product2.put(AdjustSociomantic.SCMProductID, "2");
11

12
String product3 = "3";
13

14
List<Object> products = Arrays.asList(product1, product2, product3);
15
AdjustSociomantic.injectTransactionIntoEvent(event, "123456", products);
16
Adjust.trackEvent(event);

Or with parameters:

Java

1
import com.adjust.sdk.plugin.AdjustSociomantic;
2

3
AdjustEvent event = new AdjustEvent(SALE_TOKEN);
4
Map<String, Object> product1 = new HashMap<>();
5
product1.put(AdjustSociomantic.SCMProductID, "1");
6
product1.put(AdjustSociomantic.SCMAmount, 42);
7
product1.put(AdjustSociomantic.SCMQuantity, 1);
8

9
Map<String, Object> product2 = new HashMap<>();
10
product2.put(AdjustSociomantic.SCMProductID, "2");
11

12
String product3 = "3";
13

14
List<Object> products = Arrays.asList(product1, product2, product3);
15
Map<String, Object> parameters = new HashMap<>();
16
parameters.put(AdjustSociomantic.SCMCurrency, "EUR");
17
parameters.put(AdjustSociomantic.SCMAmount, 42);
18

19
AdjustSociomantic.injectTransactionIntoEvent(event, "123456", products, parameters);
20

21
Adjust.trackEvent(event);

Confirmed transactions

Java

1
import com.adjust.sdk.plugin.AdjustSociomantic;
2

3
AdjustEvent event = new AdjustEvent(SALE_TOKEN);
4
Map<String, Object> product1 = new HashMap<>();
5
product1.put(AdjustSociomantic.SCMProductID, "1");
6
product1.put(AdjustSociomantic.SCMAmount, 42);
7
product1.put(AdjustSociomantic.SCMQuantity, 1);
8

9
Map<String, Object> product2 = new HashMap<>();
10
product2.put(AdjustSociomantic.SCMProductID, "2");
11

12
String product3 = "3";
13

14
List<Object> products = Arrays.asList(product1, product2, product3);
15
AdjustSociomantic.injectConfirmedTransactionIntoEvent(event, "123456", products);
16
Adjust.trackEvent(event);

Or with parameters:

Java

1
import com.adjust.sdk.plugin.AdjustSociomantic;
2

3
AdjustEvent event = new AdjustEvent(SALE_TOKEN);
4
Map<String, Object> product1 = new HashMap<>();
5
product1.put(AdjustSociomantic.SCMProductID, "1");
6
product1.put(AdjustSociomantic.SCMAmount, 42);
7
product1.put(AdjustSociomantic.SCMQuantity, 1);
8

9
Map<String, Object> product2 = new HashMap<>();
10
product2.put(AdjustSociomantic.SCMProductID, "2");
11

12
String product3 = "3";
13

14
List<Object> products = Arrays.asList(product1, product2, product3);
15
Map<String, Object> parameters = new HashMap<>();
16
parameters.put(AdjustSociomantic.SCMCurrency, "EUR");
17
parameters.put(AdjustSociomantic.SCMAmount, 42);
18

19
AdjustSociomantic.injectConfirmedTransactionIntoEvent(event, "123456", products, parameters);
20
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

Java

1
import com.adjust.sdk.plugin.AdjustSociomantic;
2

3
AdjustEvent event = new AdjustEvent(LEAD_TOKEN);
4
AdjustSociomantic.injectLeadIntoEvent(event, "123456");
5
Adjust.trackEvent(event);

Or confirmed lead:

Java

1
import com.adjust.sdk.plugin.AdjustSociomantic;
2

3
AdjustEvent event = new AdjustEvent(LEAD_TOKEN);
4
AdjustSociomantic.injectLeadIntoEvent(event, "123456", Boolean.TRUE);
5
Adjust.trackEvent(event);