About event firing conditions on IMA client-side

[pineapplevine1]

I would like to fire each event using only the IMA client-side.

Please answer the following two questions.

1. About events that only occur at IMA DAI

The following event is clearly stated in the iOS documentation that it only occurs in IMA DAI.

Although it is not specified in the Android documentation, does this not occur if only IMA client-side is used like iOS?

* AD_BREAK_ENDED

* AD_BREAK _STARTED

* AD_PERIOD_ENDED

* AD_PERIOD_STARTED

* CUEPOINTS_CHANGED

2. About events whose occurrence conditions are unknown

Could you please tell me the conditions under which the following events occur when using only IMA client-side?

If you have any information such as sample URLs and formats of ad tags that occur, please let us know.

【Android】: AD_BREAK_FETCH_ERROR, ICON_FALLBACK_IMAGE_CLOSED, ICON_TAPPED, LOG

【iOS】: kIMAAdEvent_AD_BREAK_FETCH_ERROR, kIMAAdEvent_ICON_FALLBACK_IMAGE_CLOSED, kIMAAdEvent_ICON_TAPPED, kIMAAdEvent_LOG

【HTML5】: VIDEO_ICON_CLICKED, LOG, USER_CLOSE, LINEAR_CHANGED, INTERACTION

Thenk you.

[IMA SDK]

Hi,

Thank you for contacting the IMA SDK support team.

Please find the responses to your queries below

1. Please note that the below events are only supported for IMA DAI SDK. 

• AD_BREAK_ENDED
• AD_BREAK _STARTED
• AD_PERIOD_ENDED
• AD_PERIOD_STARTED
• CUEPOINTS_CHANGED

2. The events will occur under these conditions.

• Android:

1. The AD_BREAK_FETCH_ERROR event is fired if an ad break will not play
2. The ICON_FALLBACK_IMAGE_CLOSED event is fired when the icon fallback image is closed on Android TV devices
3. The ICON_TAPPED event is fired when the user has tapped an ad icon. On Android mobile apps, the SDK will navigate to the landing page. On Connected TV devices, the SDK will present a modal dialog containing the VAST icon fallback image
4. The LOG event is fired to enable the SDK to communicate a message to be logged, which is stored in adData. This can be fired when a VPAID ad sends a LOG message, or in the event of a non-fatal playback error (for example, an ad in a pod cannot be played)
5. Please refer to ANDROID VAST TAG URL'S for Sample URL’s

• IOS:

1. The kIMAAdEvent_AD_BREAK_FETCH_ERROR event is fired if an ad break will not play
2. The  kIMAAdEvent_ICON_FALLBACK_IMAGE_CLOSED event is fired when the icon fallback image is closed.This event only fires for tvOS
3. The kIMAAdEvent_ ICON_TAPPED event is fired when the user has tapped an ad icon. On iOS, the SDK will navigate to the landing page. On tvOS, the SDK will present a modal dialog containing the VAST icon fallback image
4. The  kIMAAdEvent_LOG event is fired to log event for the ads being played. These are typically non fatal errors
5. Please refer to IOS VAST TAG URL'S for Sample URL’s

• HTML5:

1. The VIDEO_ICON_CLICKED event is fired when a user clicks a video icon
2. The LOG event is fired when a non-fatal error is encountered. The user need not take any action since the SDK will continue with the same or next ad playback depending on the error situation
3. The USER_CLOSE event is fired when the ad is closed by the user
4. The LINEAR_CHANGED event is fired when the displayed ad changes from linear to nonlinear, or the reverse
5. The INTERACTION event is fired when an ad triggers the interaction callback. Ad interactions contain an interaction ID string in the ad data
6. Please refer to HTML5 VAST TAG URL'S for Sample URL’s

Please let me know if you have any additional questions.

Thank you,
IMA SDK team

ref:_00D1U1174p._5004Q2pP2vD:ref

[pineapplevine1]

Hello Team,

Thanks for your response.
I tried to make an event call on the IMA client-side based on the reply, but could you please tell me what I was unable to do?


