Skip to content

Commit

Permalink
doc: table updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@OlenaTeqBlaze
OlenaTeqBlaze committed Oct 17, 2024
1 parent cfe4961 commit 90088a4
Showing 1 changed file with 20 additions and 19 deletions.
39 changes: 20 additions & 19 deletions _includes/mobile/rewarded-server-side-configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,27 @@ You can pass some rewarded configuration properties from PBS to the SDK using th

Here is the details about rewarded configuration object `rwdd`:


{: .table .table-bordered .table-striped }
| Attribute | Required? | Description | Example | Type |
|----------------------|----------------|-----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|----------|
| `reward` | Yes | Metadata provided by the publisher to describe the reward | `{"type": "SuperDollars", "count": 10}` | object |
| `reward.type` | Yes | Type of the reward in the app's coins | `"SuperDollars"` | string |
| `reward.count` | Yes | Amount of coins | `10` | integer |
| `reward.ext` | No | For future extensions | `null` | object |
| `completion` | No | Describes the condition when the SDK should send a signal to the app that the user has earned the reward | `{ "video": { "endcard": { "time": 5 } } }` | object |
| `completion.banner` | No | Details for banner ad completion | `{ "time": 5, "event": "custom_event_url" }` | object |
| `completion.banner.time` | No | Period of time the banner ad is on screen | `5` | integer |
| `completion.banner.event` | No | URL with custom schema sent by the creative | `"rwdd://userDidEarnReward"` | string |
| `completion.video` | No | Details for video ad completion | `{ "endcard": { "time": 5 } }` | object |
| `completion.video.time` | No | Period of time the video ad is on screen | `10` | integer |
| `completion.video.playbackevent` | No | The playback event stage in the video | `"start"`, `"firstquartile"`, `"midpoint"`, `"thirdquartile"`, `"complete"` | string |
| `completion.video.endcard` | No | Properties for end card, same as banner ad | `{ "time": 5 }` | object |
| `completion.video.endcard.time` | No | Period of time the end card is on screen | `5` | integer |
| `completion.video.endcard.event` | No | URL with custom schema sent by the creative for end card | `"rwdd://userDidEarnReward"` | string |
| `close` | No | Describes close behavior after reward is earned | `{ "postrewardtime": 3, "action": "autoclose" }` | object |
| `close.postrewardtime` | No | Time interval (seconds) after reward event when SDK should close interstitial | `3` | integer |
| `close.action` | No | Action SDK should take: `"autoclose"` (close interstitial) or `"closebutton"` (show close button) | `"autoclose"` | string |
| Attribute | Description | Example | Type |
|----------------------|-----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|----------|
| `reward` | Metadata provided by the publisher to describe the reward | `{"type": "SuperDollars", "count": 10}` | object |
| `reward.type` | Type of the reward in the app's coins | `"SuperDollars"` | string |
| `reward.count` | Amount of coins | `10` | integer |
| `reward.ext` | For future extensions | `{"ext":{}}` | object |
| `completion` | Describes the condition when the SDK should send a signal to the app that the user has earned the reward | `{ "video": { "endcard": { "time": 5 } } }` | object |
| `completion.banner` | Details for banner ad completion | `{ "time": 5, "event": "custom_event_url" }` | object |
| `completion.banner.time` | Period of time the banner ad is on screen | `5` | integer |
| `completion.banner.event` | URL with custom schema sent by the creative | `"rwdd://userDidEarnReward"` | string |
| `completion.video` | Details for video ad completion | `{ "endcard": { "time": 5 } }` | object |
| `completion.video.time` | Period of time the video ad is on screen | `10` | integer |
| `completion.video.playbackevent` | The playback event stage in the video | `"start"`, `"firstquartile"`, `"midpoint"`, `"thirdquartile"`, `"complete"` | string |
| `completion.video.endcard` | Properties for end card, same as banner ad | `{ "time": 5 }` | object |
| `completion.video.endcard.time` | Period of time the end card is on screen | `5` | integer |
| `completion.video.endcard.event` | URL with custom schema sent by the creative for end card | `"rwdd://userDidEarnReward"` | string |
| `close` | Describes close behavior after reward is earned | `{ "postrewardtime": 3, "action": "autoclose" }` | object |
| `close.postrewardtime` | Time interval (seconds) after reward event when SDK should close interstitial | `3` | integer |
| `close.action` | Action SDK should take: `"autoclose"` (close interstitial) or `"closebutton"` (show close button) | `"autoclose"` | string |


An example of a stored impression-level request:
Expand Down

0 comments on commit 90088a4

Please sign in to comment.