feat(ad): add data to onReceiveAdEvent (#3378)

* feat(ad): add adData to onReceiveAdEvent
* fix: remove adData from response if empty
* fix: add getAdData to stub file
* chore: fix build without IMA
* fix: rename `adData` to `data`

---------

Co-authored-by: olivier <olivier.bouillet@ifeelsmart.com>
This commit is contained in:
Axel Vencatareddy
2023-11-27 21:43:30 +01:00
committed by GitHub
parent de4159f0c2
commit d05231d76b
9 changed files with 50 additions and 15 deletions

View File

@@ -362,10 +362,10 @@ Enum `AdEvent` possible values for [Android](https://developers.google.com/inter
| `AD_METADATA` | Android | Fires when an ads list is loaded. |
| `AD_PERIOD_ENDED` | iOS | Fired every time the stream switches from advertising or slate to content. This will be fired even when an ad is played a second time or when seeking into an ad (only used for dynamic ad insertion). |
| `AD_PERIOD_STARTED` | iOS | Fired every time the stream switches from content to advertising or slate. This will be fired even when an ad is played a second time or when seeking into an ad (only used for dynamic ad insertion). |
| `AD_PROGRESS` | Android | Fires when the ad's current time value changes. Calling getAdData() on this event will return an AdProgressData object. |
| `AD_PROGRESS` | Android | Fires when the ad's current time value changes. The event `data` will be populated with an AdProgressData object. |
| `ALL_ADS_COMPLETED` | Android, iOS | Fires when the ads manager is done playing all the valid ads in the ads response, or when the response doesn't return any valid ads. |
| `CLICK` | Android, iOS | Fires when the ad is clicked. |
| `COMPLETE` | Android, iOS | Fires when the ad completes playing. |
| `COMPLETED` | Android, iOS | Fires when the ad completes playing. |
| `CONTENT_PAUSE_REQUESTED` | Android | Fires when content should be paused. This usually happens right before an ad is about to cover the content. |
| `CONTENT_RESUME_REQUESTED` | Android | Fires when content should be resumed. This usually happens when an ad finishes or collapses. |
| `CUEPOINTS_CHANGED` | iOS | Cuepoints changed for VOD stream (only used for dynamic ad insertion). |
@@ -395,14 +395,18 @@ Enum `AdEvent` possible values for [Android](https://developers.google.com/inter
Payload:
| Property | Type | Description |
|----------|---------|-----------------------|
| event | AdEvent | The ad event received |
| Property | Type | Description |
|----------|-------------------------------------|-----------------------|
| event | AdEvent | The ad event received |
| data | Record<string, string> \| undefined | The ad event data |
Example:
```javascript
```json
{
"event": "LOADED"
"data": {
"key": "value"
},
"event": "LOG"
}
```
@@ -540,4 +544,4 @@ Example:
}
```
Platforms: Android, iOS
Platforms: Android, iOS