AGF Metadata Convention: Difference between revisions
From Engineering Client Portal
MichelFodjo (talk | contribs) |
MichelFodjo (talk | contribs) |
||
(4 intermediate revisions by the same user not shown) | |||
Line 11: | Line 11: | ||
== Static Measurement == | == Static Measurement == | ||
<blockquote>'''AppSDK version >= 9.1.0.0 is required''': <pre style="color: red"> | |||
The newly introduced AppSDK API staticEnd() is required for the Static Measurement. | |||
The staticEnd() API is available only for AppSDK version 9.1.0.0 or higher </pre> | |||
</blockquote> | |||
{| class="wikitable" | {| class="wikitable" | ||
Line 22: | Line 26: | ||
| section || section of each site (e.g. section value should be first level in page URL: website.com/section) || custom (no [[Special Characters]]) || ✓ || Section of Website or App || "_rtl_portal_news" | | section || section of each site (e.g. section value should be first level in page URL: website.com/section) || custom (no [[Special Characters]]) || ✓ || Section of Website or App || "_rtl_portal_news" | ||
|- | |- | ||
| segA || custom segment for reporting: unique values across custom segments (segA + segB + segC) || custom || ✓ || AGOF code or comparable unit code || "dbrsowf_rtlnews" | | segA || custom segment for reporting: unique values across custom segments (segA + segB + segC) || custom || ✓ || AGOF code or comparable unit code. If the AGOF code is not available, set "Unknown" || "dbrsowf_rtlnews" | ||
|- | |- | ||
| segB || custom segment for reporting: unique values across custom segments (segA + segB + segC) || custom || ✓ || Value to define content view count vs. 'Werbetraeger' view count. For Content: "CPI" . For 'Werbetraeger': " | | segB || custom segment for reporting: unique values across custom segments (segA + segB + segC) || custom || ✓ || Value to define content view count vs. 'Werbetraeger' view count. For Content: "CPI" . For 'Werbetraeger': "WPI" || For Content: "CPI" . For 'Werbetraeger' after user interaction with the site and newly loaded Content: "WPI". | ||
|- | |- | ||
| segC || custom segment for reporting: unique values across custom segments (segA + segB + segC) || custom || || Program name || "IBES" | | segC || custom segment for reporting: unique values across custom segments (segA + segB + segC) || custom || || Program name || "IBES" | ||
Line 33: | Line 37: | ||
== Video Measurement == | == Video Measurement == | ||
Please refer to this AGF | Please refer to this AGF Metadata Document for Video: | ||
* '''[https://nielsendownloads.digitalengsdk.com/digital/220907_AGF+Custom+Variables+and+Metadata+DCR+SDK++v1.8_english.pdf Metadata and custom-Variables Document for Video (english version)]''' | |||
* '''[https://nielsendownloads.digitalengsdk.com/digital/220907_AGF+Custom+Variables+and+Metadata+DCR+SDK++v1.8_english.pdf Metadata and custom-Variables Document for Video (german version)]''' | |||
In order to avoid incorrect / implausible filling of individual metadata and custom-variables please refer to the following additional assistance: | |||
* '''[https://nielsendownloads-blue.digitalengsdk.com/digital/20240415%20guide%20metadata%20&%20custom%20variables%20-%20english.pdf Guide for metadata & custom variables (english version)]''' | |||
* '''[https://nielsendownloads-blue.digitalengsdk.com/digital/20240415%20guide%20metadata%20&%20custom%20variables%20-%20deutsch.pdf Guide for metadata & custom variables (german version)]''' |
Latest revision as of 09:16, 6 May 2024
Engineering Portal Digital AGF Implementation Documentation AGF Metadata Convention
AGF Metadata Convention
The Metadata can pass through key values using the Nielsen reserved keys. The keys and values are listed by the product below.
Note: All metadata values should be passed as UTF-8 strings.
Static Measurement
AppSDK version >= 9.1.0.0 is required:
The newly introduced AppSDK API staticEnd() is required for the Static Measurement. The staticEnd() API is available only for AppSDK version 9.1.0.0 or higher
Key | Description | Values | Required (Obligatory) | AGF Convention | Example data - RTL |
---|---|---|---|---|---|
type | type of asset | "static" |
✓ | hardcoded string required by Nielsen | "static"
|
assetid | unique ID assigned to each article/page; only characters 0-9, a-z, A-Z underscore and minus are allowed - no special characters or vowel mutations) | custom (no Special Characters) | ✓ | Content Article ID. If it is not an article page and therefore no ID is available, the page path is used. | "999452" |
section | section of each site (e.g. section value should be first level in page URL: website.com/section) | custom (no Special Characters) | ✓ | Section of Website or App | "_rtl_portal_news" |
segA | custom segment for reporting: unique values across custom segments (segA + segB + segC) | custom | ✓ | AGOF code or comparable unit code. If the AGOF code is not available, set "Unknown" | "dbrsowf_rtlnews" |
segB | custom segment for reporting: unique values across custom segments (segA + segB + segC) | custom | ✓ | Value to define content view count vs. 'Werbetraeger' view count. For Content: "CPI" . For 'Werbetraeger': "WPI" | For Content: "CPI" . For 'Werbetraeger' after user interaction with the site and newly loaded Content: "WPI". |
segC | custom segment for reporting: unique values across custom segments (segA + segB + segC) | custom | Program name | "IBES" | |
subbrand | vcid/sub-brand ID – value is automatically populated through provided App ID. In order to override the sub-brand configured to the App ID, value can be passed here (e.g. multiple sub-brands in App) | provided by Nielsen | ✓ | Same as video measurement, provided by Nielsen | "c01" |
Video Measurement
Please refer to this AGF Metadata Document for Video:
- Metadata and custom-Variables Document for Video (english version)
- Metadata and custom-Variables Document for Video (german version)
In order to avoid incorrect / implausible filling of individual metadata and custom-variables please refer to the following additional assistance: