IMA HTML5 SDK - Client Side

[Evans Owino]

Hello,

I have a general question about methods exposed by the SDK and the documentation (https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/js).

Is it safe to use methods such as (for e.g.) adsManager.getCurrentAd() even though it doesn't appear to be part of the AdsManager docs? https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/js/google.ima.AdsManager

It probably goes without saying that properties on the SDK with obfuscated names should not be touched. 

I just want to ensure that I'm not using methods that I shouldn't be using.

Bonus question, any plans from the IMA team on creating/maintaining TypeScript docs?

Thanks,

Evans

[IMA SDK]

Hi Evans,

The methods described in the reference section are part of the API and have some support from us, some methods may not be implemented yet, you may try them out. You may also check our sample apps for how to use some of the functions listed in the reference. The Guide documentation is general recommended implementation. Anything not listed in either reference or guide has no support from us.

Regarding TypeScript documentation, could you elaborate what you are looking for? 

Regards,

Aryeh Baker IMA SDK Team

ref:_00D1U1174p._5004Q2CQPI7:ref

[Evans Owino]

Thanks for the response.

Regarding the TypeScript docs, I should've said TypeScript type definitions for the IMA SDK.  Similar to the ones found here: https://github.com/DefinitelyTyped/DefinitelyTyped

Thanks

[IMA SDK]

Hi Evins,

To raise your request for TypeScript definitions in the IMA SDK with my team I will need to gauge value. Could you elaborate on use cases, metrics and desirability of such a feature? 

[Evans Owino]

Hi Aryeh,

TypeScript has a wide and growing adoption in frontend development as we can see in this annual report - https://2020.stateofjs.com/en-US/technologies/javascript-flavors/#javascript_flavors_experience_ranking. 

With TypeScript definitions, the developer experience when integrating the IMA SDK would be greatly improved. Of course, people can create their own types in the meantime. However, having the Core IMA team manage this would make a lot of sense as they are the authors of the library.

Regards

[IMA SDK]

Hi Evans,

Thank you for your detailed reply. I raised your request for Typescript support for IMA SDK to the rest of my team. You may monitor our release notes for an update.

[Evans Owino]

Thanks a lot Aryeh! 🤞