Skip to content

Commit

Permalink
update readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
Catalin Demian committed Dec 22, 2020
1 parent 3ef4fbf commit 662f39a
Showing 1 changed file with 14 additions and 11 deletions.
25 changes: 14 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,27 +103,26 @@ But having a customerId makes profile matching more robust. It is not mutually e

These two events are absolutely pivotal to the functioning of the SDK, so take care to send them as early as possible.

#### Product Viewed
#### Profile Deidentified

A visitor clicks / taps / views / highlights or otherwise shows interest in a product.
Undo a profileIdentified event.

Think for example searching for a term, and selecting one of the product previews from a set of results. Or browsing a category of clothes, and clicking on a specific shirt to see a larger picture. This event is about capturing interest from the visitor for this product.
Use this if a user logs out, or otherwise signals that this device is no longer attached to the same person.

```swift
trackProductViewedEvent(productId: String)
trackProfileDeidentifiedEvent()
```

#### Product Category Viewed
A visitor clicks / taps / views / highlights or otherwise shows interest in a product category.
#### Product Viewed

For example, a store sells clothing, and they tap on "Women's Footwear".
A visitor clicks / taps / views / highlights or otherwise shows interest in a product.

Think for example searching for a term, and selecting one of the product previews from a set of results. Or browsing a category of clothes, and clicking on a specific shirt to see a larger picture. This event is about capturing interest from the visitor for this product.

```swift
trackProductCategoryViewedEvent(category: String)
trackProductViewedEvent(productId: String)
```

The value is opaque, and is only used to create segments and automation campaigns in the Ometria app. Stick to non-localised, predictable, human readable slugs. E.g. "womens-footwear".

#### Wishlist events

The user has added this product to their wishlist:
Expand Down Expand Up @@ -193,6 +192,10 @@ Concretely, this event should at least be triggered on:
* category lists
* any similar such screen

```swift
trackProductListingViewedEvent(listingType: String?, listingAttributes: [String: Any]?)
```

#### Screen Viewed

Tracking a user's independent screen views helps us track engagement of a user with the app, as well as where they are in a journey. An analogous event on a website would be to track independent page views.
Expand All @@ -210,7 +213,7 @@ Your app may have specific flows or pages that are of interest to the marketing
Check with the marketing team about the specifics, and what they might need. Especially if they're already using Ometria for e-mail, they will know about automation campaigns and custom events.

```swift
trackCustomEvent(customEventType: String, additionalInfo: [String: Any])
trackCustomEvent(customEventType: String, additionalInfo: [String: Any]?)
```

### `OmetriaBasket`
Expand Down

0 comments on commit 662f39a

Please sign in to comment.