Flutter GroMore

https://zhecent.com/sdks/flutter-gromore-ads/docs
Admin
A Flutter plugin for integrating GroMore advertisements, offering a comprehensive set of ad formats,...
Tokens:7,381
Snippets:78
Trust Score:1.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Show Install or Open Dialog

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/13-privacy

Displays an installation or activation dialog on Android. This method throws an UnsupportedError on iOS.

```dart
final type = await GromoreAds.showOpenOrInstallAppDialog();
```

--------------------------------

### Configure iOS Platform

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/01-installation

Set the platform version and source in your Podfile, then install dependencies.

```ruby
platform :ios, '13.0'
source 'https://cdn.cocoapods.org/'
```

```bash
cd ios
pod install --repo-update
```

--------------------------------

### GromoreAds.showOpenOrInstallAppDialog

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/13-privacy

Displays an installation or activation dialog on Android platforms.

```APIDOC
## GromoreAds.showOpenOrInstallAppDialog()

### Description
Displays an installation or activation dialog on Android. Returns the interaction type (none, install, or open). Calling this on iOS will throw an UnsupportedError.
```

--------------------------------

### Initialize Gromore SDK

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/02-quick-start

Initializes the SDK with an appId and privacy configurations. Ensure the appId matches the registered platform information.

```dart
Future<void> initializeAds(String appId) async {
  await GromoreAds.initialize(
    GromoreInitConfig(
      appId: appId,
      useMediation: true,
      privacy: const GromorePrivacyConfig(
        android: AndroidGromorePrivacyConfig(
          canUseLocation: false,
          canUsePhoneState: false,
          canUseAppList: false,
        ),
        ios: IosGromorePrivacyConfig(
          canUseLocation: false,
          forbiddenIdfa: true,
        ),
      ),
    ),
  );
}
```

--------------------------------

### Configure Android Repositories

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/01-installation

Add the Pangle Maven repository to your project-level build.gradle file.

```gradle
allprojects {
    repositories {
        google()
        mavenCentral()
        maven { url 'https://artifact.bytedance.com/repository/pangle' }
    }
}
```

--------------------------------

### Configure Local Waterfall

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/02-quick-start

Sets up the SDK using a local JSON configuration file. The API requires a file path or a validated JSON string.

```dart
final config = GromoreInitConfig(
  appId: appId,
  localConfig: GromoreLocalConfig.asset('assets/SDK_Setting.json'),
);
```

--------------------------------

### Configure Android Build Settings

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/01-installation

Set the minimum SDK version and ABI filters in your app-level build.gradle.

```gradle
android {
    defaultConfig {
        minSdk 24
        ndk { abiFilters 'arm64-v8a' }
    }
}
```

--------------------------------

### Create BannerAdController

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/06-banner-ads

Initializes the banner controller with a specific placement ID and dimensions.

```dart
late final BannerAdController controller;

controller = GromoreAds.createBannerController(
  BannerAdRequest(
    placementId: bannerPlacementId,
    width: 360,
    height: 60,
  ),
);
```

--------------------------------

### GromoreAds.preload

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/11-preload

该方法用于预加载指定格式的广告资源。支持激励视频、插全屏、Banner、Feed 和 Draw 广告格式。

```APIDOC
## GromoreAds.preload

### Description
预加载广告资源，利用厂商实时缓存能力提升后续展示速度。必须在 SDK ready 后调用。

### Method
Dart Method

### Parameters
- **request** (AdPreloadRequest) - Required - 包含预加载配置的请求对象

#### AdPreloadRequest 字段
- **items** (List<AdPreloadItem>) - Required - 需要预加载的广告项列表
- **parallelism** (int) - Optional - 并发数，范围 1 到 20
- **requestInterval** (Duration) - Optional - 请求间隔，必须是 1 到 10 秒的整数秒

#### AdPreloadItem 字段
- **format** (AdFormat) - Required - 广告格式 (rewarded, feed, 等)
- **placementIds** (List<String>) - Required - 广告位 ID 列表

### Code Example
```dart
await GromoreAds.preload(
  AdPreloadRequest(
    items: <AdPreloadItem>[
      AdPreloadItem(
        format: AdFormat.rewarded,
        placementIds: <String>[rewardedPlacementId],
      ),
      AdPreloadItem(
        format: AdFormat.feed,
        placementIds: <String>[feedPlacementId],
      ),
    ],
    parallelism: 2,
    requestInterval: const Duration(seconds: 2),
  ),
);
```
```

