Skip to content

Make it clearer os should always be sent on all events #34

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Make it clearer os should always be sent on all events #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
64 changes: 36 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,30 +337,32 @@ ___
#### Parameters

Note about required identifiers. You must send up (in user_data):
1. developer_identity
1. `developer_identity`
OR
2. browser_fingerprint_id
2. `browser_fingerprint_id`
OR
3. os=iOS AND (idfa OR idfv)
3. `os`: `iOS` AND (`idfa` OR `idfv`)
OR
4. os=Android AND (android_id or aaid)
4. `os`: `Android` AND (`android_id` or `aaid`)

Note: In the case of 1. and 2. We will also need the `os` which can be either `Android`, `iOS`, `Windows`, `Mac_OS`, `Linux` or `Other` for this data to be shown on all dashboards.

--

*branch_key* _required_
: the app's branch_key

*name* _required_
: one of ADD_TO_CART, ADD_TO_WISHLIST, VIEW_CART, INITIATE_PURCHASE, ADD_PAYMENT_INFO, PURCHASE, SPEND_CREDITS
: one of `ADD_TO_CART`, `ADD_TO_WISHLIST`, `VIEW_CART`, `INITIATE_PURCHASE`, `ADD_PAYMENT_INFO`, `PURCHASE`, `SPEND_CREDITS`

*user_data.os* _required_
: one of "Android", "iOS"
: one of `Android`, `iOS`, `Windows`, `Mac_OS`, `Linux` or `Other`

*user_data.os_version*
: version of the operating system. Specific to Android and iOS.
: version of the operating system. Specific to `Android` and `iOS`.

*user_data.environment*
: usually FULL_APP.
: usually `FULL_APP`.

*user_data.aaid*
: Android/Google advertising id
Expand Down Expand Up @@ -716,30 +718,32 @@ ___
#### Parameters

Note about required identifiers. You must send up (in user_data):
1. developer_identity
1. `developer_identity`
OR
2. browser_fingerprint_id
2. `browser_fingerprint_id`
OR
3. os=iOS AND (idfa OR idfv)
3. `os`: `iOS` AND (`idfa` OR `idfv`)
OR
4. os=Android AND (android_id or aaid)
4. `os`: `Android` AND (`android_id` or `aaid`)

Note: In the case of 1. and 2. We will also need the `os` which can be either `Android`, `iOS`, `Windows`, `Mac_OS`, `Linux` or `Other` for this data to be shown on all dashboards.

--

*branch_key* _required_
: the app's branch_key

*name* _required_
: one of SEARCH, VIEW_ITEM, VIEW_ITEMS, RATE, SHARE
: one of `SEARCH`, `VIEW_ITEM`, `VIEW_ITEMS`, `RATE`, `SHARE`

*user_data.os* _required_
: one of "Android", "iOS"
: one of `Android`, `iOS`, `Windows`, `Mac_OS`, `Linux` or `Other`

*user_data.os_version*
: version of the operating system. Specific to Android and iOS.

*user_data.environment*
: usually FULL_APP.
: usually `FULL_APP`.

*user_data.aaid*
: Android/Google advertising id
Expand Down Expand Up @@ -1065,30 +1069,32 @@ ___
#### Parameters

Note about required identifiers. You must send up (in user_data):
1. developer_identity
1. `developer_identity`
OR
2. browser_fingerprint_id
2. `browser_fingerprint_id`
OR
3. os=iOS AND (idfa OR idfv)
3. `os`: `iOS` AND (`idfa` OR `idfv`)
OR
4. os=Android AND (android_id or aaid)
4. `os`: `Android` AND (`android_id` or `aaid`)

Note: In the case of 1. and 2. We will also need the `os` which can be either `Android`, `iOS`, `Windows`, `Mac_OS`, `Linux` or `Other` for this data to be shown on all dashboards.

--

*branch_key* _required_
: the app's branch_key

*name* _required_
: one of SEARCH, VIEW_CONTENT, VIEW_CONTENT_LIST, RATE, SHARE_CONTENT_ITEM
: one of `SEARCH`, `VIEW_CONTENT`, `VIEW_CONTENT_LIST`, `RATE`, `SHARE_CONTENT_ITEM`

*user_data.os* _required_
: one of "Android", "iOS"
: one of `Android`, `iOS`, `Windows`, `Mac_OS`, `Linux` or `Other`

*user_data.os_version*
: version of the operating system. Specific to Android and iOS.

*user_data.environment*
: usually FULL_APP.
: usually `FULL_APP`.

*user_data.aaid*
: Android/Google advertising id
Expand Down Expand Up @@ -1214,13 +1220,15 @@ ___
#### Parameters

Note about required identifiers. You must send up (in user_data):
1. developer_identity
1. `developer_identity`
OR
2. browser_fingerprint_id
2. `browser_fingerprint_id`
OR
3. os=iOS AND (idfa OR idfv)
3. `os`: `iOS` AND (`idfa` OR `idfv`)
OR
4. os=Android AND (android_id or aaid)
4. `os`: `Android` AND (`android_id` or `aaid`)

Note: In the case of 1. and 2. We will also need the `os` which can be either `Android`, `iOS`, `Windows`, `Mac_OS`, `Linux` or `Other` for this data to be shown on all dashboards.

--

Expand All @@ -1231,13 +1239,13 @@ OR
: string for custom event name

*user_data.os* _required_
: one of "Android", "iOS"
: one of `Android`, `iOS`, `Windows`, `Mac_OS`, `Linux` or `Other`

*user_data.os_version*
: version of the operating system. Specific to Android and iOS.

*user_data.environment*
: usually FULL_APP.
: usually `FULL_APP`.

*user_data.aaid*
: Android/Google advertising id
Expand Down