Skip to content

Commit 65ef1d5

Browse files
New Module: SeenThis Brand Stories (prebid#6274)
* add seenthis brand stories dev documentation * update doc
1 parent 06838a2 commit 65ef1d5

File tree

1 file changed

+79
-0
lines changed

1 file changed

+79
-0
lines changed
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
layout: page_v2
3+
page_type: module
4+
title: Module - SeenThis Brand Stories
5+
description: Enable SeenThis Brand Stories ad format integration with fullscreen support
6+
module_code: seenthisBrandStories
7+
display_name: SeenthisBrandStories
8+
enable_download: true
9+
vendor_specific: true
10+
sidebarType: 1
11+
---
12+
13+
# SeenthisBrandStories Module
14+
15+
{:.no_toc}
16+
17+
- TOC
18+
{:toc}
19+
20+
## Overview
21+
22+
The module enables publishers to integrate SeenThis Brand Stories ads within Prebid.js. This module provides communication between the publisher's page and Brand Stories ad iframes, handling dynamic resizing, fullscreen mode, and responsive design considerations.
23+
24+
The module is bidder adapter agnostic and works with all Prebid.js adapters that serve Brand Stories creative content.
25+
26+
## Configuration
27+
28+
This module requires no configuration. Once included in your Prebid.js build, it automatically handles Brand Stories ads when they are served.
29+
30+
## Implementation
31+
32+
### Basic Setup
33+
34+
1. Include the SeenThis Brand Stories module in your Prebid.js build
35+
2. Configure your ad units as normal - no special configuration needed
36+
3. The module will automatically detect Brand Stories creatives and manage their behavior
37+
38+
## Technical Details
39+
40+
### Message Event Management
41+
42+
The module listens for specific message events from Brand Stories iframes and responds accordingly:
43+
44+
- Iframe resizing requests
45+
- Fullscreen mode transitions
46+
- Style and class modifications
47+
- Margin calculations for responsive layout
48+
49+
### CSS and Styling
50+
51+
The module dynamically applies CSS modifications to ensure proper display:
52+
53+
- Full-width responsive behavior
54+
- Auto-height adjustments
55+
- Dynamic margin calculations
56+
- Class-based style modifications
57+
58+
## Testing
59+
60+
A test page has been created to validate the integration:
61+
62+
- **Test Page**: [https://cdn.staging.sitestream.co/libs/storylines/branch-prebid-test-page-b52cdb5a/examples/prebid.html](https://cdn.staging.sitestream.co/libs/storylines/branch-prebid-test-page-b52cdb5a/examples/prebid.html)
63+
64+
### Local Testing
65+
66+
For testing with your own Prebid.js build:
67+
68+
1. Open the test page in Chrome
69+
2. Use the Network tab's "Override content" feature
70+
3. Replace the Prebid.js file with your custom build
71+
4. Verify that Brand Stories ads display and behave correctly
72+
73+
## Troubleshooting
74+
75+
### Common Issues
76+
77+
1. **Ads not resizing properly**: Ensure the module is included in your Prebid.js build
78+
2. **Fullscreen mode not working**: Check for conflicting CSS or JavaScript on the page
79+
3. **Multiple instances interfering**: The module handles this automatically, but ensure unique ad unit codes

0 commit comments

Comments
 (0)