--------------------------------

### RewardedAdHandle.show

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/07-reward-video-ad

展示已加载的激励视频广告。

```APIDOC
## RewardedAdHandle.show

### Description
展示通过 loadRewarded 加载的激励视频广告。

### Method
SDK Method
```

--------------------------------

### 执行广告预加载

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/11-preload

使用 AdPreloadRequest 配置预加载任务，支持激励视频和信息流广告，并设置并发数与请求间隔。

```dart
await GromoreAds.preload(
  AdPreloadRequest(
    items: <AdPreloadItem>[
      AdPreloadItem(
        format: AdFormat.rewarded,
        placementIds: <String>[rewardedPlacementId],
      ),
      AdPreloadItem(
        format: AdFormat.feed,
        placementIds: <String>[feedPlacementId],
      ),
    ],
    parallelism: 2,
    requestInterval: const Duration(seconds: 2),
  ),
);
```

--------------------------------

### Configure iOS Options

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/02-quick-start

Provides platform-specific settings for iOS, such as audio session modes and app logo assets.

```dart
IosGromoreOptions(
  appLogoAsset: 'assets/app_logo.png',
  allowModifyAudioSessionSetting: true,
  audioSessionMode: IosAudioSessionMode.mix,
)
```

--------------------------------

### Add Dependency

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/01-installation

Add the GroMore Ads package to your pubspec.yaml and fetch dependencies.

```yaml
dependencies:
  gromore_ads: ^2.0.0
```

```bash
flutter pub get
```

--------------------------------

### GromoreAds.showSplash

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/04-splash-ads

Displays a splash advertisement using the provided SplashAdRequest configuration.

```APIDOC
## GromoreAds.showSplash

### Description
Displays a splash advertisement. The timeout range is 1 to 10 seconds. The logo can be configured using SplashAdLogo with support for asset, absolute file, Android resource, and iOS bundle sources.

### Method
Dart Method

### Signature
`await GromoreAds.showSplash(SplashAdRequest request)`

### Parameters
- **request** (SplashAdRequest) - Required - The configuration object for the splash ad.
  - **placementId** (String) - Required - The ad placement identifier.
  - **timeout** (Duration) - Optional - The timeout duration (1-10 seconds).
  - **logo** (SplashAdLogo) - Optional - The logo configuration.
  - **preloadOnly** (bool) - Optional - If true, the ad is preloaded without immediate display.

### Usage Example
```dart
await GromoreAds.showSplash(
  SplashAdRequest(
    placementId: splashPlacementId,
    timeout: const Duration(milliseconds: 3500),
    logo: SplashAdLogo.asset(
      'assets/logo.png',
      heightRatio: 0.15,
    ),
  ),
);
```
```

--------------------------------

### GromoreAds.loadRewarded

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/07-reward-video-ad

加载激励视频广告并获取广告句柄。

```APIDOC
## GromoreAds.loadRewarded

### Description
加载激励视频广告，返回一个广告句柄用于后续展示。

### Method
SDK Method

### Parameters
- **RewardedAdRequest** (Object) - Required
  - **placementId** (String) - Required - 广告位ID
  - **userId** (String) - Required - 用户ID
  - **customData** (String) - Optional - 自定义上下文数据
  - **rewardName** (String) - Optional - 奖励名称
  - **rewardAmount** (int) - Optional - 奖励数量

### Response
- **handle** (RewardedAdHandle) - 广告句柄，用于调用 show() 和 dispose()
```

--------------------------------

### 渲染 Feed 信息流广告视图

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/08-feed-ads

