flutter · sokoloff06 · Jun 5, 2024 · Jun 5, 2024 · Jul 21, 2024 · Jul 21, 2024
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -18,6 +18,7 @@ packages/flutter_migrate/**                              @stuartmorgan
 packages/flutter_template_images/**                      @stuartmorgan
 packages/go_router/**                                    @chunhtai
 packages/go_router_builder/**                            @chunhtai
+packages/google_adsense/**                               @sokoloff06
 packages/google_identity_services_web/**                 @ditman
 packages/google_maps_flutter/**                          @stuartmorgan
 packages/google_sign_in/**                               @stuartmorgan

diff --git a/README.md b/README.md
diff --git a/packages/google_adsense/AUTHORS b/packages/google_adsense/AUTHORS
@@ -0,0 +1,7 @@
+# Below is a list of people and organizations that have contributed
+# to the Flutter project. Names should be added to the list like so:
+#
+#   Name/Organization <email address>
+
+Google Inc.
+The Chromium Authors
diff --git a/packages/google_adsense/CHANGELOG.md b/packages/google_adsense/CHANGELOG.md
@@ -0,0 +1,3 @@
+## 0.0.1
+
+* Initial release.
diff --git a/packages/google_adsense/LICENSE b/packages/google_adsense/LICENSE
@@ -0,0 +1,25 @@
+Copyright 2013 The Flutter Authors. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+    * Neither the name of Google Inc. nor the names of its
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/packages/google_adsense/README.md b/packages/google_adsense/README.md
@@ -0,0 +1,60 @@
+# google_adsense
+[Google AdSense](https://adsense.google.com/intl/en_us/start/) plugin for Flutter Web
+
+Generally integration with AdSense requires:
+
+1. Adding an [AdSense code](https://support.google.com/adsense/answer/9274634?hl=en&ref_topic=28893&sjid=9002959242386336076-EU) usually in between the `<head></head>` tag to connect your site with AdSense account. Allows using **Auto ads**
+2.  Adding [ad unit code](https://support.google.com/adsense/answer/9274025?sjid=9002959242386336076-EU) in between the `<body><body/>` tags of your pages where you want ad to appear. Ad unit code snippet is unique per **ad unit** that you need to create in your AdSense account first. You might have several ad units added to your website
+
+Since Flutter apps are not rendered as traditional HTML pages and there is no easy way to access final DOM tree from Dart, this plugin provides an `AdUnitWidget` that you can configure and place in the desired location in your app UI
+
+
+## Installation
+run `flutter pub add google_adsense`
+
+## Usage
+#### Initialize AdSense
+Before displaying ads, initialize the AdSense with your ad client ID.
+<?code-excerpt "example/lib/main.dart (init)"?>
+```dart
+import 'package:google_adsense/google_adsense.dart';
+
+void main() {
+  Adsense().initialize('your_ad_client_id');
+  runApp(const MyApp());
+}
+
+```
+#### Display AdUnitWidget
+<?code-excerpt "example/lib/main.dart (adUnit)"?>
+```dart
+Adsense().adUnit(
+    adSlot: 'your_ad_slot_id',
+    isAdTest: true,
+    adUnitParams: <String, dynamic>{
+      AdUnitParams.AD_FORMAT: 'auto',
+      AdUnitParams.FULL_WIDTH_RESPONSIVE: true,
+    },
+    cssText:
+        'border: 5px solid red; display: block; padding: 20px'),
+```
+## Testing and common errors
+
+### Failed to load resource: the server responded with a status of 400
+Make sure to replace `your_ad_client_id` and `your_ad_slot_id` with the relevant values
+
+### Failed to load resource: the server responded with a status of 403
+1. When happening in **testing/staging** environment it is likely related to the fact that ads are only filled when requested from an authorized domain. If you are testing locally, you can specify additional run arguments in IDE my editing `Run/Debug Configuration` or by passing them directly to `flutter run` command:  
+    `--web-port=8080`  
+    `--web-hostname=your-domain.com`
+2. When happening in **production** it might be that your domain was not yet approved or was disapproved. Login to your AdSense account to check your domain approval status
+
+### Ad unfilled  
+
+There is no deterministic way to make sure your ads are 100% filled even when testing. Some of the way to increase the fill rate:
+
+
+- Add AD_TEST parameter with value `true`  
+- Make sure AD_FORMAT is `auto` (default setting)
+- Make sure FULL_WIDTH_RESPONSIVE is `true` (default setting)
+- Try resizing the window or making sure that adUnitWidget width is less than ~1300px 
diff --git a/packages/google_adsense/dart_test.yaml b/packages/google_adsense/dart_test.yaml
@@ -0,0 +1,6 @@
+## See https://github.com/dart-lang/test/blob/master/pkgs/test/doc/configuration.md#arguments
+#override_platforms:
+#  chrome:
+#    settings:
+#      executable: /Applications/Google Chrome.app/Contents/MacOS/Google Chrome
+#      arguments: --no-sandbox
diff --git a/packages/google_adsense/example/README.md b/packages/google_adsense/example/README.md
@@ -0,0 +1,10 @@
+# google_adsense_example
+
+An example demonstrating google_adsense Flutter plugin usage
+
+## Screenshots
+
+![Screenshot of the test app showing an ad on mobile](../example/images/mobile_screenshot.png)
+![Screenshot of the test app showing an ad on desktop](../example/images/desktop_screenshot.jpg)
+
+
diff --git a/packages/google_adsense/example/images/desktop_screenshot.jpg b/packages/google_adsense/example/images/desktop_screenshot.jpg
diff --git a/packages/google_adsense/example/images/mobile_screenshot.png b/packages/google_adsense/example/images/mobile_screenshot.png
diff --git a/packages/google_adsense/example/integration_test/ad_widget_rendering_test.dart b/packages/google_adsense/example/integration_test/ad_widget_rendering_test.dart
@@ -0,0 +1,52 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+// TO run the test:
+// 1. Run chrome driver with --port=4444
+// 2. Run the test from example folder with: flutter drive -d web-server --web-port 7357 --browser-name chrome --driver test_driver/integration_test.dart --target integration_test/ad_widget_rendering_test.dart
+
+import 'package:flutter/widgets.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:google_adsense/google_adsense.dart';
+import 'package:integration_test/integration_test.dart';
+import 'package:web/web.dart' as web;
+
+const String testClient = 'test_client';
+const String testSlot = 'test_slot';
+
+void main() async {
+  IntegrationTestWidgetsFlutterBinding.ensureInitialized();
+
+  setUp(() async {
+    Adsense.resetForTesting();
+  });
+
+  group('adWidget', () {
+    testWidgets('AdUnitWidget is created and rendered',
+        (WidgetTester tester) async {
+      // When
+      // TODO(sokoloff06): Mock server response as ./test_ad.html
+
+      Adsense().initialize(testClient);
+      final Widget adUnitWidget = Adsense().adUnit(adSlot: testSlot);
+      await tester.pumpWidget(adUnitWidget);
+      await tester.pumpWidget(
+          adUnitWidget); // TODO(sokoloff06): Why only works when pumping twice?
+      // Then
+      // Widget level
+      expect(find.byWidget(adUnitWidget), findsOneWidget);
+      expect(adUnitWidget, isA<AdUnitWidget>());
+
+      // DOM level
+      final web.HTMLElement? platformView =
+          web.document.querySelector('flt-platform-view') as web.HTMLElement?;
+      expect(platformView, isNotNull);
+      final web.HTMLElement ins =
+          platformView!.getElementsByTagName('ins').item(0)! as web.HTMLElement;
+      expect(ins.style.display, 'block');
+
+      // TODO(sokoloff06): Validate response is rendered
+    });
+  });
+}