-
Notifications
You must be signed in to change notification settings - Fork 17
docs(audience): add UPM-visible README for the Audience package (SDK-150) #719
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Immutable Audience | ||
|
|
||
| Typed C# tracking SDK for Unity games. Captures `game_launch`, `session_start` / `session_heartbeat` / `session_end` automatically; predefined events (`Progression`, `Resource`, `Purchase`, `MilestoneReached`) and custom events on demand. | ||
|
|
||
| > **Status:** alpha. APIs and behavior may change between releases. | ||
|
|
||
| ## Install | ||
|
|
||
| In Unity, open **Window → Package Manager**, click **+ → Add package from git URL...**, and paste: | ||
|
|
||
| ``` | ||
| https://github.com/immutable/unity-immutable-sdk.git?path=src/Packages/Audience#main | ||
| ``` | ||
|
|
||
| For reproducible builds, replace `#main` with a release tag or a specific commit SHA. | ||
|
|
||
| Requires Unity 2021.3 or later. Works under Mono and IL2CPP. | ||
|
|
||
| ## First event | ||
|
|
||
| ```csharp | ||
| using Immutable.Audience; | ||
| using UnityEngine; | ||
|
|
||
| public static class Analytics | ||
| { | ||
| [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)] | ||
| private static void Init() | ||
| { | ||
| ImmutableAudience.Init(new AudienceConfig | ||
| { | ||
| PublishableKey = "YOUR_PUBLISHABLE_KEY", | ||
| Consent = ConsentLevel.Anonymous, | ||
| DistributionPlatform = DistributionPlatforms.Steam, | ||
| Debug = true, | ||
| }); | ||
|
|
||
| ImmutableAudience.Track(new Purchase { Currency = "USD", Value = 9.99m }); | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Press Play; `ImmutableAudience.Initialized` returns `true` and `AnonymousId` becomes a non-null GUID. The SDK warns to the Unity Console with prefix `[ImmutableAudience]` only on errors. | ||
|
|
||
| ## Documentation | ||
|
|
||
| - Integration guide and API reference: <https://docs.immutable.com/docs/products/audience/unity-sdk> | ||
| - Sample Unity project: [`examples/audience`](https://github.com/immutable/unity-immutable-sdk/tree/main/examples/audience) | ||
|
|
||
| ## License | ||
|
|
||
| See the repository [LICENSE](https://github.com/immutable/unity-immutable-sdk/blob/main/LICENSE.md). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.