[HTML5]
1.AD_BREAK_FETCH_ERROR
Is this event only fired when autoPlayAdBreaks = false?
I used the posted ad sample mentioned in the past ticket, but IMA's VSI also failed to call the event.
Please let me know if you have any information on ad samples or related VAST elements that can call this event.

Ad sample used for confirmation: https://pubads.g.doubleclick.net/gampad/ads?sz=640x480&iu=/124319096/external/ad_rule_samples&ciu_szs=300x250&ad_rule=1&impl=s&gdfp_req=1&env=vp&output=vmap&unviewed_position_start=1& cust_params=deployment% 3Ddevsite%26sample_ar%3Dpremidpost&cmsid=496&vid=short_onecue&correlator=
Reference ticket: https://groups.google.com/g/ima-sdk/c/-u4WzAP9IyQ/m/e5kEBiAABQAJ

2.ICON_FALLBACK_IMAGE_CLOSED
Is the <IconClickFallbackImages> element necessary for this event to occur?
Please let me know if you have any ad samples that can call this event, information on related VAST elements, and information on the situations in which Icon fallback occurs.
Does the sample app need to control the behavior of closing the fallback image? Or can it be controlled with VAST ads only? What features do I need to control with an app?

3.USER_CLOSE
I used the ad sample listed in the past ticket, but IMA's VSI also failed to call the event.
Please let me know if you have any information on ad samples or related VAST elements that can call this event.
Also, does the sample app need to control the behavior when the close button is pressed? What features do you need in that case?

Advertisement sample used for confirmation:
https://pubads.g.doubleclick.net/gampad/ads?sz=640x480&iu=/124319096/external/single_ad_samples&ciu_szs=300x250&impl=s&gdfp_req=1&env=vp&output=vast&unviewed_position_start=1&cust_params=deployment%3 Ddevsite%26sample_ct%3Dnonlinearvpaid2js&correlator=
Reference ticket:
https://groups.google.com/g/ima-sdk/c/LE1v38HPBFw/m/3luld6fCBAAJ


4.LINEAR_CHANGED
Since a past ticket mentioned an event that could occur with VPAID, we used the advertising sample "Single VPAID 2.0 Non-Linear". However, LINEAR_CHANGED did not occur and DURATION_CHANGE occurred.
Please let me know if there is an ad URL that can call this event, information on related VAST elements, and any steps required to call the event.

Advertisement sample used for confirmation:
https://pubads.g.doubleclick.net/gampad/ads?iu=/21775744923/external/single_ad_samples&sz=640x480&cust_params=sample_ct%3Dnonlinearvpaid2js&ciu_szs=728x90%2C300x250&gdfp_req=1&output=vast& unviewed_position_start=1&env=vp&impl=s&correlator=

5.INTERACTION
I tested the ad sample "SIMID Survey Pre-roll" using the <InteractiveCreativeFile> element, but no event occurred.
Please let me know if you have any information about the advertising URL or related VAST element that can call this event.

Advertisement sample used for confirmation:
https://pubads.g.doubleclick.net/gampad/ads?iu=/21775744923/external/simid&description_url=https%3A%2F%2Fdevelopers.google.com%2Finteractive-media-ads&sz=640x480&gdfp_req=1&output=vast&unviewed_position_start=1&env =vp&impl=s&correlator=


[Android]
1.AD_BREAK_FETCH_ERROR
Is this event only fired when autoPlayAdBreaks = false?
Please let me know if you have any information on ad samples or related VAST elements that can call this event.

2.ICON_FALLBACK_IMAGE_CLOSED
Is the <IconClickFallbackImages> element necessary for this event to occur?
Please let me know if you have any ad samples that can call this event, information on related VAST elements, and information on the situations in which Icon fallback occurs.
Does the sample app need to control the behavior of closing the fallback image? Or can it be controlled with VAST ads only? What features do I need to control with an app?


[iOS]
1.AD_BREAK_FETCH_ERROR
Is this event only fired when autoPlayAdBreaks = false?
Please let me know if you have any information on ad samples or related VAST elements that can call this event.

