Show Menu
TOPICS×

Manifest server query parameters

Query parameters tell the manifest server what sort of client sent the request and what that client wants the manifest server to do. Some are required and some have specific acceptable formats or values.
The complete URL consists of the base URL followed by a question mark, then parameterName=value arguments, separated by ampersands: Base URL?name1=value1&name2=value2& . . .&name n=value n

Recognized parameters

The manifest server recognizes the following parameters. It processes them or passes them, along with all unrecognized parameters, to the ad server.
Key
Description
Required
Valid Values
__sid__
Unique ID that the manifest server uses to generate the session ID.
Yes
Alphanumeric
g
Client device type
When targeting rules depend on device type
See list at Client Types (requires Zendesk access)
k
Keywords for custom ad targeting
No
URL-safe string in format key1=value1;key2=value2;. . .
u
Primetime ad insertion Asset ID.
Yes
MD5 Hash value
z
Primetime ad insertion Zone ID for the asset.
Yes
Integer
enableC3
The client is in a C3 window. If true, replace only local avails; otherwise, replace all avails.
No
Boolean
live
Indicates whether the content is a Live or VOD (video on-demand) stream.
Akamai Ad Scaler or iOS Safari client
Boolean
pabimode
Enable Partial ad break insertion support Enable if true or start Disable if false
No (default is disabled)
start , true , or false
ptadwindow
Duration (seconds) of ad stitching window: how far back to look for ads when a DVR user joins the stream.
No (default = 1800)
0 to 1800
ptassetid
Unique ID of the content that is assigned and maintained by publisher.
Akamai Ad Scaler
URL-safe string
ptcdn
List of one or more CDNs to host transcoded assets. See Multi CDN Support .
No (default=Akamai)
Example: Akamai, Level3, Limelight, Comcast
ptcueformat
The name of the custom ad cue format present in the M3U8.
No
DPISimple, DPIScte35, Elemental,NBC, NFL, or Turner
ptfailover
Signals the manifest server to identify primary and failover streams specified in the master playlist, and to treat them as disjoint sets. This facilitates failover and prevents timing errors. (For Apple HLS devices only.) See Facilitating HLS player switching .
No
true
ptmulticall
If set to true , multiple Auditude ad-calls for FER made; one for each ad-break. If absent or set to false , one ad-call is made to auditude for FER.
No
Boolean Note: The following requirements:
  • ptcueformat parameter must be set to nbc
  • pttimeline parameter is ignored.
ptplayer
Player making the request.
iOS/Safari
ios-mobileweb
ptrendition
Auto-generated by ad insertion and used by Akamai. Do not add or remove.
Akamai Ad Scaler
pttagds
No
true - manifest server includes a sequence tag before the content in each m3u8 file it sends; if parameter is not present or not true , manifest server does not include a sequence tag.
pttimeline
A string containing the desired timeline for ad placement and content, which overrides ad breaks in the content stream.
No
VOD timeline (see VOD timeline format ])
pttoken
Enable TS segment authorization tokens Note: Only Akamai CDN tokens supported
For TS segment authorization tokens
Boolean
pttrackingmode
Enable ad tracking; either custom client-side (simple), server-side (sstm), or hybrid (simplesstm).
No
simple , sstm , or simplesstm Note: If this parameter is not included, the #EX-X-MARKER is injected into the manifest. See EXT-X-MARKER Directive .
pttrackingposition
Instructs the manifest server to return ad tracking information only. Do not specify this parameter in the bootstrap request.
Client-side Tracking
Alphanumeric Note: The manifest server ignores all passed values. However, if you pass a null or empty string, the manifest server returns the M3U8 instead of tracking information.
pttrackingversion
The format version of the client-side tracking information.
Client-side Tracking
v1 , v2 , v3 , or vmap
scteTracking
Fetch M3U8 , before SCTE tracking information can be fetched in JSON V2 sidecar.
This parameter indicates to the manifest server that the player fetching the M3U8 needs SCTE tag information to be retrieved.
No (default: false )
true or false Note: The SCTE-35 data is returned in the JSON sidecar with the following combination of query parameter values:
  • ptcueformat=turner | elemental | nfl | DPIScte35
  • pttrackingversion=v2
  • scteTracking=true
vetargetmultiplier
The number of segments from the live point The pre-roll offset is configured using: ( vetargetmultiplier * targetduration ) + vebufferlength
Note : Live/Linear only
No (default: 3.0 )
Float
vebufferLength
The number of seconds from the live point Note: Live/Linear only
No (default: 3.0 )
Float