This repository contains tools and specifications for working with audience definitions in a standardized format. It includes TypeScript implementations of the audience schema along with SDKs to help build and validate audience definitions.
The audience schema provides a structured way to define target audiences through a combination of user attributes, events, and logical conditions. The TypeScript implementation offers type-safe ways to construct and validate these audience definitions.
The schema folder contains models defined in the Json Schema format.
Located in sdk/typescript-schema, this package contains the core TypeScript types and interfaces that define the audience schema format. It provides the foundational types used by the SDK.
Located in sdk/typescript, this is a full-featured SDK that provides builders and utilities for working with audience definitions. It includes:
- Builder classes for constructing audience definitions
- Expression factories for creating complex queries
- Model factories for creating different types of models
- Validation utilities
- Serialization/deserialization helpers
Command to install package tagged as v0.1.0 directly from github
pip install git+ssh://git@github.com/mParticle/audience-sdk.git@v0.1.0#subdirectory=sdk/pythonuninstall
pip uninstall mp_audience_sdkupdate models
pip install -r sdk/python/requirements-dev.txtmake generate-python-models- increment version in
sdk/python/pyproject.toml - Merge and push
- Tag new release
git tag v0.1.0 -m "Python SDK 0.1.0" git push v0.1.0
For the TypeScript SDK: