[IMA SDK HTML5] Cannt get ad slot id and companion ad click tracking information.

200 views
Skip to first unread message

森本幸紘

unread,
Apr 8, 2022, 8:51:09 AM4/8/22
to Interactive Media Ads SDK
Hi,

The following VAST companion elements cannot get ad slot id and companion ad click tracking information from the CompanionAd class.

<Companion id="0" width="320" height="50" adSlotId="slotid">
  <StaticResource creativeType="image/png"><![CDATA[https://hoge/fuga/resource.png]]></StaticResource>
  <CompanionClickThrough><![CDATA[https://page]]></CompanionClickThrough>
  <CompanionClickTracking><![CDATA[https://track?event=CompanionClickTracking]]></CompanionClickTracking>
  <AltText></AltText>
  <AdParameters></AdParameters>
  <TrackingEvents>
    <Tracking event="creativeView"><![CDATA[https://track?event=creativeView]]></Tracking>
  </TrackingEvents>
</Companion>

The CompanionAd class is obtained by executing the following API on the STARTED event.

let setting = new google.ima.CompanionAdSelectionSettings();
setting.resourceType = google.ima.CompanionAdSelectionSettings.ResourceType.ALL;
setting.creativeType = google.ima.CompanionAdSelectionSettings.CreativeType.IMAGE;
setting.sizeCriteria = google.ima.CompanionAdSelectionSettings.SizeCriteria.IGNORE;
let companionAds = ad.getCompanionAds(0, 0, setting);

The following results are returned when trying to get ad slot id and companion ad click tracking information.

getAdSlotId:

null

getContent:

<a target="_blank" id="0" href="https://page">
  <div class="overlayContainer">
    <img src="https://hoge/fuga/resource.png" height="50" width="320">
    <div class="overlayTextAttribution"></div>
  </div>
  <iframe frameborder="0" src="https://track?event=creativeView" height="0" width="0"></iframe>
</a>

Is there a way to get ad slot id and companion ad click tracking information?

Thanks.

IMA SDK

unread,
Apr 11, 2022, 10:51:21 AM4/11/22
to yukihiro...@play.jp, ima...@googlegroups.com
Hello,

It appears that your concern is more on creative rather than anything specific to the code implementation of the IMA SDK. With this, we would recommend reaching out to your ad provider instead for further assistance.

Regards,
Google Logo
Teejay Wennie
IMA SDK Team
 


ref:_00D1U1174p._5004Q2ZL6vn:ref

森本幸紘

unread,
Apr 13, 2022, 2:28:57 AM4/13/22
to Interactive Media Ads SDK
Hi,

I’m sorry. That came out wrong.
I am asking because there was no IMA SDK API to get the URL of the CompanionClickTracking element written in the VAST.
Is there a way to get the URL of the CompanionClickTracking element?
Also, if there is no way, could you add an API?

Thanks.

2022年4月11日月曜日 23:51:21 UTC+9 imasdk:

IMA SDK

unread,
Apr 19, 2022, 10:35:08 PM4/19/22
to yukihiro...@play.jp, ima...@googlegroups.com

Hello,

 

Michael here and I work along with Teejay. Thank you for clarifying the issue.

 

The closest I see that can help to your use case is the getAdSlotID method. Additionally, here is the list of the methods from Ad level that may be a help to you, kindly check and see if there is anything that can satisfy your concern.

 

If the above would not be enough, kindly share to us the sample VAST Tag that contains the information you want to retrieve via the SDK. Please add also the screenshot that highlights this data so we can raise it precisely to our team and it will help for faster investigation and evaluation.

Regards,

Google Logo
Michael Angelo
IMA SDK Team
 


ref:_00D1U1174p._5004Q2ZL6vn:ref

森本幸紘

unread,
Apr 21, 2022, 6:13:59 AM4/21/22
to Interactive Media Ads SDK

Hi,

Thanks for your response.

> The closest I see that can help to your use case is the getAdSlotID method. Additionally, here is the list of the methods from Ad level that may be a help to you, kindly check and see if there is anything that can satisfy your concern.

We tried to get the adSlotId with getAdSlotID but it returned null.
We also checked the methods in the Ad class, but we are not able to get the adSlotId and URL of the CompanionClickTracking element.

> If the above would not be enough, kindly share to us the sample VAST Tag that contains the information you want to retrieve via the SDK.

We attach a sample VAST file (sample_vast.xml).

> Please add also the screenshot that highlights this data so we can raise it precisely to our team and it will help for faster investigation and evaluation.

We attach a screenshot of when we run getAdSlotID and get null loading a sample VAST file.

Regards,

2022年4月20日水曜日 11:35:08 UTC+9 imasdk:
sample_vast.xml
screenshot.png

IMA SDK

unread,
Apr 25, 2022, 4:57:15 AM4/25/22
to yukihiro...@play.jp, ima...@googlegroups.com

Hello,

 

Thank you for your response. I am trying to test from your shared VAST xml, converting it to Ad Url Tag using our internal tool, and using the generated tag into our VSI but I am constantly encountering an AdError400. Would you be able to share the VAST Ad Tag url itself instead of the xml? Additionally, please provide your sample project implementation where we can reproduce the issue with logs so we can easily check the called methods/functions.

 

If the file(s) you are looking to share are less than 25mb in total you can attach them to this case on your next reply. If you are having trouble attaching your file to this case or if your file(s) are larger than 25mb, you can share your files with me by performing the following steps:

 

1. Navigate to

https://docs.google.com/forms/d/e/1FAIpQLSfkAiXMeYP-fw1W3Z-tT9uwmATEKO5X6S-th0gR2ezdKaaqfg/viewform?usp=pp_url&entry.400550049=IMA+SDK&entry.460850823=5004Q00002ZL6vnQAD&entry.80707362=00101192

2. Fill out all fields, and attach your file(s).

3. Please reply back on this thread when you have uploaded your file(s). Please do not share this link.

 

Should you opt to share the requested information directly on this thread, please send it privately via "Reply To Author" button.

Regards,

Message has been deleted
Message has been deleted

森本幸紘

unread,
May 9, 2022, 7:06:06 AM5/9/22
to Interactive Media Ads SDK
Hello,

Thank you for your response.

The error was occurring because we had written a dummy media file URL in our sample VAST.
We attach a new sample VAST file changed to the URL of an existing media file.
We have confirmed that this VAST works without error with VSI.

Sample VAST file:
sample_vast2.xml

Regards,

2022年4月25日月曜日 17:57:15 UTC+9 imasdk:
sample_vast2.xml

IMA SDK

unread,
May 11, 2022, 10:23:30 PM5/11/22
to yukihiro...@play.jp, ima...@googlegroups.com

Hello,

 

Thank you for the information. However, I believe you have already shared this. Thus, I have already raised the issue to the rest of our team. We will let you know the result of the investigation once completed.

Regards,

森本幸紘

unread,
May 11, 2022, 11:03:50 PM5/11/22
to Interactive Media Ads SDK
Hello,

Thank you for your response.
I'm looking forward to hearing from results of your investigation.

Regards,

2022年5月12日木曜日 11:23:30 UTC+9 imasdk:

IMA SDK

unread,
Jun 24, 2022, 6:42:35 AM6/24/22
to yukihiro...@play.jp, ima...@googlegroups.com

Hello,

 

Hope you are doing well.

 

I just want to get back here as our team have informed us that it needs to be spelled adSlotID, and not adSlotId. They have confirmed that the example works if it is spelled correctly. You may check here for reference: https://iabtechlab.com/wp-content/uploads/2018/06/VAST4.1-June7-FINAL.pdf#page=63. To clarify, it means in the VAST response "ID" needs to be capitalized.

 

Let us know should you have feedback or further concerns.

Regards,

 

森本幸紘

unread,
Jul 18, 2022, 10:18:26 PM7/18/22
to Interactive Media Ads SDK
Hello,

Thank you for your response.

We changed the Sample VAST file to adSlotID as per your reply and was able to get the value with getAdSlotId.
We was able to solve the problem regarding ad slot id.
Thank you so much for your help.

One more issue, I would like to get the URL of the CompanionClickTracking  element written in the VAST, is there an open API to get it?

Regards,

2022年6月24日金曜日 19:42:35 UTC+9 imasdk:

IMA SDK

unread,
Jul 19, 2022, 3:29:28 AM7/19/22
to yukihiro...@play.jp, ima...@googlegroups.com

Hello,

 

Thank you for responding back to us. Glad that the issue has been resolved. For your other concern, it does not appear that we have available method for this call in our developer's guide. Thus, I am raising this to the rest of our team as a feature request instead. You may check our developer's guide at a later date or keep an eye on our blog post for future updates.

Regards,

IMA SDK

unread,
Jul 22, 2022, 6:51:52 AM7/22/22
to yukihiro...@play.jp, ima...@googlegroups.com

Hello,

 

Hope you are doing well.

 

I just want to get back here as our internal team needed some confirmation with the request for API/method to get the URL of the CompanionClickTracking element written in the VAST:

 

A little confused on the request. Can you confirm, the publisher is asking for the click-through URL?

If this is the case, this is not possible to provide, however if the publisher would like to assign a custom element as the click-through button, they can use the AdDisplayContainer's third construction parameter to do this.

If they are asking for something different, the CompanionClickTracking element is an html5 element. This would not be written in the vast, and elements typically are not represented by a URL, as far as I know.

 

Let me know your feedback on the above.

Regards,

Reply all
Reply to author
Forward
0 new messages