feat: add publisherProvidedSignals for Google Ad Manager PPS

Author: 0xRomain

__tests__/requestOptions.test.tsx

@@ -1,4 +1,82 @@
+import { validateAdRequestOptions } from '../src/validateAdRequestOptions';
+
 describe('Admob RequestOptions', () => {
-  // eslint-disable-next-line jest/no-disabled-tests
-  test.skip('skip', () => {});
+  describe('publisherProvidedSignals', () => {
+    it('throws if publisherProvidedSignals is not an object', () => {
+      expect(() =>
+        validateAdRequestOptions({
+          // @ts-ignore
+          publisherProvidedSignals: 'not-an-object',
+        }),
+      ).toThrow("'options.publisherProvidedSignals' expected an object of key/value pairs");
+    });
+
+    it('throws if a publisherProvidedSignals value is not an array', () => {
+      expect(() =>
+        validateAdRequestOptions({
+          // @ts-ignore
+          publisherProvidedSignals: { IAB_CONTENT_2_2: 'not-an-array' },
+        }),
+      ).toThrow("'options.publisherProvidedSignals.IAB_CONTENT_2_2' expected an array of numbers");
+    });
+
+    it('sets publisherProvidedSignals if valid', () => {
+      const result = validateAdRequestOptions({
+        publisherProvidedSignals: { IAB_CONTENT_2_2: [533, 483, 1020] },
+      });
+      expect(result.publisherProvidedSignals).toEqual({
+        IAB_CONTENT_2_2: [533, 483, 1020],
+      });
+    });
+
+    it('passes through multiple signal keys', () => {
+      const pps = {
+        IAB_CONTENT_2_2: [533, 483],
+        IAB_AUDIENCE_1_1: [6, 7],
+      };
+      const result = validateAdRequestOptions({ publisherProvidedSignals: pps });
+      expect(result.publisherProvidedSignals).toEqual(pps);
+    });
+
+    it('does not set publisherProvidedSignals if not provided', () => {
+      const result = validateAdRequestOptions({});
+      expect(result.publisherProvidedSignals).toBeUndefined();
+    });
+  });
+
+  describe('publisherProvidedId', () => {
+    it('throws if publisherProvidedId is not a string', () => {
+      expect(() =>
+        validateAdRequestOptions({
+          // @ts-ignore
+          publisherProvidedId: 123,
+        }),
+      ).toThrow("'options.publisherProvidedId' expected a string value");
+    });
+
+    it('sets publisherProvidedId if valid', () => {
+      const result = validateAdRequestOptions({
+        publisherProvidedId: 'user-abc-123',
+      });
+      expect(result.publisherProvidedId).toBe('user-abc-123');
+    });
+  });
+
+  describe('customTargeting', () => {
+    it('throws if customTargeting is not an object', () => {
+      expect(() =>
+        validateAdRequestOptions({
+          // @ts-ignore
+          customTargeting: 'not-an-object',
+        }),
+      ).toThrow("'options.customTargeting' expected an object of key/value pairs");
+    });
+
+    it('sets customTargeting if valid', () => {
+      const result = validateAdRequestOptions({
+        customTargeting: { key: 'value' },
+      });
+      expect(result.customTargeting).toEqual({ key: 'value' });
+    });
+  });
 });

android/src/main/java/io/invertase/googlemobileads/ReactNativeGoogleMobileAdsCommon.java

@@ -23,7 +23,9 @@
 import android.view.ViewGroup;
 import com.facebook.react.bridge.Arguments;
 import com.facebook.react.bridge.ReactContext;
+import com.facebook.react.bridge.ReadableArray;
 import com.facebook.react.bridge.ReadableMap;
+import com.facebook.react.bridge.ReadableMapKeySetIterator;
 import com.facebook.react.bridge.WritableMap;
 import com.google.ads.mediation.admob.AdMobAdapter;
 import com.google.android.gms.ads.AdError;
