Skip to content

Remove Constants.installationId #80

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.

Sign up for GitHub

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

Open
watchinharrison wants to merge 3 commits into
base: master
Choose a base branch
from
+7,710 −12
Open

Remove Constants.installationId #80

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
639558c
started on installationId-less
watchinharrison Dec 19, 2021
68a0ed4
public package
watchinharrison Dec 19, 2021
97b916b
update README
watchinharrison Dec 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,16 @@ It seems that Expo introduced some breaking changes in SDK 33, so if you are usi

Your React Native app's screen resolution, app name, app ID, app version and multiple other parameters will be automatically resolved and sent with each hit or event.

For SDK 44+ support you will need to provide the `clientId` in the form a UUID as `Constants.installationId` has been deprecated. You should generate and store this where appropriate for the platform and provide the value as the second argument.

##### Hits

Sending page hits or screen hits is done by constructing a new `PageHit` or `ScreenHit` instance and passing it to the `hit` function of an `Analytics` instance.

```
import { Analytics, PageHit } from 'expo-analytics';

const analytics = new Analytics('UA-XXXXXX-Y');
const analytics = new Analytics('UA-XXXXXX-Y', 'UUID');
analytics.hit(new PageHit('Home'))
.then(() => console.log("success"))
.catch(e => console.log(e.message));
Expand All @@ -51,7 +53,7 @@ These parameters are passed to the `Event` constructor in that order.
```
import { Analytics, Event } from 'expo-analytics';

const analytics = new Analytics('UA-XXXXXX-Y');
const analytics = new Analytics('UA-XXXXXX-Y', 'UUID');
analytics.event(new Event('Video', 'Play', 'The Big Lebowski', 123))
.then(() => console.log("success"))
.catch(e => console.log(e.message));
Expand All @@ -66,7 +68,7 @@ analytics.event(new Event('Video', 'Play', 'The Big Lebowski', 123))
```
import { Analytics, Event } from 'expo-analytics';

const analytics = new Analytics('UA-XXXXXX-Y');
const analytics = new Analytics('UA-XXXXXX-Y', 'UUID');
analytics.addCustomDimension(1, 'TrialAccount');
analytics.addCustomDimension(2, 'Comedy');
analytics.event(new Event('Video', 'Play', 'The Big Lebowski', 123))
Expand All @@ -87,7 +89,7 @@ analytics.removeCustomDimension(1);
```
import { Analytics, Event } from 'expo-analytics';

const analytics = new Analytics('UA-XXXXXX-Y');
const analytics = new Analytics('UA-XXXXXX-Y', 'UUID');
analytics.addCustomMetric(1, 15);
analytics.removeCustomMetric(1);
```
Expand All @@ -100,7 +102,7 @@ You can also optionally include any additional [supported parameters](https://de
import { Analytics } from 'expo-analytics';

// pass in the user ID (uid), referrer (dr) and campaign name (cn)
const analytics = new Analytics('UA-XXXXXX-Y', { uid: '999', dr: 'github.com', cn: 'get_more_views' });
const analytics = new Analytics('UA-XXXXXX-Y', 'UUID', { uid: '999', dr: 'github.com', cn: 'get_more_views' });
```

##### Ecommerce tracking
Expand All @@ -118,7 +120,7 @@ These parameters are passed to the `Transaction` constructor in that order.
```
import { Analytics, Transaction } from 'expo-analytics';

const analytics = new Analytics('UA-XXXXXX-Y');
const analytics = new Analytics('UA-XXXXXX-Y', 'UUID');

analytics.hit(new Transaction('1235', 'Store', 38.43, 1.29, 5))
.then(() => console.log("success"))
Expand All @@ -140,7 +142,7 @@ These parameters are passed to the `AddItem` constructor in that order.
```
import { Analytics, AddItem } from 'expo-analytics';

const analytics = new Analytics('UA-XXXXXX-Y');
const analytics = new Analytics('UA-XXXXXX-Y', 'UUID');

analytics.hit(new AddItem('1235', 'T-SHIRT', 11.99, 1, 'DD44', 'Clothes'))
.then(() => console.log("success"))
Expand All @@ -154,7 +156,7 @@ The Google Analytics API is a bit particular. If you're not seeing Real Time hi
```
import { Analytics, PageHit } from 'expo-analytics';

const analytics = new Analytics('UA-XXXXXX-Y', null, { debug: true });
const analytics = new Analytics('UA-XXXXXX-Y', 'UUID', null, { debug: true });
analytics.hit(new PageHit('IsItWorking'))
.then(() => console.log("success"))
.catch(e => console.log(e.message));
Expand Down
4 changes: 2 additions & 2 deletions analytics.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ export default class Analytics {
customDimensions = []
customMetrics = []

constructor(propertyId, additionalParameters = {}, options = defaultOptions){
constructor(propertyId, clientId, additionalParameters = {}, options = defaultOptions){
this.propertyId = propertyId;
this.options = options;
this.clientId = Constants.installationId;
this.clientId = clientId;
this.parameters = {
an: Constants.manifest.name,
aid: Constants.manifest.slug,
Expand Down
Loading