Appendix: Events and Page-Module Relationships

This appendix provides you with:

  • the supported types of event beacons, including image and video tracking

  • a list of beacon url mnemonics available from the gateway response JSON schema

  • the instrumentation key-value pairs, described in a table

  • a diagram (shown below) illustrating the relationship between Recommends events and a page or module

events page module

Image Tracking

The following events are supported for tracking beacons from image creatives:

Field or Event

Description

viewability *.templateUrl *.c` *.d *.p

Viewability template url and parameters.

templateUrl: Demand provider url with parameters below. c: Consecutive time in view required? (0=no, 1=yes). d: Minimum duration in view in seconds. p: Minimum rendered area in view percentage (0-100).

imprTrackingUrls

Impression tracking URLs for the demand provider or advertiser.

Fired after 50% or more of the creative is in view for 1s.

feedbackUrl

Recommendation feedback URL.

render

Beacon fired when ad is rendered, but not necessarily visible.

view

Beacon fired when viewability rules are satisfied.

click

Beacon fired when an ad is clicked.

hover

Beacon fired on mouse-over ad.

context

Beacon fired when the context menu is invoked over ad.

Video Tracking

The following events are supported for tracking beacons from video creatives.

The list of video tracking events closely follows the VAST v3 specificaton (https://www.iab.com/wp-content/uploads/2015/06/VASTv3_0.pdf) and the IAB digital video in-stream ad metric definitions (https://www.iab.com/wp-content/uploads/2015/08/DigitalVideo_MetricsDefinitions.pdf). Note that both of these documents consider viewability to be out-of-scope.

Field or Event

Description

viewability *.templateUrl *.a *.c` *.d *.p *.t

Viewability template url and parameters.

templateUrl: Demand provider url with parameters below. a: Audio required to be ON? (0=no, 1=yes) c: Consecutive time in view required? (0=no, 1=yes). d: Minimum duration in view in seconds. p: Minimum rendered area in view percentage (0-100). t: Viewability type (1=IAB video, 2=GroupM video, 3=GroupM static, 21=Moat).

imprTrackingUrls

Impression tracking URLs for the demand provider or advertiser.

Fired after 50% or more of the creative is in view for 1s.

start

This event is used to indicate that an individual creative within the ad was loaded and playback began.

firstQuartile

The creative played for at least 25% of the total duration.

midpoint

The creative played for at least 50% of the total duration.

thirdQuartile

The creative played for at least 75% of the total duration.

complete

The creative was played to the end at normal speed.

pause

The user clicked the pause control and stopped the creative.

resume

The user activated the resume control after the creative had been stopped or paused.

acceptInvitation

The user activated a control that launched an additional portion of the creative.

feedbackUrl

Recommendation feedback URL.

List of Beacon Url Mnemonics

The list of beacon url mnemonics is shown in the table below:

Mnemonic

Description

CLICK_INTERNAL

Use this mnemonic when interacting with some object of an ad (e.g. click out from tile, click out from mail ad message view, rotating/swiping/dragging an AR object, etc).

IMPR_INTERNAL

Use this mnemonic when viewing some object of an ad (e.g. carousel slot in view, tile slot in view, mail ad in message view, touchpoint modal in view, etc).

PARTIAL_VIEW

Impression beacon fires when 1% of sponsored ad container comes into view.

STATIC_CLICK_3P

Beacon fires when an ad is clicked.

STATIC_CONTEXT_3P

Beacon fired when the context menu is invoked over ad.

STATIC_HOVER_3P

Beacon fired on mouse over ad.

STATIC_RENDER_3P

Beacon fired when ad is rendered, but not necessarily visible.

STATIC_VIEW_3P

Beacon fires when an ad is clicked.

VIDEO_30_SEC

The creative played for at least 30 seconds.

VIDEO_ACCEPT_INVITATION

The user activated a control that launched an additional portion of the creative.

VIDEO_CLOSE

The creative was closed or collapsed.

VIDEO_FAILURE

The creative failed to load or play.

VIDEO_PAUSE

The user clicked the pause control and stopped the creative.

VIDEO_QUARTILE_100`

The creative was played to the end at normal speed.

VIDEO_QUARTILE_25`

The creative played for at least 25% of the total duration.

