Digital Measurement Content Audit Beacon: Difference between revisions

From Engineering Client Portal
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Streaming Measurement}} {{CurrentBreadcrumb}}


The Nielsen server-to-server solution requires audit pings for the purpose of validating audience reach and video viewing duration; one start and one end for each video stream. Pings originate from the end-user device to Nielsen Collections servers. End pings execute upon cessation of playback.
The Nielsen server-to-server solution requires audit pings for the purpose of validating audience reach and video viewing duration; one start and one end for each video stream. Pings originate from the end-user device to Nielsen Collections servers. End pings execute upon cessation of playback.
Line 29: Line 29:
= Query Parameters =
= Query Parameters =
{| class="wikitable"
{| class="wikitable"
|'''Parameter'''
!'''Parameter'''
|'''Description'''
!'''Description'''
|'''Required'''
!'''Required'''
|'''Specified'''  
!'''Specified'''  
|'''Format / Example'''
!'''Format / Example'''
|-
|-
|apid
|apid
Line 39: Line 39:
|Yes
|Yes
|Nielsen
|Nielsen
|Example: A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|
Example: <code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
|-
|sessionid
|sessionid
Line 45: Line 46:
|Yes
|Yes
|Client
|Client
|Format: alphanumeric
|
 
Format: alphanumeric
Example: Random GUID: ce6c1c95-de3e-431e-b11e-77…
Example: Random GUID: <code>ce6c1c95-de3e-431e-b11e-77…</code>
|-
|-
|pingtype
|pingtype
|Indicator for ping type: “start” or “end” audit ping
|Indicator for ping type: "start" or "end" audit ping
|Yes
|Yes
|Client
|Client
|Format: integer,
|
 
Format: integer,
1 = Start Stream
*<code>1</code> = Start Stream
 
*<code>0</code> = Start Session
0 = Start Session
*<code>3</code> = End Stream
 
*<code>2</code> = End Session
3 = End Stream
 
2 = End Session
|-
|-
|product
|product
Line 67: Line 65:
|Yes
|Yes
|Client
|Client
|Format: alphanumeric,  
|
 
Format: alphanumeric,  
Example: dcr, dtvr, dar, ctv
Example: <code>dcr</code>, <code>dtvr</code>, <code>dar</code>, <code>ctv</code>
|-
|-
|uoo
|uoo
|User opt out flag for demographic measurement
|User opt out flag for demographic measurement
|Yes, if devid/LUID provided
|Yes, if devid/HHID provided
|Client
|Client
|Format: integer
|
 
Format: integer
0 = not opt-out, 1 = opt-out
*<code>0</code> = not opt-out
*<code>1</code> = opt-out
|-
|-
|devid
|devid
Line 83: Line 82:
|Optional, or in S2S file
|Optional, or in S2S file
|Client
|Client
|A487421B-XXXX-YYYY-8343-E3BBB66E44F2
|<code>A487421B-XXXX-YYYY-8343-E3BBB66E44F2</code>
|-
|-
|luid
|hhid
|Living Unit ID - Experian Household ID
|House Hold ID. Used as a primary match key to external data sources.
|Optional, or in S2S file
|Optional, or in S2S file.
|Client
|Client
|B0EOFEDgD
|<code>B0EOFEDgD</code>
|-
|-
|createtm
|createtm
Line 95: Line 94:
|Yes
|Yes
|Client
|Client
|Format: Unix timestamp in 32-bit unsigned int in seconds
|
 
Format: Unix timestamp in 32-bit unsigned int in seconds
Example: 1577858505
Example: <code>1577858505</code>
|}
|}
'''Audit Ping Start Example:'''
'''Audit Ping Start Example:'''
https://secure-audit.imrworldwide.com/cgi-bin/gn?prd=audit&apid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&streamid=3679422587354472&pingtype=0&product=ctv&uoo=1&createtm=1577858505&devid=4AB6FCE2-2848-4FA8-9BE3-46E206206AB
 
<code>https://secure-audit.imrworldwide.com/cgi-bin/gn?prd=audit&apid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&streamid=3679422587354472&pingtype=0&product=ctv&uoo=1&createtm=1577858505&devid=4AB6FCE2-2848-4FA8-9BE3-46E206206AB</code>
 
