Difference between revisions of "iOS SDK Release Notes"

From Engineering Client Portal

Line 2: Line 2:
 
[[Category:Digital]]
 
[[Category:Digital]]
  
== Release 5.1.1.29 ==
+
== Release 6.0.0.2 (1-18-2018) ==
 +
=== DCR and DTVR Products Only ===
 +
*'''Vizu Library Changes:''' AppSDK requires a code change to fix a critical bug pertaining to Viewability as requested by Vizu(VI) library team. AppSDK will subscribe to VI JS event VIExternalDataReady, which will ensure VI library is ready to provide the time series data.
 +
*'''Static Ping Upload Failure:''' Issue occurs during 2 SDK instances. If instance 1 is destroyed and the second instance is still active, broadcast notification is sent to cancel all the pending requests and the session object is destroyed for both. Fix applied to isolate this notification for the destroyed instance only so it will not impact the other instance.
 +
*'''SegA/B/C Fix:''' If empty values are provided for segA, segB, segC in the loadmetadata call, then SDK will use the default values from the config.
 +
*'''DTVR Fix:''' Issue was introduced in v6.0.0.1 where tsv value was getting reset to default after pause. Issue occurred after pause when "stop", "play" and "loadMetadata" methods are called and the tsv flag gets reset to the default value 99 until another tsv request is fired.
 +
 
 +
== Release 6.0.0.1 (12-14-2017) ==
 +
=== All Products ===
 +
The below updates apply to all products. They do not require code changes. Please check your product's implementation guide for detailed instructions on how to implement best measurement of your product.
 +
 
 +
*'''Appname Removal:''' Client will no longer need to pass Appname as part of SDK initialization because SDK will be retrieving the name from the application Info.plist file for iOS. Even if client continues to pass the Appname, SDK will ignore it.
 +
*'''Default Privacy Url:''' Return default US privacy url instead of “nil” or blank string for userOptOutURLString.
 +
*'''Event Data Reporting:''' Sending event data in milliseconds compared to seconds for more granular reporting.
 +
*'''Minor Playhead Error:''' SDK will no longer send view ping if the first playhead position is 0 and if the playhead position is not incrementing. SDK will check if the playhead position will increment from 0 and then only send the view ping.
 +
*'''Session Id Change:''' Updated the Session id format to align the AppSDK with the DAR/Browser SDK logic which generates 39 chars sessionid/uaid.
 +
 
 +
=== DCR and DTVR ===
 +
Affected content types are DCR and DTVR.
 +
 
 +
*'''Viewability:''' Viewability is as an online tracking mechanism introduced in Nielsen SDK for representing the visibility of a video in the player along a playback that are actually viewed by the customers.
 +
*'''Simplified SDK API:''' This will allow clients to have a simple interface to pass metadata to the sdk and reduce the number of api calls. This feature will currently be available for AppSDK only. New API (trackEvent) is introduced to simplify SDK integration for clients. New API will be implemented as a wrapper for the existing SDK API. Clients will be able to use either new or old SDK API.
 +
*'''Bug Fix For DTVR:''' Fix for DTVR short ping having at parameter as “timer” instead of “sfview” during channel change scenario.  iOS fix for 1 trans ping per ID3 tag.
 +
*'''Stop Event Requirement Change:''' ST event will be reported at the end of the content, on End API call regardless of playhead position and channel change.
 +
 
 +
== Release 5.1.1.29 (7-31-2017) ==
 
*Genre parameter will be a part of DCR pings and the value will be reflected as part of c44 parameter.
 
*Genre parameter will be a part of DCR pings and the value will be reflected as part of c44 parameter.
 
*Merged adModel and adLoadType flags
 
*Merged adModel and adLoadType flags
 
*Fix for stop event data carried to next session’s duration ping
 
*Fix for stop event data carried to next session’s duration ping
  
== Release 5.1.1.25 ==
+
== Release 5.1.1.25 (5-31-2017) ==
 
*Enhanced support for Digital Audio
 
*Enhanced support for Digital Audio
 
*Ability to pass adloadtype as “linear” or “dynamic”
 
*Ability to pass adloadtype as “linear” or “dynamic”
Line 19: Line 44:
 
*Fix for App crash when multiple threads are accessing the SQLite
 
*Fix for App crash when multiple threads are accessing the SQLite
  
== Release 5.1.1.23 ==
+
== Release 5.1.1.23 (5-5-2017) ==
 
*Ability to pass adloadtype as “linear” or “dynamic”
 
*Ability to pass adloadtype as “linear” or “dynamic”
 
*Ability to detect end of content and static material through duration pings
 
*Ability to detect end of content and static material through duration pings
Line 30: Line 55:
 
*Fix for App crash when multiple threads are accessing the SQLite
 
*Fix for App crash when multiple threads are accessing the SQLite
  
== Release 5.1.1.19 ==
+
== Release 5.1.1.19 (4-3-2017) ==
 
*Fix for muting background music apps
 
*Fix for muting background music apps
  
== Release 5.1.1.18 ==
+
== Release 5.1.1.18 (2-3-2017) ==
 
