URL Parameters

The digital edition viewer has the ability to customize views and add tracking through the use of URL parameters. The available parameters and their functions are outlined below. For instructions on assembling the parameters into a URL, please see the "Creating a URL With Parameters" section.

URL Parameters

Parameter Function Example
af Enable auto-flip through the digital edition until the user interacts for the provided number of sections To enable with a 5.5 second interval between page flips:
  • af=5.5
bt_field_name
bt_field_value
Specify a field name and a field value for tracking on external links For example:
  • &bt_field_name[]=exName&bt_field_value[]=exValue
would result in:
  • &exName=exValue
being appended to external links
forceVer Force viewer version Enforces the viewer version specified in "ver" parameter regardless of the browser detected:
  • ver=html5&forceVer=1
i Issue ID Unique string of numbers that represents an issue:
  • i=999999
l Auto-updating URL Use in conjunction with Publication ID (m) to create an auto-updating URL:
  • l=1
m Publication ID Unique string of numbers that represents a publication:
  • m=99999
p Directs to the specified sequential page number. For example the cover would be 1 and the inside front cover would be 2:
  • p=2
pn Directs to a the specified page name For example to go to the page named "Page 8":
  • pn=Page+8
Note that spaces must be represented as either "+" or "%20".
pp Single page/spread view defaults To enable single page view:
  • pp=1
To enable spread page view:
  • pp=2
ver Specify viewer version Specify the preferred viewer version:
  • ver=flex (Flash viewer 2.0)
  • ver=html5 (HTML5 viewer)
  • ver=html (Legacy HTML viewer)
  • ver=swf (Legacy Flash viewer)
view Directs to different sections of the viewer View parameters are a feature of the HTML 5 Viewer. Using the view parameter in a URL will direct users to a specific section of the digital edition.

The following values are accepted:
  • view=advertisersBrowser - Advertiser section
  • view=archiveBrowser - Publication Hub
  • view=contentsBrowser - Contents section
  • view=issuelistBrowser - Archive section
  • view=issueViewer - Default view

GeoPub Parameters

GeoPubs differ from typical digital edition URL formatting. Instead of "?i=[some issue id]" or "?m=[some magazine id]&l=1", the following string is used:

"?pid=3&pc=32701&co=US&pp=1"

The elements of this string are explained below:

Parameter Function Example
co ISO3116 two letter country code of a user This is required. Country codes can be found here.
pc Postal Code of a user Optional in the United States. If omitted, user will be prompted for 5-digit postal code
pid GeoPubID Unique string of numbers that represents a GeoPub (required)
pp Single page/spread view defaults Set pp=1 to enable single page view, Set pp=2 to enable spread page view

Creating a URL With Parameters

URL parameters are added to the end of a digital edition URL. The first parameter in a URL is always separated by a question mark (?) and subsequent parameters are separated by ampersands (&). Parameters should be added after the first value that follows the question mark (?) as digital edition URLs will always begin with at least one parameter already specified (this is normally the issue ID).

Take the following URL as an example:

http://example.com/publication/?i=123456

In this scenario placement of the parameter would fall after the “6”. The string would start with an ampersand and then specify the parameter and its desired value. Using the “ver” parameter as an example, if HTML 5 was the desired viewer then the appropriate string would be “&ver=html5”. The URL would then be formatted like this:

http://example.com/publication/?i=123456&ver=html5

Note: URLs generate a string of text that includes a hash (#) followed by page information. This information can be deleted when appending parameters to URLs. If kept, please note that parameters must be added before the hash.