NickParrucci: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|iOS SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:iOS SDK API Reference Viewability support..."

2022-10-05T20:50:22Z

Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|iOS SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:iOS SDK API Reference Viewability support..."

New page

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|iOS SDK API Reference}} {{CurrentBreadcrumb}}
[[Category:Digital]]
[[Category:iOS SDK API Reference]]

Viewability support requires additional parameters to be provided from player applications to the SDK. In order to provide those parameters and to start the viewability measurement <code>trackViewability</code> method is added to the public SDK API.

== Syntax ==
<br/>
'''Objective C'''
<syntaxhighlight lang="objective-c">
- (void)trackViewability:(nonnull NSDictionary *)data;
</syntaxhighlight>
<br/>
'''Swift'''
<syntaxhighlight lang="swift">
func trackViewability(_ data: [String : Any])
</syntaxhighlight>

== Calling trackViewability for player view ==
<br>
'''Objective C'''
<syntaxhighlight lang="objective-c">
NSString *targetViewTag = targetView.tag;
NSString *controlsViewTag = controlsViewTag.tag;
NSString *activityIndicatorViewTag = activityIndicatorView.tag;
NSDictionary *viewabilityData = @{@"viewTag": targetViewTag,
@"viewContainer": targetView.window,
@"friendlyObstructions": @[controlsViewTag, activityIndicatorViewTag]};
[sdkInstance trackViewability:viewabilityData];
</syntaxhighlight>

'''Swift'''
<syntaxhighlight lang="swift">
let targetViewTag = targetView.tag
let controlsViewTag = controlsViewTag.tag
let activityIndicatorViewTag = activityIndicatorView.tag
let viewabilityData: [String:Any] = ["viewTag": "\(targetViewTag)",
"viewContainer": targetView.window!,
"friendlyObstructions": ["\(controlsViewTag)", "\(activityIndicatorViewTag)"]]
sdkInstance.trackViewability(viewabilityData)
</syntaxhighlight>

== Input Parameters ==
{| class="wikitable"
|-
! Parameter !! Description
|-
| data || NSDictionary object with the following objects and keys:
{| class="wikitable"
|-
| viewTag (mandatory) || value of NSNumber type, unique identifier (tag) for the target view object. This tag can be assigned for the player view either programmatically or in the storyboard/xib.
|-
| viewContainer (mandatory) || pointer to the parent view object. It is needed to identify the concrete scene in the applications which support multiple scenes. This parameter can not be nil.
|-
| friendlyObstructions (nullable) || an array of tags of the views which should be ignored during the intersection ratio calculation. Those are views like loading activity indicator, player controls, view with a watermark, etc. which are displayed in front of the target view, but should not reduce the viewability intersection ratio. The tags of such should be wrapped into the NSNumber objects before adding into the array. This parameter is nullable, empty array is also accepted.
|}
|}
[[File:PlayerView FirendlyView(Timer & Slider).png|300px]]

== Output Parameters ==
{| class="wikitable"
|-
! Output Parameters (Return value) !! Description
|-
| Void ||
|}

== Notes ==
If incorrect view tag is provided, SDK will not be able to measure viewability metrics. Viewability engine tries to find a view for the provided tag during 15 seconds and if it is not found it goes to inactive state. In order to restart the viewability engine it is required to call trackViewability with a proper tag again.

trackViewability - Revision history

NickParrucci: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|iOS SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:iOS SDK API Reference Viewability support..."