https://github.com/openanime/capacitor-plugin-unityads
Unity ADS Integration for Capacitor & Ionic Projects.
https://github.com/openanime/capacitor-plugin-unityads
Last synced: about 1 year ago
JSON representation
Unity ADS Integration for Capacitor & Ionic Projects.
- Host: GitHub
- URL: https://github.com/openanime/capacitor-plugin-unityads
- Owner: OpenAnime
- Created: 2023-10-20T21:28:32.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-31T20:28:52.000Z (over 2 years ago)
- Last Synced: 2025-03-29T02:41:44.353Z (over 1 year ago)
- Language: Java
- Size: 104 KB
- Stars: 10
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# capacitor-plugin-unityads
Unity ADS Integration for Capacitor & Ionic Projects.
## ⚠ NOTE
This plugin is in beta. Currently it only supports interstitial ads but rewarded ads and banner ads are planned.
Also, IOS support is still under development.
## Install
```bash
npm install @openanime/capacitor-plugin-unityads
npx cap sync
```
## Table of Contents
- [capacitor-plugin-unityads](#capacitor-plugin-unityads)
- [⚠ NOTE](#-note)
- [Install](#install)
- [Table of Contents](#table-of-contents)
- [Basic Example with Svelte](#basic-example-with-svelte)
- [API](#api)
- [initAds(...)](#initads)
- [loadAds(...)](#loadads)
- [displayAd()](#displayad)
- [Events](#events)
## Basic Example with Svelte
```html
import { onMount } from "svelte";
import { UnityAds } from "@openanime/unity-ads-capacitor";
let ready = false;
let message = "";
let isSkipped;
const unityGameId = "YOUR_GAME_ID";
const testMode = true; //change this to false in production!
const adUnitId = "YOUR_AD_UNIT_AD";
onMount(() => {
UnityAds.addListener("initialized", () => {
message = "initialized";
UnityAds.loadAds({
adUnitId,
});
});
UnityAds.addListener("initializationError", ({ error }) => {
message = "initializationError: " + error;
});
UnityAds.addListener("adShown", ({ state }) => {
message = "ad completed state: " + state; // SKIPPED or COMPLETED
UnityAds.loadAds({
adUnitId,
});
});
UnityAds.addListener("adShowError", ({ error }) => {
message = "adShowError: " + error;
});
UnityAds.addListener("adLoaded", () => {
message = "ad loaded";
ready = true;
});
UnityAds.addListener("adLoadError", ({ error }) => {
message = "adLoadError: " + error;
});
UnityAds.initAds({
unityGameId,
testMode,
});
});
const handleClick = () => {
UnityAds.loadAds({
adUnitId,
});
UnityAds.displayAd();
};
{#if ready}
Show ad
{:else}
not ready!
{/if}
{message}
```
## API
### initAds(...)
```typescript
initAds(options: { unityGameId: string; testMode: boolean; }) => void
```
---
### loadAds(...)
```typescript
loadAds(options: { adUnitId: string; }) => void
```
---
### displayAd()
```typescript
displayAd() => void
```
---
## Events
| Event | Returns | Description |
| --------------------- | -------------------- | -------------------------------------------- |
| `initialized` | `null` | Fires when Unity SDK is initialized. |
| `adLoaded` | `null` | Fires when AD is loaded. |
| `adShowStart` | `null` | Fires when AD starts showing. |
| `adShowClick` | `null` | Fires when user clicks the AD. |
| `adShown` | `{ state: "SKIPPED" \| "COMPLETED"; }` | Fires when AD is completed or skipped. |
| `initializationError` | `{ error: string; }` | Fires when error occurs in initialization. |
| `adLoadError` | `{ error: string; }` | Fires when error occurs while loading an AD. |
| `adShowError` | `{ error: string; }` | Fires when error occurs while showing an AD. |