*Minor bug fixes and performance improvement
 
*Minor bug fixes and performance improvement
  
== Release 5.1.1.17 ==
+
== Release 5.1.1.17 (1-23-2017) ==
 
*Added “seconds” place to the launch ping
 
*Added “seconds” place to the launch ping
 
*Ability to opt-out using “Limit Ad Tracking” feature
 
*Ability to opt-out using “Limit Ad Tracking” feature
Line 42: Line 67:
 
*Opt-Out pages can be served based on user’s language and locale from device
 
*Opt-Out pages can be served based on user’s language and locale from device
  
== Release 5.1.1.12 ==
+
== Release 5.1.1.12 (12-14-2016) ==
 
*Support for Nielsen TV Brand Effect
 
*Support for Nielsen TV Brand Effect
 
*Ability to set CMS parameters at a more global level
 
*Ability to set CMS parameters at a more global level
Line 52: Line 77:
 
*Limit the duration reported for App launch
 
*Limit the duration reported for App launch
  
== Release 5.1.1.9 ==
+
== Release 5.1.1.9 (10-18-2016) ==
 
*Fixed Linker error duplicate symbols for Reachability notification in iOS.
 
*Fixed Linker error duplicate symbols for Reachability notification in iOS.
  
== Release 5.1.1.7 ==
+
== Release 5.1.1.7 (9-13-2016) ==
 
*Support for iOS 10
 
*Support for iOS 10
 
*Usage of stop API call is made optional when switching between content or advertising occurs.
 
*Usage of stop API call is made optional when switching between content or advertising occurs.
 
*General bug fix and performance improvements
 
*General bug fix and performance improvements
  
== Release 5.1.1.5 ==
+
== Release 5.1.1.5 (7-12-2016) ==
 
*Sending event level (button press data) data to census collections.
 
*Sending event level (button press data) data to census collections.
 
*Support for Pause timeout (from 30 minutes to 5 minutes)
 
*Support for Pause timeout (from 30 minutes to 5 minutes)
Line 67: Line 92:
 
*General bug fix and performance improvements
 
*General bug fix and performance improvements
  
== Release 5.1.0.5 ==
+
== Release 5.1.0.5 (4-25-2016) ==
 
*Combined SDK for DCR US and International (Germany)
 
*Combined SDK for DCR US and International (Germany)
 
*API to signal end of content (end API)
 
*API to signal end of content (end API)
Line 82: Line 107:
 
*Introduced new API updateOTT to report current OTT status.
 
*Introduced new API updateOTT to report current OTT status.
  
== Release 4.0.0.8 ==
+
== Release 4.0.0.8 (6-9-2015) ==
 
*Support for Nielsen DCR product (Digital Content Ratings)
 
*Support for Nielsen DCR product (Digital Content Ratings)
 
**All the products should be migrated to the latest SDK.
 
**All the products should be migrated to the latest SDK.
Line 92: Line 117:
 
*Support for iOS 9 and iOS 9 PIP mode
 
*Support for iOS 9 and iOS 9 PIP mode
 
*General bug fix and performance improvements
 
*General bug fix and performance improvements
 +
 +
== Release 3.2.4.26 (1-10-2015) ==

Revision as of 20:01, 25 January 2018

Engineering Portal breadcrumbArrow.png Digital breadcrumbArrow.png iOS SDK Release Notes

Release 6.0.0.2 (1-18-2018)

DCR and DTVR Products Only

  • Vizu Library Changes: AppSDK requires a code change to fix a critical bug pertaining to Viewability as requested by Vizu(VI) library team. AppSDK will subscribe to VI JS event VIExternalDataReady, which will ensure VI library is ready to provide the time series data.
  • Static Ping Upload Failure: Issue occurs during 2 SDK instances. If instance 1 is destroyed and the second instance is still active, broadcast notification is sent to cancel all the pending requests and the session object is destroyed for both. Fix applied to isolate this notification for the destroyed instance only so it will not impact the other instance.
  • SegA/B/C Fix: If empty values are provided for segA, segB, segC in the loadmetadata call, then SDK will use the default values from the config.
  • DTVR Fix: Issue was introduced in v6.0.0.1 where tsv value was getting reset to default after pause. Issue occurred after pause when "stop", "play" and "loadMetadata" methods are called and the tsv flag gets reset to the default value 99 until another tsv request is fired.

Release 6.0.0.1 (12-14-2017)

All Products

The below updates apply to all products. They do not require code changes. Please check your product's implementation guide for detailed instructions on how to implement best measurement of your product.

  • Appname Removal: Client will no longer need to pass Appname as part of SDK initialization because SDK will be retrieving the name from the application Info.plist file for iOS. Even if client continues to pass the Appname, SDK will ignore it.
  • Default Privacy Url: Return default US privacy url instead of “nil” or blank string for userOptOutURLString.
  • Event Data Reporting: Sending event data in milliseconds compared to seconds for more granular reporting.
  • Minor Playhead Error: SDK will no longer send view ping if the first playhead position is 0 and if the playhead position is not incrementing. SDK will check if the playhead position will increment from 0 and then only send the view ping.
  • Session Id Change: Updated the Session id format to align the AppSDK with the DAR/Browser SDK logic which generates 39 chars sessionid/uaid.

