This page lists the ad events that the SDK sends to onUserActivityOccurred,
when each one is recorded, and its properties. The Storyteller Web Showcase
handles these events in its onUserActivityOccurred handler.
The tables list the properties of ads shown in Stories. Ads shown in Clips
include collection, clipHasAction, clipActionText, and clipActionUrl
instead of categories, categoryDetails, currentCategory,
pageHasAction, pageActionText, and pageActionUrl. For those ads,
adType is clips and adPlacement is betweenClips.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
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.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
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.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
The finishedAd event is recorded at the same time as dismissedAd, skippedAd, and viewedAdPageComplete, and gives an easier way to determine when an ad finishes for any reason. In the Clips player, it is also recorded when a user swipes away from an 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.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
The Category for the Story with which the user is interacting. This event property includes the Category's name (title), external ID (id), and placement.
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://example.com/action
{"slug": "analytics-ad-events", "page_title": "Ad Events", "page_url": "analytics/AdEvents/", "canonical_url": "/web/analytics/AdEvents/", "markdown": "# Ad Events\n\nThis page lists the ad events that the SDK sends to `onUserActivityOccurred`,\nwhen each one is recorded, and its properties. The Storyteller Web Showcase\nhandles these events in its [`onUserActivityOccurred` handler](https://github.com/getstoryteller/storyteller-showcase-web/blob/11.0.0/nextjs/src/components/contexts/storytellerSdkDelegate.ts#L60).\n\nThe tables list the properties of ads shown in Stories. Ads shown in Clips\ninclude `collection`, `clipHasAction`, `clipActionText`, and `clipActionUrl`\ninstead of `categories`, `categoryDetails`, `currentCategory`,\n`pageHasAction`, `pageActionText`, and `pageActionUrl`. For those ads,\n`adType` is `clips` and `adPlacement` is `betweenClips`.\n\n## Opened Ad (`openedAd`)\n\nThe `openedAd` event is recorded when:\n\n- An Ad is loaded because the previous Story finished\n- A user swipes left on a Story to go to the next Story and an Ad appears\n- A user swipes right on a Story to go to the previous Story and an Ad appears\n- An Ad is loaded because the previous Page finished and an Ad should appear next\n- A user taps to skip to the next Page and an Ad should appear next\n- A user taps to skip to the previous Page and an Ad should appear\n- A user swipes to an Ad in the Clips player\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ---------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Ad ID | `adId` | The ID of the Ad for which the event occurred. | `be772f10-177e-4754-ac09-f91cb547316f` |\n| Ad Placement | `adPlacement` | The placement of the ad which is being presented to the user. | `betweenClips`, `betweenPages`, `betweenStories`, `betweenStoriesAndPages` |\n| Ad Strategy | `adStrategy` | The placement of the ad as a display label. | `Between Clips`, `Between Pages`, `Between Stories`, `Between Stories and Pages` |\n| Ad Type | `adType` | Whether the ad appeared in Stories or Clips. | `stories`, `clips` |\n| 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`, \u2026 |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the ad event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Content Length | `contentLength` | In milliseconds, the total duration of the Page content. | 15000, 41000, 32000 |\n| Opened Reason | `openedReason` | The action which the user took to open the ad. | [OpenedReason](../Analytics.md#openedreason) |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page Action Text | `pageActionText` | If the ad associated with the event has an action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the ad associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n\n## Dismissed Ad (`dismissedAd`)\n\nThe `dismissedAd` event is recorded when:\n\n- A user taps close to dismiss the Ad\n- A user swipes down to dismiss the Ad\n- A user presses the browser back button, or leaves the page, while an Ad is showing\n- A user taps to skip the Ad if the Ad is the last Page in the current set of Stories\n- A user swipes left on the Ad if the Ad is the last Page in the current set of Stories\n- A user completes the Ad if the Ad is the last Page in the current set of Stories\n- A user closes the Clips player while an Ad is showing\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ---------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Ad ID | `adId` | The ID of the Ad for which the event occurred. | `be772f10-177e-4754-ac09-f91cb547316f` |\n| Ad Placement | `adPlacement` | The placement of the ad which is being presented to the user. | `betweenClips`, `betweenPages`, `betweenStories`, `betweenStoriesAndPages` |\n| Ad Strategy | `adStrategy` | The placement of the ad as a display label. | `Between Clips`, `Between Pages`, `Between Stories`, `Between Stories and Pages` |\n| Ad Type | `adType` | Whether the ad appeared in Stories or Clips. | `stories`, `clips` |\n| 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`, \u2026 |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the ad event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Content Length | `contentLength` | In milliseconds, the total duration of the Page content. | 15000, 41000, 32000 |\n| Dismissed Reason | `dismissedReason` | The reason the ad was dismissed. | [DismissedReason](../Analytics.md#dismissedreason) |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page Action Text | `pageActionText` | If the ad associated with the event has an action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the ad associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n\n## Paused Ad Page (`pausedAdPage`)\n\nThe `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.\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ---------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Ad ID | `adId` | The ID of the Ad for which the event occurred. | `be772f10-177e-4754-ac09-f91cb547316f` |\n| Ad Placement | `adPlacement` | The placement of the ad which is being presented to the user. | `betweenClips`, `betweenPages`, `betweenStories`, `betweenStoriesAndPages` |\n| Ad Strategy | `adStrategy` | The placement of the ad as a display label. | `Between Clips`, `Between Pages`, `Between Stories`, `Between Stories and Pages` |\n| Ad Type | `adType` | Whether the ad appeared in Stories or Clips. | `stories`, `clips` |\n| 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`, \u2026 |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the ad event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page Action Text | `pageActionText` | If the ad associated with the event has an action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the ad associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n\n## Resumed Ad Page (`resumedAdPage`)\n\nThe `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.\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ---------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Ad ID | `adId` | The ID of the Ad for which the event occurred. | `be772f10-177e-4754-ac09-f91cb547316f` |\n| Ad Placement | `adPlacement` | The placement of the ad which is being presented to the user. | `betweenClips`, `betweenPages`, `betweenStories`, `betweenStoriesAndPages` |\n| Ad Strategy | `adStrategy` | The placement of the ad as a display label. | `Between Clips`, `Between Pages`, `Between Stories`, `Between Stories and Pages` |\n| Ad Type | `adType` | Whether the ad appeared in Stories or Clips. | `stories`, `clips` |\n| 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`, \u2026 |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the ad event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page Action Text | `pageActionText` | If the ad associated with the event has an action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the ad associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n\n## Finished Ad (`finishedAd`)\n\nThe `finishedAd` event is recorded at the same time as `dismissedAd`, `skippedAd`, and `viewedAdPageComplete`, and gives an easier way to determine when an ad finishes for any reason. In the Clips player, it is also recorded when a user swipes away from an Ad.\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ---------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Ad ID | `adId` | The ID of the Ad for which the event occurred. | `be772f10-177e-4754-ac09-f91cb547316f` |\n| Ad Placement | `adPlacement` | The placement of the ad which is being presented to the user. | `betweenClips`, `betweenPages`, `betweenStories`, `betweenStoriesAndPages` |\n| Ad Strategy | `adStrategy` | The placement of the ad as a display label. | `Between Clips`, `Between Pages`, `Between Stories`, `Between Stories and Pages` |\n| Ad Type | `adType` | Whether the ad appeared in Stories or Clips. | `stories`, `clips` |\n| 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`, \u2026 |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the ad event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page Action Text | `pageActionText` | If the ad associated with the event has an action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the ad associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n\n## Skipped Ad (`skippedAd`)\n\nThe `skippedAd` event is recorded when:\n\n- A user swipes left to go to the next Story before completing the current Ad\n- A user swipes right on the Ad to skip to the previous Story before completing the current Ad\n- A user taps on an Ad to go to the next Page or Story before completing the current Ad\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ---------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Ad ID | `adId` | The ID of the Ad for which the event occurred. | `be772f10-177e-4754-ac09-f91cb547316f` |\n| Ad Placement | `adPlacement` | The placement of the ad which is being presented to the user. | `betweenClips`, `betweenPages`, `betweenStories`, `betweenStoriesAndPages` |\n| Ad Strategy | `adStrategy` | The placement of the ad as a display label. | `Between Clips`, `Between Pages`, `Between Stories`, `Between Stories and Pages` |\n| Ad Type | `adType` | Whether the ad appeared in Stories or Clips. | `stories`, `clips` |\n| 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`, \u2026 |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the ad event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page Action Text | `pageActionText` | If the ad associated with the event has an action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the ad associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n\n## Ad Action Button Tapped (`adActionButtonTapped`)\n\nThe `adActionButtonTapped` event is recorded when:\n\n- A user swipes up on an Ad to open a link\n- A user taps on the swipe up element of an Ad to open a link\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ---------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Ad ID | `adId` | The ID of the Ad for which the event occurred. | `be772f10-177e-4754-ac09-f91cb547316f` |\n| Ad Placement | `adPlacement` | The placement of the ad which is being presented to the user. | `betweenClips`, `betweenPages`, `betweenStories`, `betweenStoriesAndPages` |\n| Ad Strategy | `adStrategy` | The placement of the ad as a display label. | `Between Clips`, `Between Pages`, `Between Stories`, `Between Stories and Pages` |\n| Ad Type | `adType` | Whether the ad appeared in Stories or Clips. | `stories`, `clips` |\n| 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`, \u2026 |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the ad event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page Action Text | `pageActionText` | If the ad associated with the event has an action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the ad associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n\n## Viewed Ad Page First Quartile (`viewedAdPageFirstQuartile`)\n\nThe `viewedAdPageFirstQuartile` event is recorded when a user reaches 1/4 of the way through the duration of an Ad Page.\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ---------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Ad ID | `adId` | The ID of the Ad for which the event occurred. | `be772f10-177e-4754-ac09-f91cb547316f` |\n| Ad Placement | `adPlacement` | The placement of the ad which is being presented to the user. | `betweenClips`, `betweenPages`, `betweenStories`, `betweenStoriesAndPages` |\n| Ad Strategy | `adStrategy` | The placement of the ad as a display label. | `Between Clips`, `Between Pages`, `Between Stories`, `Between Stories and Pages` |\n| Ad Type | `adType` | Whether the ad appeared in Stories or Clips. | `stories`, `clips` |\n| 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`, \u2026 |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the ad event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page Action Text | `pageActionText` | If the ad associated with the event has an action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the ad associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n\n## Viewed Ad Page Midpoint (`viewedAdPageMidpoint`)\n\nThe `viewedAdPageMidpoint` event is recorded when a user reaches halfway through the duration of an Ad Page.\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ---------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Ad ID | `adId` | The ID of the Ad for which the event occurred. | `be772f10-177e-4754-ac09-f91cb547316f` |\n| Ad Placement | `adPlacement` | The placement of the ad which is being presented to the user. | `betweenClips`, `betweenPages`, `betweenStories`, `betweenStoriesAndPages` |\n| Ad Strategy | `adStrategy` | The placement of the ad as a display label. | `Between Clips`, `Between Pages`, `Between Stories`, `Between Stories and Pages` |\n| Ad Type | `adType` | Whether the ad appeared in Stories or Clips. | `stories`, `clips` |\n| 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`, \u2026 |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the ad event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page Action Text | `pageActionText` | If the ad associated with the event has an action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the ad associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n\n## Viewed Ad Page Third Quartile (`viewedAdPageThirdQuartile`)\n\nThe `viewedAdPageThirdQuartile` event is recorded when a user reaches 3/4 of the way through the duration of an Ad Page.\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ---------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Ad ID | `adId` | The ID of the Ad for which the event occurred. | `be772f10-177e-4754-ac09-f91cb547316f` |\n| Ad Placement | `adPlacement` | The placement of the ad which is being presented to the user. | `betweenClips`, `betweenPages`, `betweenStories`, `betweenStoriesAndPages` |\n| Ad Strategy | `adStrategy` | The placement of the ad as a display label. | `Between Clips`, `Between Pages`, `Between Stories`, `Between Stories and Pages` |\n| Ad Type | `adType` | Whether the ad appeared in Stories or Clips. | `stories`, `clips` |\n| 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`, \u2026 |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the ad event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page Action Text | `pageActionText` | If the ad associated with the event has an action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the ad associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n\n## Viewed Ad Page Complete (`viewedAdPageComplete`)\n\nThe `viewedAdPageComplete` event is recorded when a user reaches the end of the duration of an Ad Page.\n\nThis event contains the following properties:\n\n| Event Property | Property Name | Description | Sample values |\n| ---------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| Ad ID | `adId` | The ID of the Ad for which the event occurred. | `be772f10-177e-4754-ac09-f91cb547316f` |\n| Ad Placement | `adPlacement` | The placement of the ad which is being presented to the user. | `betweenClips`, `betweenPages`, `betweenStories`, `betweenStoriesAndPages` |\n| Ad Strategy | `adStrategy` | The placement of the ad as a display label. | `Between Clips`, `Between Pages`, `Between Stories`, `Between Stories and Pages` |\n| Ad Type | `adType` | Whether the ad appeared in Stories or Clips. | `stories`, `clips` |\n| 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`, \u2026 |\n| Categories | `categories` | A list of the category names assigned to the Story for which the event occurred. | [\"Top Stories\", \"Europe\", \"Recap\"] |\n| Category Details | `categoryDetails` | A list of Category Detail objects assigned to the Story for which the ad event occurred. | `[{ name: 'Greens v Blues, 10/06/2022', id: '0012200025', externalId: 'game-0012200025', type: 'game', placement: 'Game Screen' }]` |\n| Current Category | `currentCategory` | The Category for the Story with which the user is interacting. This event property includes the Category's name (`title`), external ID (`id`), and placement. | `{ title: 'Greens v Blues, 10/06/2022', id: 'game-0012200025', placement: 'Game Screen' }` |\n| Page Type | `pageType` | The type of Page associated with the event. | `image`, `video` |\n| Page Has Action | `pageHasAction` | Whether the Page associated with the event contains an Action. | `true`, `false` |\n| Page Action Text | `pageActionText` | If the ad associated with the event has an action, this property captures its associated \u2018Call To Action\u2019 text. | \u201cSwipe Up\u201d, \u201cGet Started\u201d |\n| Page Action URL | `pageActionUrl` | If the ad associated with the event has an Action, the URL to which the Action links. | `https://example.com/action` |\n", "copy_markdown_include_header": false, "base_path": "", "ai_dir": "ai", "missing_payload_behavior": "empty"}