使用 NativeAdView 组件绑定广告句柄并设置布局样式。

```dart
NativeAdView(
  handle: handles.first,
  layout: NativeAdLayout.media,
  style: const NativeAdStyle(
    cornerRadius: 4,
    padding: 12,
  ),
)
```

--------------------------------

### RewardedAdHandle.dispose

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/07-reward-video-ad

释放激励视频广告资源。

```APIDOC
## RewardedAdHandle.dispose

### Description
在广告展示完成后调用，用于释放广告句柄占用的资源。

### Method
SDK Method
```

--------------------------------

### GromoreAds.loadInterstitial

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/05-interstitial-ads

Loads an interstitial ad using the specified placement ID and orientation, returning a handle to control the ad lifecycle.

```APIDOC
## GromoreAds.loadInterstitial

### Description
Loads an interstitial ad and returns a handle for controlling the ad display and cleanup. Each load operation generates a unique requestId.

### Method
Dart Method

### Parameters
- **placementId** (String) - Required - The unique identifier for the ad placement.
- **orientation** (AdOrientation) - Required - The orientation of the ad (e.g., AdOrientation.portrait).

### Usage Example
```dart
final handle = await GromoreAds.loadInterstitial(
  InterstitialAdRequest(
    placementId: interstitialPlacementId,
    orientation: AdOrientation.portrait,
  ),
);

await handle.show();
await handle.dispose();
```

### Notes
- The handle can only be shown once; repeated calls to show will throw a StateError.
- Repeated calls to dispose() are safe.
- The SDK checks ad readiness before attempting to show.
```

--------------------------------

### GromoreAds.loadNativeAds

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/08-feed-ads

加载 Feed 信息流广告的方法，支持指定广告位 ID、尺寸及加载数量。

```APIDOC
## GromoreAds.loadNativeAds

### Description
加载 Feed 信息流广告，返回广告句柄列表。

### Method
Method: GromoreAds.loadNativeAds(NativeAdRequest request)

### Parameters
- **format** (AdFormat) - Required - 广告格式，此处应为 AdFormat.feed
- **placementId** (String) - Required - 广告位 ID
- **width** (double) - Required - 广告宽度
- **height** (double) - Required - 广告高度
- **count** (int) - Required - 加载广告数量

### Request Example
final handles = await GromoreAds.loadNativeAds(
  NativeAdRequest(
    format: AdFormat.feed,
    placementId: feedPlacementId,
    width: 360,
    height: 300,
    count: 2,
  ),
);
```

--------------------------------

### 释放激励视频广告资源

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/07-reward-video-ad

在广告展示完成后，应调用 dispose 方法释放 handle 资源。

```dart
await handle.dispose();
```

--------------------------------

### Render BannerAdView

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/06-banner-ads

Displays the banner ad in the widget tree using the initialized controller.

```dart
BannerAdView(controller: controller)
```

--------------------------------

### Listening to Ad Events

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/03-event-handling

Use a StreamSubscription to listen to global ad events and handle specific types like rewards or failures.

```dart
late final StreamSubscription<AdEvent> subscription;

subscription = GromoreAds.events.listen((event) {
  switch (event.type) {
    case AdEventType.rewarded:
      final reward = event.reward;
      if (reward?.verified == true) grantReward(reward!);
    case AdEventType.failed:
      reportAdError(event.error);
    default:
      break;
  }
});

await subscription.cancel();
```

--------------------------------

### NativeAdView

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/08-feed-ads

用于渲染 Feed 信息流广告的 Flutter 组件。

```APIDOC
## NativeAdView

### Description
用于在界面中展示已加载的 Feed 广告视图。

### Parameters
- **handle** (NativeAdHandle) - Required - 广告句柄
- **layout** (NativeAdLayout) - Required - 广告布局类型
- **style** (NativeAdStyle) - Optional - 广告样式配置

### Request Example
NativeAdView(
  handle: handles.first,
  layout: NativeAdLayout.media,
  style: const NativeAdStyle(
    cornerRadius: 4,
    padding: 12,
  ),
)
```

