Skip to content

Commit a86395d

Browse files
ditmanandroidseb
ditman
authored and
androidseb
committed
[google_adsense] Add optional init parameters. (flutter#8297)
Adds `AdSenseCodeParameters` configuration object for `adSense.initialize`. Adds a 100ms delay to `adBreak` and `showAdFn` so on tap devices, when an ad renders on top of the flutter element that triggered the ad, the pointer up event doesn't trigger the ad immediately. Fixes a typo in the `MATCHED_CONTENT_ROWS_NUM` and `MATCHED_CONTENT_COLUMNS_NUM` constants, that would have resulted in passing the wrong parameter name to the AdSense JS. Continues the tightening of exports by making all the `export`s from barrel files **explicit**, so it's harder to accidentally expose any unintended API surface. ## Issues * Continuation of: flutter#8233 * Part of: flutter/flutter#40376
1 parent 3217cc6 commit a86395d

File tree

14 files changed

+226
-26
lines changed

14 files changed

+226
-26
lines changed

‎packages/google_adsense/CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## 0.1.1
2+
3+
* Adds `AdSenseCodeParameters` configuration object for `adSense.initialize`.
4+
* Adds a 100ms delay to `adBreak` and `showAdFn`, so Flutter tapevents have time
5+
to settle before an H5 Ad takes over the screen.
6+
17
## 0.1.0
28

39
* Adds H5 Games Ads API as `h5` library.

‎packages/google_adsense/README.md‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22

33
This package is only intended for use by web **games**.
44

5-
Please apply to the beta using [this form]( https://adsense.google.com/start/h5-beta/?src=flutter). Once approved, you may use the package.
5+
Please apply to the H5 Games Ads beta using [this form][h5-beta-form]. Once
6+
approved, you may use the package.
67

7-
Without approval, your code may not behave as expected, and your AdSense account may face policy issues.
8+
**Without approval, your code may not behave as expected, and your AdSense
9+
account may face policy issues.**
810

911
# google_adsense
1012

@@ -13,8 +15,12 @@ Without approval, your code may not behave as expected, and your AdSense account
1315
This package provides a way to initialize and use AdSense on your Flutter Web app.
1416
It includes libraries for the following products:
1517

16-
* [H5 Games Ads](https://adsense.google.com/start/h5-games-ads/) (beta)
17-
* (Experimental) [AdSense Ad Unit](https://support.google.com/adsense/answer/9183549) Widget
18+
* [H5 Games Ads](https://adsense.google.com/start/h5-games-ads/) (in beta, please
19+
apply using [this form][h5-beta-form])
20+
* [AdSense Ad Unit](https://support.google.com/adsense/answer/9183549) Widget
21+
(experimental and invitation-only, not accepting applications now)
22+
23+
[h5-beta-form]: https://adsense.google.com/start/h5-beta/?src=flutter
1824

1925
## Documentation
2026

‎packages/google_adsense/doc/initialization.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,23 @@ void main() async {
3131
runApp(const MyApp());
3232
}
3333
```
34+
35+
## Configure additional AdSense code parameters
36+
37+
You can pass an `AdSenseCodeParameters` object to the `adSense.initialize` call
38+
to configure additional settings, like a custom channel ID, or for regulatory
39+
compliance.
40+
41+
<?code-excerpt "../example/lib/h5.dart (initialize-with-code-parameters)"?>
42+
```dart
43+
await adSense.initialize(
44+
'0123456789012345',
45+
adSenseCodeParameters: AdSenseCodeParameters(
46+
adbreakTest: 'on',
47+
adFrequencyHint: '30s',
48+
),
49+
);
50+
```
51+
52+
Check the Google AdSense Help for a complete list of
53+
[AdSense code parameter descriptions](https://support.google.com/adsense/answer/9955214#adsense_code_parameter_descriptions).

‎packages/google_adsense/example/integration_test/core_test.dart‎

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ void main() async {
3333
group('adSense.initialize', () {
3434
testWidgets('adds AdSense script tag.', (WidgetTester _) async {
3535
final web.HTMLElement target = web.HTMLDivElement();
36-
// Given
3736

3837
await adSense.initialize(testClient, jsLoaderTarget: target);
3938

@@ -46,6 +45,39 @@ void main() async {
4645
expect(injected.async, true);
4746
});
4847

48+
testWidgets('sets AdSenseCodeParameters in script tag.',
49+
(WidgetTester _) async {
50+
final web.HTMLElement target = web.HTMLDivElement();
51+
52+
await adSense.initialize(testClient,
53+
jsLoaderTarget: target,
54+
adSenseCodeParameters: AdSenseCodeParameters(
55+
adHost: 'test-adHost',
56+
admobInterstitialSlot: 'test-admobInterstitialSlot',
57+
admobRewardedSlot: 'test-admobRewardedSlot',
58+
adChannel: 'test-adChannel',
59+
adbreakTest: 'test-adbreakTest',
60+
tagForChildDirectedTreatment: 'test-tagForChildDirectedTreatment',
61+
tagForUnderAgeOfConsent: 'test-tagForUnderAgeOfConsent',
62+
adFrequencyHint: 'test-adFrequencyHint',
63+
));
64+
65+
final web.HTMLScriptElement injected =
66+
target.lastElementChild! as web.HTMLScriptElement;
67+
68+
expect(injected.dataset['adHost'], 'test-adHost');
69+
expect(injected.dataset['admobInterstitialSlot'],
70+
'test-admobInterstitialSlot');
71+
expect(injected.dataset['admobRewardedSlot'], 'test-admobRewardedSlot');
72+
expect(injected.dataset['adChannel'], 'test-adChannel');
73+
expect(injected.dataset['adbreakTest'], 'test-adbreakTest');
74+
expect(injected.dataset['tagForChildDirectedTreatment'],
75+
'test-tagForChildDirectedTreatment');
76+
expect(injected.dataset['tagForUnderAgeOfConsent'],
77+
'test-tagForUnderAgeOfConsent');
78+
expect(injected.dataset['adFrequencyHint'], 'test-adFrequencyHint');
79+
});
80+
4981
testWidgets('Skips initialization if script is already present.',
5082
(WidgetTester _) async {
5183
final web.HTMLScriptElement script = web.HTMLScriptElement()

‎packages/google_adsense/example/integration_test/h5_test.dart‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ void main() {
3838

3939
// Pump frames so we can see what happened with adBreak
4040
await tester.pump();
41-
await tester.pump();
41+
// Wait for the async bits of adBreak
42+
await tester.pump(const Duration(milliseconds: 250));
4243

4344
expect(lastAdBreakPlacement, isNotNull);
4445
expect(lastAdBreakPlacement!.type?.toDart, 'reward');
@@ -70,7 +71,8 @@ void main() {
7071

7172
// Pump frames so we can see what happened with adBreak
7273
await tester.pump();
73-
await tester.pump();
74+
// Wait for the async bits of adBreak
75+
await tester.pump(const Duration(milliseconds: 250));
7476

7577
expect(lastPlacementInfo, isNotNull);
7678
expect(lastPlacementInfo!.breakName, 'ok-for-tests');
@@ -91,7 +93,8 @@ void main() {
9193

9294
// Pump frames so we can see what happened with adBreak
9395
await tester.pump();
94-
await tester.pump();
96+
// Wait for the async bits of adBreak
97+
await tester.pump(const Duration(milliseconds: 250));
9598

9699
expect(lastAdBreakPlacement!.name!.toDart, 'APFlutter-my-test-break');
97100
});
@@ -119,6 +122,7 @@ void main() {
119122

120123
// Pump frames so we can see what happened with adConfig
121124
await tester.pump();
125+
// adConfig doesn't have async bits
122126
await tester.pump();
123127

124128
expect(lastAdConfigParameters, isNotNull);

‎packages/google_adsense/example/lib/h5.dart‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,15 @@ import 'package:google_adsense/h5.dart';
1212
// #enddocregion import-h5
1313

1414
void main() async {
15-
await adSense.initialize('0123456789012345');
15+
// #docregion initialize-with-code-parameters
16+
await adSense.initialize(
17+
'0123456789012345',
18+
adSenseCodeParameters: AdSenseCodeParameters(
19+
adbreakTest: 'on',
20+
adFrequencyHint: '30s',
21+
),
22+
);
23+
// #enddocregion initialize-with-code-parameters
1624
runApp(const MyApp());
1725
}
1826

‎packages/google_adsense/lib/src/adsense/ad_unit_params.dart‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ class AdUnitParams {
3232
/// The ads inside a Multiplex ad unit are arranged in a grid. You can specify how many rows and columns you want to show within that grid<br>
3333
/// Sets the number of rows<br>
3434
/// Requires setting [AdUnitParams.MATCHED_CONTENT_UI_TYPE]
35-
static const String MATCHED_CONTENT_ROWS_NUM = 'macthedContentRowsNum';
35+
static const String MATCHED_CONTENT_ROWS_NUM = 'matchedContentRowsNum';
3636

3737
/// The ads inside a Multiplex ad unit are arranged in a grid. You can specify how many rows and columns you want to show within that grid<br>
3838
/// Sets the number of columns<br>
3939
/// Requires setting [AdUnitParams.MATCHED_CONTENT_UI_TYPE]
40-
static const String MATCHED_CONTENT_COLUMNS_NUM = 'macthedContentColumnsNum';
40+
static const String MATCHED_CONTENT_COLUMNS_NUM = 'matchedContentColumnsNum';
4141

4242
/// testing environment flag, defaults to kIsDebug
4343
static const String AD_TEST = 'adtest';

‎packages/google_adsense/lib/src/adsense/adsense.dart‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
// Use of this source code is governed by a BSD-style license that can be
33
// found in the LICENSE file.
44

5-
export 'ad_unit_configuration.dart';
6-
export 'ad_unit_params.dart' hide AdStatus, AdUnitParams;
7-
export 'ad_unit_widget.dart';
5+
export 'ad_unit_configuration.dart' show AdUnitConfiguration;
6+
export 'ad_unit_params.dart' show AdFormat, AdLayout, MatchedContentUiType;
7+
export 'ad_unit_widget.dart' show AdUnitWidget;

‎packages/google_adsense/lib/src/core/adsense_code_parameters.dart‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
// Copyright 2013 The Flutter Authors. All rights reserved.
2+
// Use of this source code is governed by a BSD-style license that can be
3+
// found in the LICENSE file.
4+
5+
/// Configuration for various settings for game ads.
6+
///
7+
/// These are set as `data`-attributes in the AdSense script tag.
8+
class AdSenseCodeParameters {
9+
/// Builds an AdSense code parameters object.
10+
///
11+
/// The following parameters are available:
12+
///
13+
/// * [adHost]: If you share your revenue with a host platform, use this parameter
14+
/// to specify the host platform.
15+
/// * [admobInterstitialSlot]: If your game runs in a mobile app, use this parameter
16+
/// to request interstitial ads.
17+
/// * [admobRewardedSlot]: If your game runs in a mobile app, use this parameter
18+
/// to request rewarded ads.
19+
/// * [adChannel]: You may include a
20+
/// [custom channel ID](https://support.google.com/adsense/answer/10078316)
21+
/// for tracking the performance of your ads.
22+
/// * [adbreakTest]: Set this parameter to `'on'` to enable testing mode. This
23+
/// lets you test your placements using fake ads.
24+
/// * [tagForChildDirectedTreatment]: Use this parameter if you want to tag your
25+
/// ad requests for treatment as child directed. For more information, refer to:
26+
/// [Tag a site or ad request for child-directed treatment](https://support.google.com/adsense/answer/3248194).
27+
/// * [tagForUnderAgeOfConsent]: Use this parameter if you want to tag your
28+
/// European Economic Area (EEA), Switzerland, and UK ad requests for restricted
29+
/// data processing treatment. For more information, refer to:
30+
/// [Tag an ad request for EEA and UK users under the age of consent (TFUA)](https://support.google.com/adsense/answer/9009582).
31+
/// * [adFrequencyHint]: The minimum average time interval between ads expressed
32+
/// in seconds. If this value is `'120s'` then ads will not be shown more
33+
/// frequently than once every two minutes on average. Note that this is a hint
34+
/// that could be ignored or overridden by a server control in future.
35+
///
36+
/// For more information about these parameters, check
37+
/// [AdSense code parameter descriptions](https://support.google.com/adsense/answer/9955214#adsense_code_parameter_descriptions).
38+
AdSenseCodeParameters({
39+
String? adHost,
40+
String? admobInterstitialSlot,
41+
String? admobRewardedSlot,
42+
String? adChannel,
43+
String? adbreakTest,
44+
String? tagForChildDirectedTreatment,
45+
String? tagForUnderAgeOfConsent,
46+
String? adFrequencyHint,
47+
}) : _adSenseCodeParameters = <String, String>{
48+
if (adHost != null) 'adHost': adHost,
49+
if (admobInterstitialSlot != null)
50+
'admobInterstitialSlot': admobInterstitialSlot,
51+
if (admobRewardedSlot != null) 'admobRewardedSlot': admobRewardedSlot,
52+
if (adChannel != null) 'adChannel': adChannel,
53+
if (adbreakTest != null) 'adbreakTest': adbreakTest,
54+
if (tagForChildDirectedTreatment != null)
55+
'tagForChildDirectedTreatment': tagForChildDirectedTreatment,
56+
if (tagForUnderAgeOfConsent != null)
57+
'tagForUnderAgeOfConsent': tagForUnderAgeOfConsent,
58+
if (adFrequencyHint != null) 'adFrequencyHint': adFrequencyHint,
59+
};
60+
61+
final Map<String, String> _adSenseCodeParameters;
62+
63+
/// `Map` representation of this configuration object.
64+
Map<String, String> get toMap => _adSenseCodeParameters;
65+
}

‎packages/google_adsense/lib/src/core/google_adsense.dart‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,34 @@ import 'package:flutter/widgets.dart';
66
import 'package:web/web.dart' as web;
77

88
import '../utils/logging.dart';
9+
import 'adsense_code_parameters.dart';
910
import 'js_interop/js_loader.dart';
1011

12+
export 'adsense_code_parameters.dart' show AdSenseCodeParameters;
13+
1114
/// The web implementation of the AdSense API.
1215
class AdSense {
1316
bool _isInitialized = false;
1417

1518
/// The [Publisher ID](https://support.google.com/adsense/answer/2923881).
1619
late String adClient;
1720

21+
/// The (optional)
22+
/// [AdSense Code Parameters](https://support.google.com/adsense/answer/9955214#adsense_code_parameter_descriptions).
23+
AdSenseCodeParameters? adSenseCodeParameters;
24+
1825
/// Initializes the AdSense SDK with your [adClient].
1926
///
2027
/// The [adClient] parameter is your AdSense [Publisher ID](https://support.google.com/adsense/answer/2923881).
2128
///
29+
/// The [adSenseCodeParameters] let you configure various settings for your
30+
/// ads. All parameters are optional. See
31+
/// [AdSense code parameter descriptions](https://support.google.com/adsense/answer/9955214#adsense_code_parameter_descriptions).
32+
///
2233
/// Should be called ASAP, ideally in the `main` method.
23-
//
24-
// TODO(dit): Add the "optional AdSense code parameters", and render them
25-
// in the right location (the script tag for h5 + the ins for display ads).
26-
// See: https://support.google.com/adsense/answer/9955214?hl=en#adsense_code_parameter_descriptions
2734
Future<void> initialize(
2835
String adClient, {
36+
AdSenseCodeParameters? adSenseCodeParameters,
2937
@visibleForTesting bool skipJsLoader = false,
3038
@visibleForTesting web.HTMLElement? jsLoaderTarget,
3139
}) async {
@@ -34,8 +42,13 @@ class AdSense {
3442
return;
3543
}
3644
this.adClient = adClient;
45+
this.adSenseCodeParameters = adSenseCodeParameters;
3746
if (!skipJsLoader) {
38-
await loadJsSdk(adClient, jsLoaderTarget);
47+
await loadJsSdk(
48+
adClient,
49+
target: jsLoaderTarget,
50+
dataAttributes: adSenseCodeParameters?.toMap,
51+
);
3952
} else {
4053
debugLog('initialize called with skipJsLoader. Skipping loadJsSdk.');
4154
}

0 commit comments

Comments
 (0)