The Python SDK is a helper library for the mParticle Events HTTP API that exposes the mParticle schema as simple models and provides an HTTP client interface. This SDK is stateless and only sends the data that you populate, whereas our mobile SDKs automatically collect app and device information, session events, install events, and maintain persistence.
\nThough the SDK may work on earlier versions of Python, we officially support Python version 3.5 or higher.
\nRead this page for a general overview and examples, visit the Python SDK repo), and if needed, contact our customer support team to make sure you’re feeding the platform with the right data to power your integrations.
\nAll data sent via the SDK must be encapsulated in a Batch object. Each Batch is associated with a single user. Batch objects must be associated with an environment (production or development) to properly silo your testing and production data.
import mparticle\nbatch = mparticle.Batch()\nbatch.environment = 'development'Most use-cases require that data be associated with a user identity, for example:
\nidentities = mparticle.UserIdentities()\nidentities.customerid = '123456'\nidentities.email = 'user@example.com'\nbatch.user_identities = identitiesThe DeviceInformation object describes a mobile 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.
device_info = mparticle.DeviceInformation()\n# set any IDs that you have for this user\ndevice_info.ios_advertising_id = '07d2ebaa-e956-407e-a1e6-f05f871bf4e2'\ndevice_info.android_advertising_id = 'a26f9736-c262-47ea-988b-0b0504cee874'\nbatch.device_info = device_infoThe 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.
\n# arbitrary example allowing you to create a segment of users trial users\nbatch.user_attributes = {'Account type': 'trial', 'TrialEndDate':'2016-12-01'}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.
\nApp 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.
\napp_event = mparticle.AppEvent('Example', 'navigation', custom_attributes={'foo':'bar'})\napp_event.timestamp_unixtime_ms = example_timestamp\nbatch.events = [app_event]The CommerceEvent is central to mParticle’s eCommerce measurement. CommerceEvents can contain many data points but it’s important to understand that there are 3 core variations:
\nCustom attributes can be added to both products and commerce events using the custom_attributes property, which accepts a dictionary of key/value pairs of strings.
product = mparticle.Product()\nproduct.name = 'Example Product'\nproduct.id = 'sample-sku'\nproduct.price = 19.99\nproduct.custom_attributes = {'color': 'red', 'size': 'small'} # optional dictionary containing custom attributes for the product\n\nproduct_action = mparticle.ProductAction('purchase')\nproduct_action.products = [product]\nproduct_action.tax_amount = 1.50\nproduct_action.total_amount = 21.49\n\ncommerce_event = mparticle.CommerceEvent(product_action)\ncommerce_event.timestamp_unixtime_ms = example_timestamp\ncommerce_event.custom_attributes = {'sale': 'true'} # optional dictionary containing custom attributes for the commerce event\n\nbatch.events = [commerce_event]The SessionStartEvent and SessionEndEvent should be used to describe the details of user session such as its length, which is a common metric used in many mParticle integrations. Additonally, length, recency, and frequency of sessions are powerful data-points by which an mParticle audience can be defined.
\nsession_start = mparticle.SessionStartEvent()\nsession_start.session_id = 12345678\nsession_start.timestamp_unixtime_ms = example_timestamp\n\nsession_end = mparticle.SessionEndEvent()\nsession_end.session_id = session_start.session_id # its mandatory that these match\nsession_end.session_duration_ms = example_duration\nsession_end.timestamp_unixtime_ms = example_timestamp + example_duration\n\nbatch.events = [session_start, session_end]Use these events to represent the nuances of inter- and intra-session user-behavior with your app. Install events are crucial to power many attribution integrations and to judge the success of marketing campaigns.
\ninstall = mparticle.ApplicationStateTransitionEvent.create_install_event()\ninstall.timestamp_unixtime_ms = example_timestamp\n\nupgrade = mparticle.ApplicationStateTransitionEvent.create_upgrade_event()\nupgrade.timestamp_unixtime_ms = example_timestamp\n\nforeground = mparticle.ApplicationStateTransitionEvent.create_foreground_event()\nforeground.timestamp_unixtime_ms = example_timestamp\n\nbackground = mparticle.ApplicationStateTransitionEvent.create_background_event()\nbackground.timestamp_unixtime_ms = example_timestampTo conform to the ever growing global regulations on data privacy, mParticle provides Data Privacy Controls.
\nData privacy is configured in the dashboard and is attached via a batch’s consent_state.
ccpa_consent_state = mparticle.CCPAConsentState()\nccpa_consent_state.document = 'document_agreement.v3'\nccpa_consent_state.consented = True\nccpa_consent_state.timestamp_unixtime_ms = time.time_ns() // 1000000\nccpa_consent_state.location = 'mparticle.test/signup'\nccpa_consent_state.hardware_id = 'IDFA:a5d96n32-224a-3b11-1088-a202695bc710'\n\nconsent_state = mparticle.ConsentState()\nconsent_state.ccpa = {'data_sale_opt_out': ccpa_consent_state}\n\nbatch.consent_state = consent_stategdpr_consent_state = mparticle.GDPRConsentState()\ngdpr_consent_state.document = 'document_agreement.v2'\ngdpr_consent_state.consented = True\ngdpr_consent_state.timestamp_unixtime_ms = time.time_ns() // 1000000\ngdpr_consent_state.location = 'dtmgbank.com/signup'\ngdpr_consent_state.hardware_id = 'IDFA:a5d934n0-232f-4afc-2e9a-3832d95zc702'\n\nconsent_state = mparticle.ConsentState()\nconsent_state.gdpr = {'My Purpose': gdpr_consent_state}\n\nbatch.consent_state = consent_stateIn this example, 'My Purpose' should match the Consent Purpose defined in your GDPR Setting
The SDK provides an interface to the mParticle HTTP API by way of the EventsApi class.
\nAt minimum, the EventsApi must be initialized with an mParticle key and secret. You can find your mParticle key and secret by navigating to the Apps section of the mParticle platform UI.
\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
configuration = mparticle.Configuration()\nconfiguration.api_key = 'REPLACE WITH APP KEY'\nconfiguration.api_secret = 'REPLACE WITH APP SECRET'\nconfiguration.debug = True #enable logging of HTTP trafficIf your workspace is in a pod other than US1, make sure to set the host to the appropriate URL.
\n# Example for the EU1 pod, replace eu1 with the pod's name\nconfiguration.host = 'https://s2s.eu1.mparticle.com/v2'Finally, initialize the SDK with the configuration.
\napi_instance = mparticle.EventsApi(configuration)The EventsAPI class exposes two interfaces:
\nbulk_upload_events - Accepts up to 100 Batch objects for up to 100 users.upload_events - Accepts a single Batch object for a single usertry: \n api_instance.upload_events(batch)\n # you can also send multiple batches at a time to decrease the amount of network calls\n #api_instance.bulk_upload_events([batch, batch])\nexcept mparticle.rest.ApiException as e:\n print(f'Exception while calling mParticle: %{e}\\n')