--------------------------------

### 加载并展示激励视频广告

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/07-reward-video-ad

使用 RewardedAdRequest 配置广告参数并加载，随后调用 show 方法进行展示。

```dart
final handle = await GromoreAds.loadRewarded(
  RewardedAdRequest(
    placementId: rewardedPlacementId,
    userId: userId,
    customData: rewardContext,
    rewardName: 'coin',
    rewardAmount: 10,
  ),
);

await handle.show();
```

--------------------------------

### Banner 广告集成

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/06-banner-ads

展示了如何创建 BannerAdController、在界面中渲染 BannerAdView 以及在生命周期结束时释放控制器资源。

```APIDOC
## Banner 广告集成

### 创建控制器
```dart
late final BannerAdController controller;

controller = GromoreAds.createBannerController(
  BannerAdRequest(
    placementId: bannerPlacementId,
    width: 360,
    height: 60,
  ),
);
```

### 渲染视图
```dart
BannerAdView(controller: controller)
```

### 资源释放
```dart
@override
void dispose() {
  controller.dispose();
  super.dispose();
}
```

### 说明
- 控制器只允许绑定一个 PlatformView。
- `refresh()` 方法用于复用同一视图重新加载。
- `dispose()` 方法用于释放 delegate、原生广告和通道处理器。
```

--------------------------------

### 加载 Feed 信息流广告

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/08-feed-ads

使用 NativeAdRequest 配置广告格式、位置 ID 和尺寸，并加载广告句柄。

```dart
final handles = await GromoreAds.loadNativeAds(
  NativeAdRequest(
    format: AdFormat.feed,
    placementId: feedPlacementId,
    width: 360,
    height: 300,
    count: 2,
  ),
);
```

--------------------------------

### 加载 Draw 广告

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/09-draw-feed-ads

使用 NativeAdRequest 加载 Draw 格式的广告，需指定广告位 ID 及尺寸。

```dart
final handles = await GromoreAds.loadNativeAds(
  NativeAdRequest(
    format: AdFormat.draw,
    placementId: drawPlacementId,
    width: 360,
    height: 640,
  ),
);
```

--------------------------------

### GromoreAds.events

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/03-event-handling

Listen to global ad events using a StreamSubscription to handle various ad lifecycle states and rewards.

```APIDOC
## GromoreAds.events

### Description
Listen to a stream of `AdEvent` objects to track ad lifecycle events such as requests, caching, rendering, display, clicks, and rewards.

### Usage
```dart
late final StreamSubscription<AdEvent> subscription;

subscription = GromoreAds.events.listen((event) {
  switch (event.type) {
    case AdEventType.rewarded:
      final reward = event.reward;
      if (reward?.verified == true) grantReward(reward!);
    case AdEventType.failed:
      reportAdError(event.error);
    default:
      break;
  }
});

await subscription.cancel();
```
```

--------------------------------

### 展示 Draw 广告

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/09-draw-feed-ads

通过 PageView.builder 结合 NativeAdView 展示加载后的广告句柄。

```dart
PageView.builder(
  scrollDirection: Axis.vertical,
  itemCount: handles.length,
  itemBuilder: (context, index) => NativeAdView(
    handle: handles[index],
    layout: NativeAdLayout.verticalVideo,
  ),
)
```

--------------------------------

### Load and Show Interstitial Ad

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/05-interstitial-ads

Loads an interstitial ad request, displays it, and disposes of the handle. Note that each handle can only be shown once and will throw a StateError if reused.

```dart
final handle = await GromoreAds.loadInterstitial(
  InterstitialAdRequest(
    placementId: interstitialPlacementId,
    orientation: AdOrientation.portrait,
  ),
);

await handle.show();
await handle.dispose();
```

--------------------------------

### Show Splash Ad

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/04-splash-ads

Displays a splash ad with a specified timeout and logo configuration.

