Content for TS 26.247 Word version: 18.4.0
14 Auxiliary metrics and reporting |R16| p. 99
14.1 General p. 99
Auxiliary metrics pertain to parameters known to the 3GP-DASH client other than QoE metrics as defined in clause 10, In this version of the specification, those metrics are specific to the measurement of service interactivity related usage/consumption, and their corresponding definition, reporting scheme and report protocol.
Interactivity usage reporting by the 3GP-DASH client is optional. However, a client which supports reporting of interactivity usage metrics shall do so in accordance to the metrics configuration and reporting mechanism as described in the sub-clauses of clause 14.2.
14.2 Interactivity Usage metrics and reporting p. 99
14.2.1 Introduction p. 99
This clause specifies the interactivity usage metrics that the DASH client, if capable and instructed to do so, shall report to a network-based report server. These metrics are conveyed by the MPD (via the MPD.Metrics.Reporting element) and the DASH client will use the DASH API as described in clause 14.3 to pass the metrics to the appropriate interactivity-capable application. Consequently, interactivity usage measurements performed by the application, in accordance to the metrics, are returned to the DASH client via the same API. The interactivity usage metric syntax is described in clause 14.2.2.1, and the detailed metric definitions are provided in clauses 14.2.2.2 and 14.2.2.3.
The reporting scheme is defined in clause 14.2.3, the metrics to be supported by 3GP-DASH clients supporting the interactivity usage metrics reporting feature are specified in clause 14.2.4, and the interactivity usage reporting protocol is defined in clause 14.2.5.
14.2.2 Interactivity Usage metric definitions p. 100
14.2.2.1 Introduction p. 100
This clause provides the interactivity usage metric definitions and measurement framework.
The semantics are defined using an abstract syntax. clause 14.2.5 provides a mapping to an XML schema. Items in this abstract syntax have one of the following primitive types (Integer, Real, Boolean, Enum, String) or one of the following compound types:
- Objects: an unordered sequence of (key, value) pairs, where the key always has string type and is unique within the sequence.
- List: an ordered list of items.
- Set: an unordered set of items.
14.2.2.2 Interactivity summary p. 100
The IntySummary element as shown in Table 14.2.2.2.1 summarizes the measurements of interactivity usage according to different metrics such as user consumption of rendered interactivity content or engagement with user interface (UI) functionality, such as viewing, clicking on or selection of hyperlinks, radio buttons, check boxes and other forms of UI displays or controls. Occurrences of opportunities for such user input may be pre-scheduled or unplanned during the playout of a main program. Examples of interactivity content include advertisements and auxiliary content accessible under user control during the occurrence of an interactivity event during a main program.
| Key | Type | Description | ||
|---|---|---|---|---|
| IntySummary | Object | Summarized information on interactivity usage associated with the set of interactivity events summarized by an interactivity usage report | ||
| Parameters | List | Collection of one or more parameters pertaining to interactivity usage | ||
| consumptionDuration | Integer | Total measured time duration in milliseconds of user consumption of rendered interactivity content (e.g., video or audio) | ||
| engagementInterval | Integer | Total measured time duration in milliseconds of user engagement with interactivity content via UI controls | ||
| clickthroughStart | List | List of start times, by media presentation time, of click-through actions associated with user access of interactivity-related resources offered by UI controls | ||
| PrivateExt | List | Container for proprietary or application-specific extensions on parameters to be included in the interactivity usage report | ||
14.2.2.3 Interactivity event list p. 101
The IntyEventList element as shown in Table 14.2.2.3.1 contains a time-ordered list of interactivity usage events and the details of the measured interactivity usage information during each event.
| Key | Type | Description | |||
|---|---|---|---|---|---|
| IntyEventList | List | A time-ordered list of interactivity events occurring during the playout of the main program, each containing detailed information on the incidences of interactivity usage during that event, as covered by an instance of the interactivity usage report. | |||
| Entry | Object | A record of a single interactivity event. | |||
| mStart | Media Time | The media presentation time at the start of the interactivity event. | |||
| mStop | Media Time | The media presentation time at the end of the interactivity event. | |||
| Rendering | List | A list of time intervals within the duration of an interactivity event during which the user consumes the rendered interactivity content (e.g., video or audio). | |||
| rStart | Media Time | The media presentation time at the start of interactivity content rendering resulting from, for example, the user's click of an embedded hyperlink, or engagement with UI controls, present in an advertisement that is initially displayed during an interactivity event. | |||
| rStop | Media Time | The media presentation time at the end of consumption of interactivity content as measured by the time of conclusion of that content, or when the user selects another interactivity content item for rendering, whichever occurs earlier. | |||
| Engagement | List | A list of time occurrences within the duration of an interactivity event at which the user engages with the interactivity content via UI controls. | |||
| eStart | Media Time | The media presentation time at the start of user engagement with interactivity content via UI controls via UI controls. | |||
| Clickthrough | List | A list of click-through actions performed by the user to access interactivity-related resources, as denoted by embedded hyperlinks in the interactivity content. | |||
| cStart | Media Time | The media presentation time at which user performs a click/selection. | |||
| PrivateExt | List | Container for proprietary or application-specific extensions on parameters to be included in this interactivity event entry. | |||
14.2.3 Interactivity usage reporting scheme p. 101
This clause specifies a 3GP-DASH interactivity usage reporting scheme.
The interactivity usage reporting scheme is signalled using the Reporting element in the Metrics element. The URN to be used for the Reporting@schemeIdUri shall be "urn:3GPP:ns:PSS:DASH:IU15".
The reporting scheme shall use the interactivity usage reporting protocol as defined in clause 14.2.5.
The semantics and XML syntax of the scheme information for the 3GP-DASH interactivity usage reporting scheme are specified in Table 14.2.3.1 and Table 14.2.3.2, respectively.
| Element or attribute name | Use | Description |
|---|---|---|
| @metrics | M | This attribute lists all interactivity usage metrics (as a list of interactivity metric keys as defined in clauses 14.2.2.2 and 14.2.2.3). |
| @apn | O | This attribute gives the access point that should be used for sending the interactivity usage reports. |
| @format | O | This field gives the requested format for the reports. Possible formats are: "uncompressed" and "gzip". |
| @samplepercentage | O | Percentage of the clients that should report interactivity usage. The client should use a random number generator and compare the generated output with the given percentage in determining whether to perform reporting. |
| @reportingserver | M | The reporting server URL to which the interactivity usage reports will be sent. |
| @reportTime | O | If present, is indication to the DASH client that each interactivity usage report by the DASH client should be accompanied by the wall-clock time at which the report is sent. |
| @reportinginterval | O | Indicates the time interval(s) between successive transmission of interactivity usage reports. If present, @reportingInterval=n indicates that the client should send a report every n-th second provided that new metrics information has become available since the previous report. |
| GroupID | 0..1 | A set of one or more identifiers, representing aliases associated with and known to the client devices, used to identify that/those device(s) which should perform interactivity usage reporting. Presence of this attribute and @samplePercentage should be mutually exclusive. |
|
Legend:
For attributes: M=Mandatory, O=Optional, OD=Optional with Default Value, CM=Conditionally Mandatory.
For elements: <minOccurs>…<maxOccurs> (N=unbounded)
Elements are bold; attributes are non-bold and preceded with an @
|
||
<?xml version="1.0"?> <xs:schema targetNamespace="urn:3GPP:ns:PSS:AdaptiveHTTPStreaming:2009:qm" attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http:// |
|---|
14.2.4 Interactivity metrics p. 103
The following metrics shall be supported by 3GP-DASH clients supporting the interactivity usage metrics reporting feature.
- Interactivity Usage Summary information (clause 14.2.2.2); and
- Interactivity Event List information (clause 14.2.2.3).
14.2.5 Interactivity Usage reporting protocol p. 103
14.2.5.1 General p. 103
The interactivity usage reporting protocol consists of:
- the XML-based report format defined in clause 14.2.5.2; and
- the reporting protocol defined in clause 14.2.5.3.
14.2.5.2 Report format p. 103
The interactivity usage report is formatted as an XML document that complies with the following XML schema:
<?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http:// |
|---|
14.2.5.3 Reporting protocol p. 104
In the MPD configuration, if a specific metrics server has been configured, the client shall send interactivity usage reports using the HTTP (RFC 2616) POST request carrying XML formatted metadata in its body. An example interactivity usage reporting based on HTTP POST request signalling is shown below:
POST http://www.exampleserver.com HTTP/1.1 Host: 192.68.1.1 User-Agent: Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.1; Trident/4.0) Content-Type: text/xml; charset=utf-8 Content-Length: 4408 <?xml version="1.0" encoding="UTF-8"?> <IntyUsageReport xmlns:xsi="http:// |
|---|
