This SDK is a helper library for the mParticle Events HTTP API, it exposes mParticle’s schema as simple models and provides an HTTP client interface. This SDK is stateless and will only send the data that you populate, whereas our mobile SDKs will automatically collect app and device information, session events, install events, and maintain persistence. Read this wiki for a general overview and examples, and contact our customer support team to make sure you’re feeding the platform with the right data to power your integrations. You can find the Java SDK hosted on Github.
\nAll data sent via the SDK must be encapsulated in a Batch struct. Each Batch is associated with a single user. Batch objects must be associated with an environment (development or production) to properly silo your testing and production data.
//\"DEVELOPMENT\" or \"PRODUCTION\"\nBatch batch = new Batch();\nbatch.environment(Batch.Environment.DEVELOPMENT);Most use-cases require that data be associated with a user identity, for example:
\nbatch.userIdentities(\n new UserIdentities()\n .customerId(\"1234\")\n .email(\"example@foo.com\")\n);The DeviceInformation object describes the device that should be associated with this batch. Crucially, it exposes properties for device identities (Apple IDFA and Google Advertising ID) which are required for nearly all mParticle Audience integrations.
batch.deviceInfo(\n new DeviceInformation()\n .iosAdvertisingId(\"5864e6b0-0d46-4667-a463-21d9493b6c10\")\n);The mParticle audience platform can be powered by only sending a combination of user attributes, used to describe segments of users, and device identities/user identities used to then target those users.
\nMap<String, Object> userAttributes = new HashMap<>();\nuserAttributes.put(\"foo\", \"bar\");\nuserAttributes.put(\"foo-array\", new String[]{\"bar1\", \"bar2\"});\nuserAttributes.put(\"foo-array-2\", Arrays.asList(\"bar3\",\"bar4\"));\nbatch.userAttributes(userAttributes);Events are central to many of mParticle’s integrations; analytics integrations typically require events, and you can create mParticle Audiences based on the recency and frequency of different events. All events should be associated with a timestamp reflecting when they actually occurred, otherwise they will be assigned a timestamp when mParticle receives them.
\nCustom Events represent specific actions that a user has taken in your app. At minimum they require a name and a type, but can also be associate with a free-form dictionary of key/value pairs.
\nMap customAttributes = new HashMap<>();\ncustomAttributes.put(\"foo\", \"bar\");\nCustomEvent event = new CustomEvent().data(\n new CustomEventData()\n .eventName(\"My Custom Event Name\")\n .customEventType(CustomEventData.CustomEventType.LOCATION)\n);\nevent.getData().customAttributes(customAttributes);The Commerce event is central to mParticle’s Commerce measurement. Commerce events can contain many data points but it’s important to understand that there are 3 core variations:
\nProduct product = new Product()\n .totalProductAmount(new BigDecimal(\"123.12\"))\n .id(\"product-id\")\n .name(\"product-name\");\nProductAction action = new ProductAction()\n .action(ProductAction.Action.PURCHASE)\n .totalAmount(new BigDecimal(\"123.12\"))\n .transactionId(\"foo-transaction-id\")\n .products(Arrays.asList(product));\nCommerceEvent event = new CommerceEvent().data(\n new CommerceEventData().productAction(action)\n);The SDK provides an interface to the mParticle HTTP API by way of the EventsApi class.
\nAt a minimum, the EventsApi must be initialized using the mParticle key and secret issued for your input.
To find your key and secret if you are using a platform input such as iOS or Roku:
\nTo find your key and secret if you are using a custom feed as your data source:
\n\n\nYou must associate your data with the correct key and secret. If your app is multi-platform, for example, be sure to send your Android data to your Android key/secret, and your iOS data to your iOS key/secret.
\n
By default, the Java SDK will upload to the US1 Data Center URL. If the API key you’re sending to exists in an mParticle Data Center that’s not US1, you must find the right URL for your hosting location on the mParticle docs site. Using this URL, you can override the base url.
\nApiClient apiClient = new ApiClient(\"YOUR_API_KEY\", \"YOUR_API_SECRET\");\n// include this if your API keys are from a non-US1 mParticle data center, by default the Java SDK sends to US1\napiClient.getAdapterBuilder().baseUrl(\"https://s2s.eu1.mparticle.com/v2/\");\n\n// configure API\nEventsApi api = apiClient\n .createService(EventsApi.class);\n\n// assemble an event batch\nBatch batch = new Batch();\nbatch.environment(Batch.Environment.DEVELOPMENT);\nbatch.userIdentities(new UserIdentities()\n .customerId(\"1234\")\n .email(\"example@foo.com\")\n);\n\n// Set a Data Plan\nContext context = new Context();\nDataPlanContext dpContext = new DataPlanContext();\ndpContext.planId(\"mobile_data_plan\");\ndpContext.planVersion(2);\ncontext.dataPlan(dpContext);\nbatch.context(context);\n\n// create an event\nCustomEvent customEvent = new CustomEvent().data(\n new CustomEventData()\n .eventName(\"Example Event\")\n);\n\n// create attributes\nMap customAttributes = new HashMap<>();\ncustomAttributes.put(\"example attribute\", \"foo\");\n\n// add them to an event\ncustomEvent.getData().customAttributes(customAttributes);\nbatch.addEventsItem(customEvent);\n\n// upload\nCall<Void> singleResult = api.uploadEvents(batch);\nResponse<Void> singleResponse = singleResult.execute();\nSystem.out.println(\"Returned code: \" + singleResponse.code());