'''Audit Ping End Example:'''
 
<code>https://secure-audit.imrworldwide.com/cgi-bin/gn?prd=audit&apid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&streamid=3679422587354472&pingtype=2&product=ctv&uoo=1&createtm=1577859637</code>
[[Category:Digital]]
[[Category:Digital]]

Latest revision as of 03:37, 22 June 2024

Engineering Portal / Digital / Digital Streaming Measurement / Digital Measurement Content Audit Beacon

The Nielsen server-to-server solution requires audit pings for the purpose of validating audience reach and video viewing duration; one start and one end for each video stream. Pings originate from the end-user device to Nielsen Collections servers. End pings execute upon cessation of playback.

Ping Structure

Ping is executed with following convention:

https://[to_be_provided].imrworldwide.com/cgi-bin/gn?prd=audit&+[query parameters]

The Start Audit Ping carries all parameters in the table below. The End Audit Ping carries a subset of the parameters in the matrix below as denoted in the mandatory column.  

Under normal operating circumstances, the audit ping server returns the following codes:

  • Audit ping servers reject cross-origin HTTP requests with preflight. To ensure that audit ping requests are accepted, allowable Content-Types like "text/plain" in simple GET requests ensure that preflight requests are not invoked
  • 200: Ping successfully received, inspect traffic to ensure no CORS errors

Session & Stream

  1. Sessions
    1. Optionally, a new Session ID may be created when a new player is created
    2. If more than one video player exists within the same App (e.g. picture in picture) a different Session ID is required for each
  2. Streams
    1. New Stream ID is generated for each new video stream.
    2. If stream playback continues after 24 hours, then a new Stream ID should be created and a new Audit ping should be executed (Session ID may remain)
    3. Stream ID remains the same independent of fast-forward, rewind, pause, events assuming the asset remains the same
    4. If playback is suspended for greater than 30mins (paused or otherwise suspended), a new Stream ID should be assigned upon return
    5. Audit pings should be fired at the beginning and end of a stream

Query Parameters

Parameter Description Required Specified Format / Example
apid Server App ID assigned by Nielsen Yes Nielsen

Example: A487421B-XXXX-YYYY-8343-E3BBB66E44F2

sessionid Unique, client generated value that represents the start of a user session. “Session” is defined as continuous (flexible) interaction with an application that may span multiple streams. Yes Client

Format: alphanumeric Example: Random GUID: ce6c1c95-de3e-431e-b11e-77…

pingtype Indicator for ping type: "start" or "end" audit ping Yes Client

Format: integer,

  • 1 = Start Stream
  • 0 = Start Session
  • 3 = End Stream
  • 2 = End Session
product Indicates which product audit ping corresponds to Yes Client

Format: alphanumeric, Example: dcr, dtvr, dar, ctv

uoo User opt out flag for demographic measurement Yes, if devid/HHID provided Client

Format: integer

  • 0 = not opt-out
  • 1 = opt-out
devid Mobile Ad ID (IDFA, ADID), Connected Device ID Optional, or in S2S file Client A487421B-XXXX-YYYY-8343-E3BBB66E44F2
hhid House Hold ID. Used as a primary match key to external data sources. Optional, or in S2S file. Client B0EOFEDgD
createtm Time ping is initiated Yes Client

Format: Unix timestamp in 32-bit unsigned int in seconds Example: 1577858505

Audit Ping Start Example:

https://secure-audit.imrworldwide.com/cgi-bin/gn?prd=audit&apid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&streamid=3679422587354472&pingtype=0&product=ctv&uoo=1&createtm=1577858505&devid=4AB6FCE2-2848-4FA8-9BE3-46E206206AB

Audit Ping End Example:

https://secure-audit.imrworldwide.com/cgi-bin/gn?prd=audit&apid=FC984EC1-E044-B465-E040-070AAD3173A1&sessionid=2576459933726989&streamid=3679422587354472&pingtype=2&product=ctv&uoo=1&createtm=1577859637

Retrieved from "https://engineeringportal.nielsen.com/w/index.php?title=Digital_Measurement_Content_Audit_Beacon&oldid=6795"