@@ -167,6 +169,20 @@ public static AdManagerAdRequest buildAdRequest(ReadableMap adRequestOptions) {
       }
     }
 
+    if (adRequestOptions.hasKey("publisherProvidedSignals")) {
+      ReadableMap ppsMap = adRequestOptions.getMap("publisherProvidedSignals");
+      ReadableMapKeySetIterator iterator = ppsMap.keySetIterator();
+      while (iterator.hasNextKey()) {
+        String key = iterator.nextKey();
+        ReadableArray values = ppsMap.getArray(key);
+        ArrayList<Integer> intValues = new ArrayList<>();
+        for (int i = 0; i < values.size(); i++) {
+          intValues.add(values.getInt(i));
+        }
+        extras.putIntegerArrayList(key, intValues);
+      }
+    }
+
     builder.addNetworkExtrasBundle(AdMobAdapter.class, extras);
 
     if (adRequestOptions.hasKey("keywords")) {

ios/RNGoogleMobileAds/RNGoogleMobileAdsCommon.mm

@@ -65,6 +65,13 @@ + (GAMRequest *)buildAdRequest:(NSDictionary *)adRequestOptions {
     }
   }
 
+  if (adRequestOptions[@"publisherProvidedSignals"]) {
+    NSDictionary *pps = adRequestOptions[@"publisherProvidedSignals"];
+    for (NSString *key in pps) {
+      extras[key] = pps[key];
+    }
+  }
+
   GADExtras *networkExtras = [[GADExtras alloc] init];
   networkExtras.additionalParameters = extras;
   [request registerAdNetworkExtras:networkExtras];

src/types/RequestOptions.ts

@@ -106,4 +106,32 @@ export interface RequestOptions {
    * See [this article](https://support.google.com/admanager/answer/2880055) for more information.
    */
   publisherProvidedId?: string;
+
+  /**
+   * Publisher Provided Signals (PPS) for Google Ad Manager.
+   *
+   * PPS allows publishers to send IAB taxonomy signals to help ad buyers
+   * evaluate and bid on inventory more effectively.
+   *
+   * Keys are IAB taxonomy names (e.g. `IAB_CONTENT_2_2`, `IAB_AUDIENCE_1_1`).
+   * Values are arrays of taxonomy IDs as integers.
+   *
+   * On Android, values are passed as `putIntegerArrayList` in the extras Bundle.
+   * On iOS, values are passed as `NSArray<NSNumber>` in GADExtras.
+   *
+   * @see https://developers.google.com/ad-manager/mobile-ads-sdk/android/targeting#publisher_provided_signals
+   * @see https://developers.google.com/ad-manager/mobile-ads-sdk/ios/targeting#publisher_provided_signals
+   *
+   * #### Example
+   *
+   * ```js
+   * await Interstitial.createForAdRequest('/12345/ad-unit', {
+   *   publisherProvidedSignals: {
+   *     IAB_CONTENT_2_2: [533, 483],    // Soccer, Sports
+   *     IAB_AUDIENCE_1_1: [6, 284],     // Sports & Fitness, Soccer
+   *   },
+   * });
+   * ```
+   */
+  publisherProvidedSignals?: { [key: string]: number[] };
 }

src/validateAdRequestOptions.ts

@@ -136,5 +136,19 @@ export function validateAdRequestOptions(options?: RequestOptions) {
     out.publisherProvidedId = options.publisherProvidedId;
   }
 
+  if (options.publisherProvidedSignals) {
+    if (!isObject(options.publisherProvidedSignals)) {
+      throw new Error("'options.publisherProvidedSignals' expected an object of key/value pairs");
+    }
+
+    Object.entries(options.publisherProvidedSignals).forEach(([key, value]) => {
+      if (!isArray(value)) {
+        throw new Error(`'options.publisherProvidedSignals.${key}' expected an array of numbers`);
+      }
+    });
+
+    out.publisherProvidedSignals = options.publisherProvidedSignals;
+  }
+
   return out;
 }