VIDEO_QUARTILE_50`

The creative played for at least 50% of the total duration.

VIDEO_QUARTILE_75

The creative played for at least 75% of the total duration.

VIDEO_RESUME

The user activated the resume control after the creative had been stopped or paused.

VIDEO_SKIP

This event is used to indicate the video was skipped prior to completion.

VIDEO_START

The video creative playback begins.

VIDEO_VIEW

Beacon fires after 3s of the video is played and the video player is in view.

VIDEO_VIEW_3P

Third-party beacon fires after 3s of the video is played and the video player is in view.

Instrumentation Key-Value Pairs

Key

Description

readmo

Flag to identify pages with the readmo module. true for pages with Recommends module or null otherwise.

sec

MAW section. Always set to readmo.

subsec

Recommends module id. Globally unique identifiers which are distinct from the Native Ad Platform section id.

slk

Content headline text.

itc

Link interactivity type. Always set to 0.

elm

Link element. Always set to hdln.

sp

1 for sponsored or null for site.

cpos

Numerical content position in list (left to right, top to bottom; starting from 1).

pos

Position of link within content tile. Always set to 1.

g

Content uuid for site or ad-id for sponsored.

pkgt

Package type. Always set to rectangle.

reqid

Request id. Recommennds gateway generated uuid used to join site and sponsored events from the same recommends client request.

tar

Destination domain. Always set to beap.gemini.yahoo.com for sponsored.

tar_uri

Path portion of destination uri. Always set to /mbclk for sponsored.

site

Publisher domain.

Example Instrumentation: page_info

{
  "A_sr": "1920x1080",
  "A_vr": "1920x1057",
  "A_tzoff": "-7",
  "A_ib": "0x0",
  "_upno": "",
  "_lib": "yjava_instrumentation 1.2.6",
  "A_ob": "0x0",
  "reqid": "583ee8fc-a7ab-4950-9733-e93ece9ccfaa",
  "A_sid": "bczmZB42v1nhrU8t",
  "_try": "",
  "_bt": "rapid",
  "_rc": "",
  "_batsz": "3233",
  "site": "huffpost.com",
  "A_srr": "2",
  "A_do": "1",
  "A_cn": "EVERGREEN-PROD",
  "action": "",
  "_guc": "AQEBAQFcwMFdpEIgOwTE&s=AQAAAIf48NK3&g=XL984Q",
  "A_cnf": "{\"spaceid\":\"1197803116\",\"tracked_mods_viewability\":[\"readmo-5602790\"],\"pageview_on_init\":false,\"dwell_on\":false,\"apv\":false}",
  "readmo": "true"
}

Example Instrumentation: view_info

[
 {
    "elm": "hdln",
    "g": "35020443062",
    "_l": "AqWAAIcT4ksKdhEwBptSD8psBmVH",
    "subsec": "5602790",
    "sec": "readmo",
    "_p": "5",
    "slk": "Not All Celebrities Live In Major Coastal CitiesSponsored · Lonny",
    "pos": "1",
    "A_lv": "1",
    "itc": "0",
    "pkgt": "rectangle",
    "sp": "1",
    "cpos": "6"
  },
  {
    "elm": "hdln",
    "g": "dc2857d8-7732-36d8-b32b-85325e36c2dd",
    "_l": "AllRohsfRiT1d64BcAmWMztsBmVH",
    "subsec": "5602790",
    "sec": "readmo",
    "_p": "6",
    "slk": "Former Uber Executive Indicted, Accused Of Stealing Trade Secrets HuffPost",
    "pos": "1",
    "A_lv": "1",
    "itc": "0",
    "pkgt": "rectangle",
    "sp": "0",
    "cpos": "7"
  },
]

Example Instrumentation: click_info

{
  "A_xy": "991,7729",
  "elm": "hdln",
  "g": "f75ad04e-f5f5-3e3d-aece-cbc0d9a7fd5e",
  "target_domain": "www.huffpost.com",
  "_l": "",
  "subsec": "5602790",
  "sec": "readmo",
  "_p": "15",
  "slk": "Trump Again Inflates Puerto Rico's Disaster Aid As Another Storm Nears HuffPost",
  "pos": "1",
  "A_lv": "1",
  "target_uri": "/entry/trump-puerto-rico-aid-another-storm_n_5d655dffe4b022fbceb1d3d8",
  "itc": "0",
  "pkgt": "rectangle",
  "sp": "0",
  "cpos": "16"
}