Ad Events#
Opened Ad (openedAd)#
The openedAd event is recorded when:
- An Ad is loaded because the previous Story finished
- A user swipes left on a Story to go to the next Story and an Ad appears
- A user swipes right on a Story to go to the previous Story and an Ad appears
- An Ad is loaded because the previous Page finished and an Ad should appear next
- A user taps to skip to the next Page and an Ad should appear next
- A user taps to skip to the previous Page and an Ad should appear
This event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Ad ID | adId |
The ID of the Ad for which the event occurred. | be772f10-177e-4754-ac09-f91cb547316f |
| Ad Placement | adPlacement |
The placement of the ad which is being presented to the user. | betweenClips, betweenStories, betweenStoriesAndPages |
| Ad Stategy | adStrategy |
The placement of the ad which is being presented to the user. | Between Clips, Between Stories, Between Stories and Pages |
| Ad Type | adType |
The type of ad which is being presented to the user. | Stories |
| Advertiser Name | advertiserName |
The advertiser name of the Ad for which the event occurred. If no name is supplied, the advertiser URL will be used. | “Disney+, Hulu, https://nike.com, … |
| Categories | categories |
A list of the category names assigned to the Story for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Current Category | currentCategory |
The Category for the Story with which the user is interacting. This event property includes the Category’s title, ID, and placement. | { title: 'Game Screen', id: '0012200025', placement: { title: 'Game Screen', code: 'game-screen' } } |
| Opened Reason | openedReason |
The action which the user took to open the ad. | OpenedReason |
| Page Type | pageType |
The type of Page associated with the event. | image, video |
| Page Has Action | pageHasAction |
Whether the Page associated with the event contains an Action. | true, false |
| Page Action Text | pageActionText |
If the ad associated with the event has an action, this property captures its associated ‘Call To Action’ text. | “Swipe Up”, “Get Started” |
| Page Action URL | pageActionUrl |
If the ad associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Dismissed Ad (dismissedAd)#
The dismissedAd event is recorded when:
- A user taps close to dismiss the Ad.
- A user swipes down to dismiss the Ad.
- A user taps back on their device UI to dismiss the ad (Android only).
- A user taps to skip the Ad if the Ad is the last Page in the current set of Stories
- A user swipes left on the Ad if the ad is the last Page in the current set of Stories
- A user completes the Ad if the Ad is the last Page in the current set of Stories
This event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Ad ID | adId |
The ID of the Ad for which the event occurred. | be772f10-177e-4754-ac09-f91cb547316f |
| Ad Placement | adPlacement |
The placement of the ad which is being presented to the user. | betweenClips, betweenStories, betweenStoriesAndPages |
| Ad Stategy | adStrategy |
The placement of the ad which is being presented to the user. | Between Clips, Between Stories, Between Stories and Pages |
| Ad Type | adType |
The type of ad which is being presented to the user. | Stories |
| Advertiser Name | advertiserName |
The advertiser name of the Ad for which the event occurred. If no name is supplied, the advertiser URL will be used. | “Disney+, Hulu, https://nike.com, … |
| Categories | categories |
A list of the category names assigned to the Story for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Current Category | currentCategory |
The Category for the Story with which the user is interacting. This event property includes the Category’s title, ID, and placement. | { title: 'Game Screen', id: '0012200025', placement: { title: 'Game Screen', code: 'game-screen' } } |
| Dismissed Reason | dismissedReason |
The reason the ad was dismissed. | DismissedReason |
| Page Type | pageType |
The type of Page associated with the event. | image, video |
| Page Has Action | pageHasAction |
Whether the Page associated with the event contains an Action. | true, false |
| Page Action Text | pageActionText |
If the ad associated with the event has an action, this property captures its associated ‘Call To Action’ text. | “Swipe Up”, “Get Started” |
| Page Action URL | pageActionUrl |
If the ad associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Paused Ad Page (pausedAdPage)#
The pausedAdPage event is recorded when a user pauses a Page within an Ad by pressing and holding on the Page, or by using the Story playback controls.
This event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Ad ID | adId |
The ID of the Ad for which the event occurred. | be772f10-177e-4754-ac09-f91cb547316f |
| Ad Placement | adPlacement |
The placement of the ad which is being presented to the user. | betweenClips, betweenStories, betweenStoriesAndPages |
| Ad Stategy | adStrategy |
The placement of the ad which is being presented to the user. | Between Clips, Between Stories, Between Stories and Pages |
| Ad Type | adType |
The type of ad which is being presented to the user. | Stories |
| Advertiser Name | advertiserName |
The advertiser name of the Ad for which the event occurred. If no name is supplied, the advertiser URL will be used. | “Disney+, Hulu, https://nike.com, … |
| Current Category | currentCategory |
The Category for the Story with which the user is interacting. This event property includes the Category’s title, ID, and placement. | { title: 'Game Screen', id: '0012200025', placement: { title: 'Game Screen', code: 'game-screen' } } |
| Content Length | contentLength |
In milliseconds, the total duration of the Page content. | 15000, 41000, 32000 |
| Page Type | pageType |
The type of Page associated with the event. | image, video |
| Page Has Action | pageHasAction |
Whether the Page associated with the event contains an Action. | true, false |
| Page Action Text | pageActionText |
If the ad associated with the event has an action, this property captures its associated ‘Call To Action’ text. | “Swipe Up”, “Get Started” |
| Page Action URL | pageActionUrl |
If the ad associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Resumed Ad Page (resumedAdPage)#
The resumedAdPage event is recorded when a user resumes playing a Page within an Ad by releasing their long press which paused the Ad, or by using the Story playback controls.
This event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Ad ID | adId |
The ID of the Ad for which the event occurred. | be772f10-177e-4754-ac09-f91cb547316f |
| Ad Placement | adPlacement |
The placement of the ad which is being presented to the user. | betweenClips, betweenStories, betweenStoriesAndPages |
| Ad Stategy | adStrategy |
The placement of the ad which is being presented to the user. | Between Clips, Between Stories, Between Stories and Pages |
| Ad Type | adType |
The type of ad which is being presented to the user. | Stories |
| Advertiser Name | advertiserName |
The advertiser name of the Ad for which the event occurred. If no name is supplied, the advertiser URL will be used. | “Disney+, Hulu, https://nike.com, … |
| Current Category | currentCategory |
The Category for the Story with which the user is interacting. This event property includes the Category’s title, ID, and placement. | { title: 'Game Screen', id: '0012200025', placement: { title: 'Game Screen', code: 'game-screen' } } |
| Content Length | contentLength |
In milliseconds, the total duration of the Page content. | 15000, 41000, 32000 |
| Page Type | pageType |
The type of Page associated with the event. | image, video |
| Page Has Action | pageHasAction |
Whether the Page associated with the event contains an Action. | true, false |
| Page Action Text | pageActionText |
If the ad associated with the event has an action, this property captures its associated ‘Call To Action’ text. | “Swipe Up”, “Get Started” |
| Page Action URL | pageActionUrl |
If the ad associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Finished Ad (finishedAd)#
The finishedAd event is recorded at the same time as dimissedAd, skippedAd, and viewedAdPageComplete and gives an easier way to determine when an ad finishes for any reason.
This event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Ad ID | adId |
The ID of the Ad for which the event occurred. | be772f10-177e-4754-ac09-f91cb547316f |
| Ad Placement | adPlacement |
The placement of the ad which is being presented to the user. | betweenClips, betweenStories, betweenStoriesAndPages |
| Ad Stategy | adStrategy |
The placement of the ad which is being presented to the user. | Between Clips, Between Stories, Between Stories and Pages |
| Ad Type | adType |
The type of ad which is being presented to the user. | Stories |
| Advertiser Name | advertiserName |
The advertiser name of the Ad for which the event occurred. If no name is supplied, the advertiser URL will be used. | “Disney+, Hulu, https://nike.com, … |
| Current Category | currentCategory |
The Category for the Story with which the user is interacting. This event property includes the Category’s title, ID, and placement. | { title: 'Game Screen', id: '0012200025', placement: { title: 'Game Screen', code: 'game-screen' } } |
| Content Length | contentLength |
In milliseconds, the total duration of the Page content. | 15000, 41000, 32000 |
| Page Type | pageType |
The type of Page associated with the event. | image, video |
| Page Has Action | pageHasAction |
Whether the Page associated with the event contains an Action. | true, false |
| Page Action Text | pageActionText |
If the ad associated with the event has an action, this property captures its associated ‘Call To Action’ text. | “Swipe Up”, “Get Started” |
| Page Action URL | pageActionUrl |
If the ad associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Skipped Ad (skippedAd)#
The skippedAd event is recorded when:
- A user swipes left to go to the next Story before completing the current Ad
- A user swipes right on the Ad to skip to the previous Story before completing the current Ad
- A user taps on an Ad to go to the next Page or Story before completing the current Ad
This event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Ad ID | adId |
The ID of the Ad for which the event occurred. | be772f10-177e-4754-ac09-f91cb547316f |
| Ad Placement | adPlacement |
The placement of the ad which is being presented to the user. | betweenClips, betweenStories, betweenStoriesAndPages |
| Ad Stategy | adStrategy |
The placement of the ad which is being presented to the user. | Between Clips, Between Stories, Between Stories and Pages |
| Ad Type | adType |
The type of ad which is being presented to the user. | Stories |
| Advertiser Name | advertiserName |
The advertiser name of the Ad for which the event occurred. If no name is supplied, the advertiser URL will be used. | “Disney+, Hulu, https://nike.com, … |
| Categories | categories |
A list of the category names assigned to the Story for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Current Category | currentCategory |
The Category for the Story with which the user is interacting. This event property includes the Category’s title, ID, and placement. | { title: 'Game Screen', id: '0012200025', placement: { title: 'Game Screen', code: 'game-screen' } } |
| Page Type | pageType |
The type of Page associated with the event. | image, video |
| Page Has Action | pageHasAction |
Whether the Page associated with the event contains an Action. | true, false |
| Page Action Text | pageActionText |
If the ad associated with the event has an action, this property captures its associated ‘Call To Action’ text. | “Swipe Up”, “Get Started” |
| Page Action URL | pageActionUrl |
If the ad associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Ad Action Button Tapped (adActionButtonTapped)#
The adActionButtonTapped event is recorded when:
- A user swipes up on an Ad to open a link
- A user taps on the swipe up element of an Ad to open a link
This event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Ad ID | adId |
The ID of the Ad for which the event occurred. | be772f10-177e-4754-ac09-f91cb547316f |
| Ad Placement | adPlacement |
The placement of the ad which is being presented to the user. | betweenClips, betweenStories, betweenStoriesAndPages |
| Ad Stategy | adStrategy |
The placement of the ad which is being presented to the user. | Between Clips, Between Stories, Between Stories and Pages |
| Ad Type | adType |
The type of ad which is being presented to the user. | Stories |
| Advertiser Name | advertiserName |
The advertiser name of the Ad for which the event occurred. If no name is supplied, the advertiser URL will be used. | “Disney+, Hulu, https://nike.com, … |
| Categories | categories |
A list of the category names assigned to the Story for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Current Category | currentCategory |
The Category for the Story with which the user is interacting. This event property includes the Category’s title, ID, and placement. | { title: 'Game Screen', id: '0012200025', placement: { title: 'Game Screen', code: 'game-screen' } } |
| Page Type | pageType |
The type of Page associated with the event. | image, video |
| Page Has Action | pageHasAction |
Whether the Page associated with the event contains an Action. | true, false |
| Page Action Text | pageActionText |
If the ad associated with the event has an action, this property captures its associated ‘Call To Action’ text. | “Swipe Up”, “Get Started” |
| Page Action URL | pageActionUrl |
If the ad associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Viewed Ad Page First Quartile (viewedAdPageFirstQuartile)#
The viewedAdPageFirstQuartile event is recorded when a user reaches 1/4 of the way through the duration of an Ad Page.
This event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Ad ID | adId |
The ID of the Ad for which the event occurred. | be772f10-177e-4754-ac09-f91cb547316f |
| Ad Placement | adPlacement |
The placement of the ad which is being presented to the user. | betweenClips, betweenStories, betweenStoriesAndPages |
| Ad Stategy | adStrategy |
The placement of the ad which is being presented to the user. | Between Clips, Between Stories, Between Stories and Pages |
| Ad Type | adType |
The type of ad which is being presented to the user. | Stories |
| Advertiser Name | advertiserName |
The advertiser name of the Ad for which the event occurred. If no name is supplied, the advertiser URL will be used. | “Disney+, Hulu, https://nike.com, … |
| Categories | categories |
A list of the category names assigned to the Story for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Current Category | currentCategory |
The Category for the Story with which the user is interacting. This event property includes the Category’s title, ID, and placement. | { title: 'Game Screen', id: '0012200025', placement: { title: 'Game Screen', code: 'game-screen' } } |
| Page Type | pageType |
The type of Page associated with the event. | image, video |
| Page Has Action | pageHasAction |
Whether the Page associated with the event contains an Action. | true, false |
| Page Action Text | pageActionText |
If the ad associated with the event has an action, this property captures its associated ‘Call To Action’ text. | “Swipe Up”, “Get Started” |
| Page Action URL | pageActionUrl |
If the ad associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Viewed Ad Page Midpoint (viewedAdPageMidpoint)#
The viewedAdPageMidpoint event is recorded when a user reaches halfway through the duration of an Ad Page.
This event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Ad ID | adId |
The ID of the Ad for which the event occurred. | be772f10-177e-4754-ac09-f91cb547316f |
| Ad Placement | adPlacement |
The placement of the ad which is being presented to the user. | betweenClips, betweenStories, betweenStoriesAndPages |
| Ad Stategy | adStrategy |
The placement of the ad which is being presented to the user. | Between Clips, Between Stories, Between Stories and Pages |
| Ad Type | adType |
The type of ad which is being presented to the user. | Stories |
| Advertiser Name | advertiserName |
The advertiser name of the Ad for which the event occurred. If no name is supplied, the advertiser URL will be used. | “Disney+, Hulu, https://nike.com, … |
| Categories | categories |
A list of the category names assigned to the Story for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Current Category | currentCategory |
The Category for the Story with which the user is interacting. This event property includes the Category’s title, ID, and placement. | { title: 'Game Screen', id: '0012200025', placement: { title: 'Game Screen', code: 'game-screen' } } |
| Page Type | pageType |
The type of Page associated with the event. | image, video |
| Page Has Action | pageHasAction |
Whether the Page associated with the event contains an Action. | true, false |
| Page Action Text | pageActionText |
If the ad associated with the event has an action, this property captures its associated ‘Call To Action’ text. | “Swipe Up”, “Get Started” |
| Page Action URL | pageActionUrl |
If the ad associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Viewed Ad Page Third Quartile (viewedAdPageThirdQuartile)#
The viewedAdPageThirdQuartile event is recorded when a user reaches 3/4 of the way through the duration of an Ad Page.
This event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Ad ID | adId |
The ID of the Ad for which the event occurred. | be772f10-177e-4754-ac09-f91cb547316f |
| Ad Placement | adPlacement |
The placement of the ad which is being presented to the user. | betweenClips, betweenStories, betweenStoriesAndPages |
| Ad Stategy | adStrategy |
The placement of the ad which is being presented to the user. | Between Clips, Between Stories, Between Stories and Pages |
| Ad Type | adType |
The type of ad which is being presented to the user. | Stories |
| Advertiser Name | advertiserName |
The advertiser name of the Ad for which the event occurred. If no name is supplied, the advertiser URL will be used. | “Disney+, Hulu, https://nike.com, … |
| Categories | categories |
A list of the category names assigned to the Story for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Current Category | currentCategory |
The Category for the Story with which the user is interacting. This event property includes the Category’s title, ID, and placement. | { title: 'Game Screen', id: '0012200025', placement: { title: 'Game Screen', code: 'game-screen' } } |
| Page Type | pageType |
The type of Page associated with the event. | image, video |
| Page Has Action | pageHasAction |
Whether the Page associated with the event contains an Action. | true, false |
| Page Action Text | pageActionText |
If the ad associated with the event has an action, this property captures its associated ‘Call To Action’ text. | “Swipe Up”, “Get Started” |
| Page Action URL | pageActionUrl |
If the ad associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |
Viewed Ad Page Complete (viewedAdPageComplete)#
The viewedAdPageComplete event is recorded when a user reaches the end of the duration of an Ad Page.
This event contains the following properties:
| Event Property | Property Name | Description | Sample values |
|---|---|---|---|
| Ad ID | adId |
The ID of the Ad for which the event occurred. | be772f10-177e-4754-ac09-f91cb547316f |
| Ad Placement | adPlacement |
The placement of the ad which is being presented to the user. | betweenClips, betweenStories, betweenStoriesAndPages |
| Ad Stategy | adStrategy |
The placement of the ad which is being presented to the user. | Between Clips, Between Stories, Between Stories and Pages |
| Ad Type | adType |
The type of ad which is being presented to the user. | Stories |
| Advertiser Name | advertiserName |
The advertiser name of the Ad for which the event occurred. If no name is supplied, the advertiser URL will be used. | “Disney+, Hulu, https://nike.com, … |
| Categories | categories |
A list of the category names assigned to the Story for which the event occurred. | ["Top Stories", "Europe", "Recap"] |
| Current Category | currentCategory |
The Category for the Story with which the user is interacting. This event property includes the Category’s title, ID, and placement. | { title: 'Game Screen', id: '0012200025', placement: { title: 'Game Screen', code: 'game-screen' } } |
| Page Type | pageType |
The type of Page associated with the event. | image, video |
| Page Has Action | pageHasAction |
Whether the Page associated with the event contains an Action. | true, false |
| Page Action Text | pageActionText |
If the ad associated with the event has an action, this property captures its associated ‘Call To Action’ text. | “Swipe Up”, “Get Started” |
| Page Action URL | pageActionUrl |
If the ad associated with the event has an Action, the URL to which the Action links. | "https://www.youtube.com/watch?v=oHg5SJYRHA0" |