2.ICON_FALLBACK_IMAGE_CLOSED
Is the <IconClickFallbackImages> element necessary for this event to occur?
Please let me know if you have any ad samples that can call this event, information on related VAST elements, and information on the situations in which Icon fallback occurs.
Does the sample app need to control the behavior of closing the fallback image? Or can it be controlled with VAST ads only? What features do I need to control with an app?

Thank you.

2023年10月5日木曜日 23:51:29 UTC+9 IMA SDK:

[IMA SDK]

Hi,

Thank you for getting back to us.

Please find the responses to your queries below

Android

1. AD_BREAK_FETCH_ERROR: Fired when an ad break will not play back any ads. Please refer to this document for more information about Adevents in Android.

2. ICON_FALLBACK_IMAGE_CLOSED: Yes, the element is necessary for this event to occur.This element is used to specify the fallback images that will be displayed when the user clicks on the ad icon.

Kindly refer to the Google sample Android application for more information regarding the events and when they are triggered. As the ICON_FALLBACK_IMAGE_CLOSED event is fired when the icon fallback image is closed on Android TV devices, it is necessary to add this event in the adsManager.addAdEventListener.

iOS

1. AD_BREAK_FETCH_ERROR: Ad break will not play back any ads. when kIMAAdEvent_AD_BREAK_FETCH_ERROR, = 1. Please refer to this document for more information about Adevents in Android.

2. ICON_FALLBACK_IMAGE_CLOSED: The user has closed the icon fallback image dialog. This may be a good time to resume ad playback, which the SDK auto pauses on icon tap. This event only fires for tvOS.

Kindly refer to the Google sample iOS application for more information on the events.

HTML5

1. AD_BREAK_FETCH_ERROR: Yes, the AD_BREAK_FETCH_ERROR event is only fired when autoPlayAdBreaks is set to false. This is because the IMA SDK will not attempt to fetch ads for ad breaks that are not set to autoplay.

2. ICON_FALLBACK_IMAGE_CLOSED: Yes, the <IconClickFallbackImages> element is necessary for the ICON_FALLBACK_IMAGE_CLOSED event to occur. This is because the icon fallback image is not displayed if the <IconClickFallbackImages> element is not present. If the icon fallback image is not displayed, then the user cannot click on it to close it, and therefore the ICON_FALLBACK_IMAGE_CLOSED event will not be fired.

Kindly refer to this document and release notes  and also refer to the Google sample Html5 application for more information about Adevents in Html5.

Please note that we are unable to open ad samples which you are provided.

This message is in relation to case "ref:!00D1U01174p.!5004Q02pP2vD:ref"

Thanks,
 

IMA SDK Team

[pineapplevine1]

Hello Team

Thanks for your response.
I tried to call an event on the IMA client side for HTML5 based on the reply, but there are some events that cannot be called. please tell me


1.How to call ICON_FALLBACK_IMAGE_CLOSED
Some of the IMASDK samples have <IconClickFallbackImages>element.
What changes need to be made to trigger the ICON_FALLBACK_IMAGE_CLOSED event for this ad?
And please let me know if there is an ad sample where this event calls.
　
　IMASDK advertising sample:
　https://pubads.g.doubleclick.net/gampad/ads?iu=/21775744923/external/single_ad_samples&sz=640x480&cust_params=sample_ct%3Dnonlinearvpaid2js&ciu_szs=728x90%2C300x250&gdfp_req=1&output=vast&unviewed_position_start=1&env=vp&impl=s&correlator=
　
　
2.How to call LINEAR_CHANGED
I tried to call an event using the ad sample "Single VPAID 2.0 Non-Linear", which switches between linear and non-linear ads, but it did not call.
Please let me know if there is an ad sample where this event calls.

　
　Advertisement sample used for confirmation:

　https://pubads.g.doubleclick.net/gampad/ads?iu=/21775744923/external/single_ad_samples&sz=640x480&cust_params=sample_ct%3Dnonlinearvpaid2js&ciu_szs=728x90%2C300x250&gdfp_req=1&output=vast&unviewed_position_start=1&env=vp&impl=s&correlator=
　
　
3.How to call INTERACTION
An attempt was made to call an event on an ad containing the <InteractiveCreativeFile> element, but it did not call.
Please let me know if there is an ad sample where this event calls.
　
　
4.Which tag or ad information is involved in causing USER_CLOSE in the ad below?

