# AdsKit-Codelab-Reward-ArkTS

**Repository Path**: harmonyos_codelabs/ads-kit-codelab-reward-arkts

## Basic Information

- **Project Name**: AdsKit-Codelab-Reward-ArkTS
- **Description**: 此Codelab将引导您在您的App中通过接口获取并展示激励广告。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2024-06-18
- **Last Updated**: 2025-10-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Ads Kit Sample Code (HarmonyOS ArkTS)

## Contents

- [Overview](#Overview)
- [How to Use](#How-to-Use)
- [Preview](#Preview)
- [Project Directory](#Project-Directory)
- [Sample Code](#Sample-Code)
- [Required Permissions](#Required-Permissions)
- [Constraints](#Constraints)

## Overview

The sample code of Ads Kit for HarmonyOS ArkTS describes how to use APIs of Ads Kit in your app to display ads.

## How to Use

Before running this demo, you need to [configure app signing information](https://developer.huawei.com/consumer/en/doc/harmonyos-guides/application-dev-overview#section42841246144813).

## Preview

| Rewarded ad page                                 |
| ------------------------------------------------ |
| ![avatar](./screenshots/device_en/reward_en.png) |

## Project Directory

```
├─entry/src/main/ets            // Code area. 
│ ├─entryability
│ │ └─EntryAbility.ets          // Entry point class.
│ ├─event   
│ │ └─RewardAdStatusHandler.ets // Listener for rewarded ad status.
│ ├─pages                       // Directory for storing app UI files.               
│ │ └─Index.ets                 // App home screen.
│ ├─viewmodel                   // Directory for storing the ViewModel file.
│ │ └─AdsViewModel.ets          // ViewModel for ads.
└─entry/src/main/resources      // Directory for storing resource files.
```

## Sample Code

### Petal Ads Publisher Service

The sample code is used to implement a UI to display rewarded ads.
The sample code includes the following files for you to request and display ads:

1. Index.ets
   Demo UI of Petal Ads Publisher Service, where you can tap the button to request and display rewarded ads.
   <br>Code location: **entry\src\main\ets\pages\Index.ets**<br>
2. RewardAdStatusHandler.ets
   Used to subscribe to the **com.huawei.hms.pps.action.PPS_REWARD_STATUS_CHANGED** event to track changes on the rewarded ad page and receive reward information.
   <br>Code location: **entry\src\main\ets\event\RewardAdStatusHandler.ets**<br>
3. AdsViewModel.ets
   Used to manage the ad UI status and service logic.
   <br>Code location: **entry\src\main\ets\viewmodel\AdsViewModel.ets**<br>

## Required Permissions

- To obtain the OAID, you need to request the activity tracking permission [ohos.permission.APP_TRACKING_CONSENT](https://developer.huawei.com/consumer/en/doc/harmonyos-guides/permissions-for-all-user#ohospermissionapp_tracking_consent).
- To request and display ads, you need to request the Internet permission [ohos.permission.INTERNET](https://developer.huawei.com/consumer/en/doc/harmonyos-guides/permissions-for-all#ohospermissioninternet).

## Constraints

1. The sample app is only supported on Huawei phones and tablets with standard systems.
2. The HarmonyOS version must be HarmonyOS 5.0.5 Release or later.
3. The DevEco Studio version must be DevEco Studio 6.0.0 Release or later.
4. The HarmonyOS SDK version must be HarmonyOS 6.0.0 Release SDK or later.