DCR and DTVR

Affected content types are DCR and DTVR.

  • Viewability: Viewability is as an online tracking mechanism introduced in Nielsen SDK for representing the visibility of a video in the player along a playback that are actually viewed by the customers.
  • Simplified SDK API: This will allow clients to have a simple interface to pass metadata to the sdk and reduce the number of api calls. This feature will currently be available for AppSDK only. New API (trackEvent) is introduced to simplify SDK integration for clients. New API will be implemented as a wrapper for the existing SDK API. Clients will be able to use either new or old SDK API.
  • Bug Fix For DTVR: Fix for DTVR short ping having at parameter as “timer” instead of “sfview” during channel change scenario. iOS fix for 1 trans ping per ID3 tag.
  • Stop Event Requirement Change: ST event will be reported at the end of the content, on End API call regardless of playhead position and channel change.

Release 5.1.1.29 (7-31-2017)

  • Genre parameter will be a part of DCR pings and the value will be reflected as part of c44 parameter.
  • Merged adModel and adLoadType flags
  • Fix for stop event data carried to next session’s duration ping

Release 5.1.1.25 (5-31-2017)

  • Enhanced support for Digital Audio
  • Ability to pass adloadtype as “linear” or “dynamic”
  • Ability to detect end of content and static material through duration pings
  • Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
  • Acceptance of case-insensitive JSON key values
  • Configurable feature to show Ad view counts in the duration pings
  • Automatic Pause Detection and Debug build detection
  • Change of default ‘type’ from “ad” to “content”
  • Removal of “Static” Launch Ping for Non-Static product implementations
  • Fix for App crash when multiple threads are accessing the SQLite

Release 5.1.1.23 (5-5-2017)

  • Ability to pass adloadtype as “linear” or “dynamic”
  • Ability to detect end of content and static material through duration pings
  • Acceptance of empty parameters with a warning message triggered, if a required parameter is missing
  • Acceptance of case-insensitive JSON key values
  • Configurable feature to show Ad view counts in the duration pings
  • Automatic Pause Detection and Debug build detection
  • Change of default ‘type’ from “ad” to “content”
  • Removal of “Static” Launch Ping for Non-Static product implementations
  • Fix for App crash when multiple threads are accessing the SQLite

Release 5.1.1.19 (4-3-2017)

  • Fix for muting background music apps

Release 5.1.1.18 (2-3-2017)

  • Minor bug fixes and performance improvement

Release 5.1.1.17 (1-23-2017)

  • Added “seconds” place to the launch ping
  • Ability to opt-out using “Limit Ad Tracking” feature
  • Improved CPU Performance while apps are running in background
  • Opt-Out pages can be served based on user’s language and locale from device

Release 5.1.1.12 (12-14-2016)

  • Support for Nielsen TV Brand Effect
  • Ability to set CMS parameters at a more global level
  • Opt-out pages based on locale and country
  • Opt-out policy based on the ‘Limit Ad Tracking’ flag
  • Collection of additional device information
  • Issue a warning in client developer’s console when ad is played for more than 5 minutes
  • Removed the requirement for “type” parameter
  • Limit the duration reported for App launch

Release 5.1.1.9 (10-18-2016)

  • Fixed Linker error duplicate symbols for Reachability notification in iOS.

Release 5.1.1.7 (9-13-2016)

  • Support for iOS 10
  • Usage of stop API call is made optional when switching between content or advertising occurs.
  • General bug fix and performance improvements

Release 5.1.1.5 (7-12-2016)

  • Sending event level (button press data) data to census collections.
  • Support for Pause timeout (from 30 minutes to 5 minutes)
  • Changes in OTT when switching from mobile to Chromecast
  • Self-error Reporting for iOS SDK
  • General bug fix and performance improvements

Release 5.1.0.5 (4-25-2016)

  • Combined SDK for DCR US and International (Germany)
  • API to signal end of content (end API)
  • Changes to use of stop API
  • Support for OTT measurement
  • Support for Pause timeout
  • Offline viewing
  • Updated API to support JSON object instead of string.
  • Reporting of media URL and bundle ID
  • Updated ping retry logic
  • Changes in OptOut process behavioral
  • Enhanced Debugging and SDK logging
  • Changes to API signature
  • Introduced new API updateOTT to report current OTT status.

Release 4.0.0.8 (6-9-2015)

  • Support for Nielsen DCR product (Digital Content Ratings)
    • All the products should be migrated to the latest SDK.
    • This SDK distribution does not have a native library component or shared object.
  • Support for Nielsen App static measurement
  • Support for Ad measurement
  • Removal of Native C++ code
  • Removed singleton restriction
  • Support for iOS 9 and iOS 9 PIP mode
  • General bug fix and performance improvements

Release 3.2.4.26 (1-10-2015)