<VAST xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="vast.xsd" version="3.0">
  <Ad id="141108119229">
    <InLine>
      <AdSystem>AdSense</AdSystem>
      <AdTitle>image</AdTitle>
      <Creatives>
        <Creative id="157263478792" sequence="1">
        <NonLinearAds>
          <NonLinear width="300" height="250" minSuggestedDuration="00:00:00" scalable="false" maintainAspectRatio="false">
            <StaticResource creativeType="image/gif">
              <![CDATA[ ./non-linear.jpg ]]>
            </StaticResource>
          </NonLinear>
        </NonLinearAds>
        </Creative>
      </Creatives>
      <Extensions>
        <Extension type="waterfall" fallback_index="0"/>
        <Extension type="AdSense"> </Extension>
      </Extensions>
    </InLine>
  </Ad>
</VAST>

2023年11月16日木曜日 14:48:02 UTC+9 IMA SDK:

[IMA SDK]

Hi,

Thank you for getting back to us.

I will check with our team regarding your issue and one of my team members will reach out to you once we have an update on this. Meanwhile, your patience is highly appreciated 

[pineapplevine1]

Hello Team

Thanks for your response.

I feel very sorry to ask you this but I have additional questions regarding tvOS.
I tried to call an event on the IMA client side for tvOS based on the reply, but there are some events that cannot be called. please tell me.

1.kIMAAdEvent_CLICKED
iOS can be checked by tapping the "Details" button at the top right of the ad.
In the case of tvOS is it a tvOS specification that the "Details" button is not displayed in the upper right corner of ad?
If I want to check it on tvOS, how should I implement it?

Please let me know if you have any information about the advertising URL or related VAST element that can call this event.

2.kIMAAdEvent_ICON_TAPPED
iOS can be checked by tapping the ad.
In the case of tvOS, no event calls even if you tap the confirm button on the Apple TV remote control.
If I want to check it on tvOS, how should I implement it?

Please let me know if you have any information about the advertising URL or related VAST element that can call this event.

3.kIMAAdEvent_TAPPED
iOS can be checked by using the ad tag below and tapping the icon in the ad.
https://cdnzone.nuevodevel.com/pub/5.0/e-i-1/icon_sample_02.xml
In the case of tvOS, it is not possible to select and tap an icon.
If I want to check it on tvOS, how should I implement it?

Please let me know if you have any information about the advertising URL or related VAST element that can call this event.

4.kIMAAdEvent_ICON_FALLBACK_IMAGE_CLOSED
If I want to check it on tvOS, how should I implement it?

Please let me know if you have any information about the advertising URL or related VAST element that can call this event.

2023年12月13日水曜日 23:10:13 UTC+9 IMA SDK:

[IMA SDK]

Hi

Thanks for reaching out. 

It is important to note that tvOS differs from iOS in that tvOS is a browserless system with only remote input. This makes some standard iOS events meaningless on tvOS. Despite this, some of these events may still be enumerated, simply to allow the two SDKs to share common core components.

1. kIMAAdEvent_CLICKED - because tvOS is a browserless systeam, it has no concept of a "clickthrough", so the CLICKED event cannot be triggered under normal circumstances. The "learn more" button will not appear, because there is no way to open an external website in response to that interaction.
2. kIMAAdEvent_TAPPED - In your email, I think you may have switched your descriptions for TAPPED and ICON_TAPPED. The TAPPED icon normally would track interactions with the video player. I will double check with ENG, but I believe this event may also be non-functional on tvOS.
3. kIMAAdEvent_ICON_TAPPED - For an icon to be tappable on browserless systems like tvOS, it needs to contain an IconClickFallbackImage, as described in the VAST 4.2 spec, section 3.11.6.
4. kIMAAdEvent_ICON_FALLBACK_IMAGE_CLOSED - as with ICON_TAPPED, to trigger a fallback image closure your icon must contain an IconClickFallbackImage, which is not present in the sample ICON VAST that you linked.

Thanks,

Greg Schoppe
IMA SDK Team

ref:!00D1U01174p.!5004Q02pP2vD:ref