RevShifter

rev_shifter

RevShifter shows from the bottom or top of the page on scroll or pan. It's used by placing the script and ad code definition on the page.

<script src="http://labs-cdn.revcontent.com/build/revshifter.min.js"></script>

<script>
new RevShifter({
api_key: 'api_key',
pub_id: 123,
widget_id: 456,
domain: 'mysite.com'
});
</script>

Options

Default values are shown.

api_key(required)

your api key

domain(required)

your widget domain

pub_id(required)

your pub id

widget_id(required)

your widget id

ad_border

Display a border around each ad

ad_border: false

ad_overlay

Key value ad overlay config object where the key is the content type and the value is the icon to use. For example to use the video_rectangle icon for video content use video: 'video_rectangle'. The icon will be appended to the .rev-ad element.

ad_overlay: false

ad_overlay_position

The position of the ad overlay icon. Available options include center, top_left, top_right, bottom_right and bottom_left.

ad_overlay_position: 'bottom_right'

closed_hours

Number of hours to keep closed

closed_hours: 24

css

Additional CSS to append.

css: ''

devices

Devices to show on. Options include phone, tablet and desktop.

devices: [
'phone',
'tablet',
'desktop'
]

disclosure_text

Text to display for disclosure. This text triggers the disclosure/interests dialog on click.

disclosure_text: 'Sponsored by Revcontent'

header

Text displayed above ads. Wrapped inside ``````.

header: 'Trending Now'

hide_footer

Set true to not display the disclosure text.

hide_footer: false

hide_header

Set true to not display the headerl

hide_header: true

hide_on_show_transition

Set false to prevent RevShifter from hiding while it is still in a show transition.

hide_on_show_transition: true

hide_provider

Display the provider in the ads.

hide_provider: false

image_overlay

Key value image overlay object config where the key is the content type and the value is the icon to use. For example to use the video_rectangle icon for video content use video: 'video_rectangle'. The icon will be appended to the .rev-image element.

image_overlay: false

image_overlay_position

The position of the image overlay icon. Available options include center, top_left, top_right, bottom_right and bottom_left.

image_overlay_position: 'center'

internal

Display internal ads. The sponsored option is ignored and only internal ads are shown.

internal: false

max_headline

Show all of the headline for all ads. No ellipsis. This option overrides headline_size

max_headline: true

overlay_icons

Pass in custom icons where the key is the icon name and the value is the svg icon. For example {article_square: '<svg></svg>'}. Default icons include video_rectangle, video_square, video_circle1, video_circle2 and video_triangle.

overlay_icons: false

pagination_dots

To show the pagination dots

pagination_dots: false

per_row

Number of ads per row. Object or single value. Pass a single number to be used for every breakpoint or provide a value for each breakpoint.

per_row: {
xxs: 1,
xs: 1,
sm: 2,
md: 2,
lg: 3,
xl: 4,
xxl: 5
}

side

Show from the top or bottom of the page

side: 'bottom'

show_on_load

Show right away on page load without waiting for a user scroll.

show_on_load: false

show_on_scroll

Show on vertical scroll event

show_on_scroll: true

show_on_touch

Show on vertical pan touch gesture

show_on_touch: true

show_visible_selector

query selector for element that will trigger widget to show once visible

show_visible_selector: false

scroll_natural

By default scrolling up will hide and scrolling down will show. Set to false for the opposite behavior.

scroll_natural: true

query_params

Key value object for query params to send to server. Can be multidimensional

query_params: false

The example below demonstrates how to pass subid values. The resulting query parameters will be ?revsub[key]=value

query_params: {
revsub: {
key: 'value'
}
}

rows

Number of rows to display. Object or single value. Pass a single number to be used for every breakpoint or provide a value for each breakpoint.

rows: 1

touch_simulation

Shows an animation with a finger icon showing that the grid can be paginated.

touch_simulation: false

testing

Ignores closed_hours if true

testing: false

text_right

Text will be positioned to the right of the image

text_right: true

text_right_height

Value in pixels of the ad image if text_right is enabled

text_right_height: 100

transition_duration

Duration in milliseconds that it takes for RevShifter to show from the bottom/top of the page.

transition_duration: 1200

url

Use an alternate API url

url: 'https://trends.revcontent.com/api/v1/'

user_agent

Pass user_agent param to API

user_agent: false

user_ip

Pass user_ip to API

user_ip: false