cordova-plugin-hms-ads v4.0.4

cordova-plugin-hms-ads

Contents

1. Introduction
2. Installation Guide
3. Cordova Example API Method Definition
4. Configure Description
5. Licensing and Terms

1. Introduction

This Cordova SDK code encapsulates the Huawei Ads Kit interface. It provides many APIs for your reference or use.

The package is described as follows:

• src/main/com/huawei/hms/cordova/ads: core layer that exposes AdsKit SDK functionality to JS side.
• www/: Public interfaces for interacting AdsKit SDK through Cordova.

2. Installation Guide

1. Create an application on AppGallery Connect.

2. Go to Develop > Overview > App information then download agconnect-services.json and add it to root directory.

3. Copy package_name value from agconnect-services.json file and put it in id field of config.xml file.

4. Download the Cordova Ads SDK Plugin.

5. Add platform to project.

cordova platform add android

6. Run the following command in the root directory of the Cordova project:

cordova plugin add PATH_TO_CORDOVA_ADS_SDK

7. Check whether the Cordova ADS SDK is successfully added to plugins folder in the root directory of the Cordova project.

8. Add jks(keystore) file to root directory. Refer to creating jks file.

9. Add build.json file to your project's root.

{
    "android": {
        "release": {
          "keystore": "./YOUR-JKS-FILE-NAME",
          "storePassword": "STORE-PASSWORD",
          "alias": "ALIAS",
          "password" : "PASSWORD"
        },
        "debug": {
          "keystore": "./YOUR-JKS-FILE-NAME",
          "storePassword": "STORE-PASSWORD",
          "alias": "ALIAS",
          "password" : "PASSWORD"
        }
    }
  }

10. Develop your app.

3. Cordova SDK API method definitions

Data Types

AdParam

Defines an ad request.

BannerAdOptions

Defines required information for a banner ad.

SplashAdOptions

Defines required information for a splash ad.

SplashAdLogoOptions

Defines how splash ad's logo section looks like.

SplashAdLoadOptions

Defines required information to load splash ad.

RewardAdOptions

Defines required information for a reward ad.

RewardVerifyConfig

Defines verify related configuration for reward ad.

InterstitialAdOptions

Defines required information for a interstitial ad.

NativeAdOptions

Defines required information for a native ad.

NativeAdLoadOptions

Defines required information to load native ad.

NativeAdConfiguration

Defines extra information for a native ad.

AdSize

Defines an ad size.

VideoConfiguration

Video configuration used to control video playback.

InitOptions

Initial configuration options for Ads Kit.

IsLoadingResult

Returned when .isLoading() function called on an ad.

IsLoadedResult

Returned when .isLoaded() function called on an ad.

OaidResult

The OAID and setting of Disable personalized ads.

ReferrerDetails

Describes the install referrer information.

Constants

BannerAd

Public Method Summary

Event names

You can subscribe to these events using .on function, with event name as described below.

SplashAd

Public Method Summary

Event Names

You can subscribe to these events using .on function, with event name as described below.

RewardAd

Public Method Summary

Event Names

You can subscribe to these events using .on function, with event name as described below.

InterstitialAd

Public Method Summary

Event Names

You can subscribe to these events using .on function, with event name as described below.

NativeAd

Public Method Summary

Event Names

You can subscribe to these events using .on function, with event name as described below.

Other Public Methods

4. Configure Description

No.

5. Licensing and Terms

Apache 2.0 license.