```dart
await GromoreAds.showSplash(
  SplashAdRequest(
    placementId: splashPlacementId,
    timeout: const Duration(milliseconds: 3500),
    logo: SplashAdLogo.asset(
      'assets/logo.png',
      heightRatio: 0.15,
    ),
  ),
);
```

--------------------------------

### Preload Splash Ad

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/04-splash-ads

Preloads a splash ad using the request model for later consumption.

```dart
await GromoreAds.showSplash(
  SplashAdRequest(
    placementId: splashPlacementId,
    preloadOnly: true,
  ),
);
```

--------------------------------

### GromoreAds.requestTrackingAuthorization

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/13-privacy

Requests tracking authorization on iOS platforms.

```APIDOC
## GromoreAds.requestTrackingAuthorization()

### Description
Requests tracking authorization from the user on iOS. Returns the status as a string (notDetermined, restricted, denied, authorized, or unavailable). Calling this on Android will throw an UnsupportedError.
```

--------------------------------

### GromoreAds.destroySplash

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/04-splash-ads

Cleans up splash ad resources when the page is closed early.

```APIDOC
## GromoreAds.destroySplash

### Description
Cleans up and destroys the splash ad instance. This should be called when the page is closed early to release resources.

### Method
Dart Method

### Signature
`await GromoreAds.destroySplash()`
```

--------------------------------

### GromorePrivacyConfig

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/13-privacy

Configures privacy settings for Android and iOS platforms to control access to device identifiers and sensors.

```APIDOC
## GromorePrivacyConfig

### Description
Configures privacy settings for Android and iOS platforms. Android and iOS configurations are independent; settings for one platform do not affect the other.

### Parameters
- **android** (AndroidGromorePrivacyConfig) - Optional - Android-specific privacy settings (canUseLocation, canUseAppList, canUsePhoneState, canUseWifiState, canUseAndroidId, canUseOaid, canRecordAudio).
- **ios** (IosGromorePrivacyConfig) - Optional - iOS-specific privacy settings (canUseLocation, canUseWifiBssid, forbiddenIdfa).
```

--------------------------------

### Configure Privacy Settings

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/13-privacy

Defines privacy permissions for Android and iOS platforms. Note that forbiddenCaid must remain false to avoid initialization failure.

```dart
const GromorePrivacyConfig(
  android: AndroidGromorePrivacyConfig(
    canUseLocation: false,
    canUseAppList: false,
    canUsePhoneState: false,
    canUseWifiState: false,
    canUseAndroidId: false,
    canUseOaid: false,
    canRecordAudio: false,
  ),
  ios: IosGromorePrivacyConfig(
    canUseLocation: false,
    canUseWifiBssid: false,
    forbiddenIdfa: true,
  ),
)
```

--------------------------------

### GromoreException

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/03-event-handling

Handling errors thrown by MethodChannel operations using the GromoreException class.

```APIDOC
## GromoreException

### Description
MethodChannel failures are unified into `GromoreException`. Use try-catch blocks to handle these exceptions and access error details.

### Usage
```dart
try {
  await handle.show();
} on GromoreException catch (error) {
  log(error.code, error.subCode, error.message, error.requestId, error.details);
}
```
```

--------------------------------

### Request Tracking Authorization

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/13-privacy

Requests App Tracking Transparency authorization on iOS. This method throws an UnsupportedError on Android.

```dart
final status = await GromoreAds.requestTrackingAuthorization();
```

--------------------------------

### Handling Gromore Exceptions

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/03-event-handling

Catch GromoreException to access specific error codes, sub-codes, and request identifiers when method calls fail.

```dart
try {
  await handle.show();
} on GromoreException catch (error) {
  log(error.code, error.subCode, error.message, error.requestId, error.details);
}
```

--------------------------------

### Dispose BannerAdController

Source: https://zhecent.com/sdks/flutter-gromore-ads/docs/2.0/06-banner-ads

Releases resources associated with the controller when the widget is disposed.

```dart
@override
void dispose() {
  controller.dispose();
  super.dispose();
}
```
Tokens:
Raw