react-native-applovin-max 6.0.0 → 6.0.1

package/android/build.gradle

@@ -35,8 +35,8 @@ android {
   defaultConfig {
     minSdkVersion 16
     targetSdkVersion getExtOrIntegerDefault('targetSdkVersion')
-    versionCode 6000000
-    versionName "6.0.0"
+    versionCode 6000100
+    versionName "6.0.1"
   }
 
   flavorDimensions("default")

package/ios/Podfile

@@ -35,6 +35,6 @@ target 'AppLovinMAX' do
   pod 'glog', :podspec => '../node_modules/react-native/third-party-podspecs/glog.podspec'
   pod 'Folly', :podspec => '../node_modules/react-native/third-party-podspecs/Folly.podspec'
 
-  pod 'AppLovinSDK', '11.11.3'
+  pod 'AppLovinSDK', '11.11.4'
 
 end

package/ios/Podfile.lock

@@ -1,5 +1,5 @@
 PODS:
-  - AppLovinSDK (11.11.3)
+  - AppLovinSDK (11.11.4)
   - boost-for-react-native (1.63.0)
   - DoubleConversion (1.1.6)
   - FBLazyVector (0.63.5)
@@ -249,7 +249,7 @@ PODS:
   - Yoga (1.14.0)
 
 DEPENDENCIES:
-  - AppLovinSDK (= 11.11.3)
+  - AppLovinSDK (= 11.11.4)
   - DoubleConversion (from `../node_modules/react-native/third-party-podspecs/DoubleConversion.podspec`)
   - FBLazyVector (from `../node_modules/react-native/Libraries/FBLazyVector`)
   - FBReactNativeSpec (from `../node_modules/react-native/Libraries/FBReactNativeSpec`)
@@ -339,7 +339,7 @@ EXTERNAL SOURCES:
     :path: "../node_modules/react-native/ReactCommon/yoga"
 
 SPEC CHECKSUMS:
-  AppLovinSDK: 623ef78363c0dd2c3ff5446cde37e4920a96b7e0
+  AppLovinSDK: 5c667a790725d9529c01c3f3acf12ab195865fbb
   boost-for-react-native: 39c7adb57c4e60d6c5479dd8623128eb5b3f0f2c
   DoubleConversion: cde416483dac037923206447da6e1454df403714
   FBLazyVector: 352a8ca9bbc8e2f097d680747a8c97ecef12d469
@@ -368,6 +368,6 @@ SPEC CHECKSUMS:
   ReactCommon: b9ff54b6dd22ba4a776eda22d7f83ec27544ca35
   Yoga: 0276e9f20976c8568e107cfc1163a8629051adc0
 
-PODFILE CHECKSUM: 0e638fe64c425ebeff3ccbfd5c809f3b35246730
+PODFILE CHECKSUM: 76a08f1862fba288a559d37757b6d80d45c19d6e
 
-COCOAPODS: 1.12.1
+COCOAPODS: 1.11.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-native-applovin-max",
   "author": "AppLovin Corporation",
-  "version": "6.0.0",
+  "version": "6.0.1",
   "description": "AppLovin MAX React Native Plugin for Android and iOS",
   "homepage": "https://github.com/AppLovin/AppLovin-MAX-React-Native",
   "license": "MIT",

package/react-native-applovin-max.podspec

@@ -11,10 +11,10 @@ Pod::Spec.new do |s|
   s.authors      = package["author"]
 
   s.platforms    = { :ios => "10.0" }
-  s.source       = { :git => "https://github.com/AppLovin/AppLovin-MAX-React-Native.git", :tag => "release_6_0_0" }
+  s.source       = { :git => "https://github.com/AppLovin/AppLovin-MAX-React-Native.git", :tag => "release_6_0_1" }
   
   s.source_files  = "ios/AppLovinMAX*.{h,m}"
 
   s.dependency "React"
-  s.dependency "AppLovinSDK", "11.11.3"
+  s.dependency "AppLovinSDK", "11.11.4"
 end

package/src/AdView.tsx

@@ -39,7 +39,7 @@ export enum AdFormat {
 }
 
 /**
- * Defines a position of a banner and MREC ad.
+ * Defines a position of a banner or MREC ad.
  */
 export enum AdViewPosition {
     TOP_CENTER = TOP_CENTER_POSITION,
@@ -126,11 +126,11 @@ const sizeAdViewDimensions = (adFormat: AdFormat, adaptiveBannerEnabled?: boolea
 }
 
 /**
- * The {@link AdView} component for building a banner or a MREC.  Banners are sized to 320x50 on phones
- * and 728x90 on tablets.  MRECs are sized to 300x250 on phones and tablets.  You may use the
- * utility method `AppLovinMAX.isTablet()` to help with view sizing adjustments.  For adaptive
- * banners, call `BannerAd.getAdaptiveHeightForWidth(width)` to get the banner height, and then adjust
- * your content accordingly.
+ * The {@link AdView} component that you use building a banner or an MREC. Phones
+ * sizes banners to 320x50 and MRECs to 300x250. Tablets sizes banners to 728x90 and MRECs to
+ * 300x250. You may use the utility method {@link AppLovinMAX.isTablet()} to help with view sizing
+ * adjustments. For adaptive banners, call {@link BannerAd.getAdaptiveHeightForWidth()} to get
+ * the banner height, and then adjust your content accordingly.
  *
  * ### Example:
  * ```js
@@ -244,7 +244,7 @@ export const AdView = ({
             onAdExpandedEvent={onAdExpandedEvent}
             onAdCollapsedEvent={onAdCollapsedEvent}
             onAdRevenuePaidEvent={onAdRevenuePaidEvent}
-            style={{ ...(style as ViewProps), ...dimensions }}
+            style={Object.assign({}, style, dimensions)}
             {...otherProps}
         />
     );

package/src/AppLovinMAX.ts

@@ -4,7 +4,7 @@ import type { Configuration } from "./types/Configuration";
 
 const NativeAppLovinMAX = NativeModules.AppLovinMAX;
 
-const VERSION = "6.0.0";
+const VERSION = "6.0.1";
 
 const initialize = async (
     sdkKey: string

package/src/TargetingData.ts

@@ -1,4 +1,5 @@
 import { NativeModules } from "react-native";
+import type { TargetingDataType } from "./types/TargetingData";
 
 const { AppLovinMAX } = NativeModules;
 
@@ -43,126 +44,171 @@ export enum UserGender {
 }
 
 /**
- * This class allows you to provide user or app data that will improve how we target ads.
+ * Defines additional data for the publisher to send to AppLovin.
+ *
+ * @see {@link https://support.applovin.com/hc/en-us/articles/13964925614733-Data-and-Keyword-Passing}
  */
-export const TargetingData = {
+export const TargetingData: TargetingDataType = {
 
     /**
-     *  Sets the year of birth of the user.  Sets 0 to clear this value.
+     * Sets the year of birth of the user. Set this to 0 to clear this value.
      */
-    set yearOfBirth(value: number) {
-        nativeMethods.setTargetingDataYearOfBirth(value);
+    set yearOfBirth(value: number | Promise<number>) {
+        if (typeof value === 'number') {
+            nativeMethods.setTargetingDataYearOfBirth(value);
+        } else {
+            printError("TargetingData.yearOfBirth", "number", typeof value);
+        }
     },
 
     /**
-     *  Gets the year of birth of the user.
+     * Gets the year of birth of the user.
      */
-    get yearOfBirth(): Promise<number> {
+    get yearOfBirth(): number | Promise<number> {
         return nativeMethods.getTargetingDataYearOfBirth();
     },
 
     /**
-     * Sets the gender of the user.  Sets {UserGender.Unknown} to clear this value.
+     * Sets the gender of the user. Set this to {@link UserGender.Unknown} to clear this value.
      */
-    set gender(value: UserGender) {
+    set gender(value: UserGender | Promise<UserGender>) {
         if (value === UserGender.Unknown ||
             value === UserGender.Female ||
             value === UserGender.Male ||
             value === UserGender.Other) {
             nativeMethods.setTargetingDataGender(value);
+        } else {
+            printError("TargetingData.gender", "UserGender", typeof value);
         }
     },
 
     /**
      * Gets the gender of the user.
      */
-    get gender(): Promise<UserGender> {
+    get gender(): UserGender | Promise<UserGender> {
         return nativeMethods.getTargetingDataGender().then((value: string) => {
             return value as UserGender;
         });
     },
 
     /**
-     * Sets the maximum ad content rating shown to the user.  Sets {AdContentRating.None} to clear this value.
+     * Sets the maximum ad content rating shown to the user. The levels are based on IQG Media
+     * Ratings: 1=All Audiences, 2=Everyone Over 12, 3=Mature Audiences.  
+     * Set this to {@link AdContentRating.None} to clear this value.
      */
-    set maximumAdContentRating(value: AdContentRating) {
+    set maximumAdContentRating(value: AdContentRating | Promise<AdContentRating>) {
         if (value === AdContentRating.None ||
             value === AdContentRating.AllAudiences ||
             value === AdContentRating.EveryoneOverTwelve ||
             value === AdContentRating.MatureAudiences) {
             nativeMethods.setTargetingDataMaximumAdContentRating(value);
+        } else {
+            printError("TargetingData.maximumAdContentRating", "AdContentRating", typeof value);
         }
     },
 
     /**
-     * Gets the maximum ad content rating shown to the user.
+     * Gets the maximum ad content rating shown to the user. The levels are based on IQG Media
+     * Ratings: 1=All Audiences, 2=Everyone Over 12, 3=Mature Audiences.
      */
-    get maximumAdContentRating(): Promise<AdContentRating> {
+    get maximumAdContentRating(): AdContentRating | Promise<AdContentRating> {
         return nativeMethods.getTargetingDataMaximumAdContentRating().then((value: number) => {
             return value as AdContentRating;
         });
     },
 
     /**
-     * Sets the email of the user.  Sets null to clear this value.
+     * Sets the email of the user. Set this to null to clear this value.
      */
-    set email(value: string | null) {
-        nativeMethods.setTargetingDataEmail(value);
+    set email(value: string | null | Promise<string | null>) {
+        if (value === null) {
+            nativeMethods.setTargetingDataEmail(null);
+        } else if (typeof value === 'string') {
+            nativeMethods.setTargetingDataEmail(value as string);
+        } else {
+            printError("TargetingData.email", "string or null", typeof value);
+        }
     },
 
     /**
      * Gets the email of the user.
      */
-    get email(): Promise<string | null> {
+    get email(): string | null | Promise<string | null> {
         return nativeMethods.getTargetingDataEmail();
     },
 
     /**
-     * Sets the phone number of the user.  Sets null to clear this value.
+     * Sets the phone number of the user. Set this to null to clear this value.
      */
-    set phoneNumber(value: string | null) {
-        nativeMethods.setTargetingDataPhoneNumber(value);
+    set phoneNumber(value: string | null | Promise<string | null>) {
+        if (value === null) {
+            nativeMethods.setTargetingDataPhoneNumber(null);
+        } else if ( typeof value === 'string') {
+            nativeMethods.setTargetingDataPhoneNumber(value as string);
+        } else {
+            printError("TargetingData.phoneNumber", "string or null", typeof value);
+        }
     },
 
     /**
      * Gets the phone number of the user.
      */
-    get phoneNumber(): Promise<string | null> {
+    get phoneNumber(): string | null | Promise<string | null> {
         return nativeMethods.getTargetingDataPhoneNumber();
     },
 
     /**
-     * Sets the keywords describing the application.  Sets null to clear this value.
+     * Sets the keywords describing the application. Set this to null to clear this value.
      */
-    set keywords(value: string[] | null) {
-        nativeMethods.setTargetingDataKeywords(value);
+    set keywords(value: string[] | null | Promise<string[]> | null) {
+        if (value === null) {
+            nativeMethods.setTargetingDataKeywords(null);
+        } else if (isStringArray(value)) {
+            nativeMethods.setTargetingDataKeywords(value as string[]);
+        } else {
+            printError("TargetingData.keywords", "string[] or null", typeof value);
+        }
     },
 
     /**
      * Gets the keywords describing the application.
      */
-    get keywords(): Promise<string[] | null> {
+    get keywords(): string[] | null | Promise<string[] | null> {
         return nativeMethods.getTargetingDataKeywords();
     },
 
     /**
-     * Sets the interests of the user.  Sets null to clear this value.
+     * Sets the interests of the user. Set this to null to clear this value.
      */
-    set interests(value: string[] | null) {
-        nativeMethods.setTargetingDataInterests(value);
+    set interests(value: string[] | null | Promise<string[] | null>) {
+        if (value === null) {
+            nativeMethods.setTargetingDataInterests(null);
+        } else if (isStringArray(value)) {
+            nativeMethods.setTargetingDataInterests(value as string[]);
+        } else {
+            printError("TargetingData.interests", "string[] or null", typeof value);
+        }
     },
 
     /**
      * Gets the interests of the user.
      */
-    get interests(): Promise<string[] | null> {
+    get interests(): string[] | null | Promise<string[] | null> {
         return nativeMethods.getTargetingDataInterests();
     },
 
     /**
-     *  Clear all saved data from this class.
+     * Clears all saved data from this class.
      */
     clearAll(): void {
         nativeMethods.clearAllTargetingData();
     },
 }
+
+const isStringArray = (strs: any): boolean => {
+    return Array.isArray(strs) && strs.every((value) => typeof value === 'string')
+}
+
+const printError = (fieldName: string, correctType: string, wrongType: string) => {
+    console.error("Cannot set value to " +  fieldName + " with unsupported type: " + wrongType  + ".  Value has to be of type " + correctType + ".");
+}

package/src/nativeAd/NativeAdView.tsx

@@ -20,8 +20,8 @@ type NativeAdViewNativeEvents = {
 const NativeAdViewComponent = requireNativeComponent<NativeAdViewProps & ViewProps & NativeAdViewNativeEvents>('AppLovinMAXNativeAdView');
 
 /**
- * The {@link NativeAdView} component for building a native ad. This loads a native ad and renders it with
- * the asset views:
+ * The {@link NativeAdView} component that you use building a native ad. This loads a native ad and
+ * renders it with the asset views:
  *
  * - {@link IconView}
  * - {@link TitleView}
@@ -31,8 +31,9 @@ const NativeAdViewComponent = requireNativeComponent<NativeAdViewProps & ViewPro
  * - {@link MediaView}
  * - {@link CallToActionView}
  *
- * Each asset view will be filled with the data of a native ad when loaded, but you need to provide
- * the layout and style of the asset views.  A new native ad can be re-loaded via the ref handler.
+ * {@link NativeAdView} fills each asset view with the data of a native ad as soon as it loads the native
+ * ad, but you need to provide the layout and style of the asset views.
+ * {@link NativeAdView} can reload a new native ad by using the ref handler.
  * 
  * ### Example:
  * ```js

package/src/nativeAd/NativeAdViewComponents.tsx

@@ -1,4 +1,4 @@
-import React, { useContext, useRef, useEffect } from "react";
+import React, { useContext, useRef, useEffect, type ReactNode } from "react";
 import { findNodeHandle, Text, Image, View, TouchableOpacity, StyleSheet } from "react-native";
 import type { ViewProps, ImageProps, TextStyle, StyleProp } from "react-native";
 import { NativeAdViewContext } from "./NativeAdViewProvider";
@@ -159,7 +159,7 @@ export const StarRatingView = (props: ViewProps) => {
     return (
         <View {...restProps} style={[style, { flexDirection: 'row', alignItems: 'center' }]}>
             {(() => {
-                let stars = [];
+                let stars: ReactNode[] = [];
                 for (let index = 0; index < maxStarCount; index++) {
                     if (nativeAd.starRating) {
                         const width = (nativeAd.starRating - index) * starSize;

package/src/types/AdInfo.ts

@@ -9,17 +9,17 @@ export type AdInfo = {
     adUnitId: string;
 
     /**
-     * The creative id tied to the ad, if any. You can report creative issues to the corresponding
-     * ad network using this id.
+     * The creative ID tied to the ad, if any. You can report creative issues to the corresponding
+     * ad network using this ID.
      *
-     * @see {@link https://dash.applovin.com/documentation/mediation/react-native/testing-networks/creative-debugger#creative-id}
+     * @see {@link https://support.applovin.com/hc/en-us/articles/13986039797389-Creative-Debugger#h_01HC10588YYDNZMS1GPCVRD2E7}
      */
     creativeId?: string | null;
 
     /**
      * The ad network from which this ad was loaded.
      *
-     * @see {@link https://dash.applovin.com/documentation/mediation/react-native/testing-networks/creative-debugger#network-name}
+     * @see {@link https://support.applovin.com/hc/en-us/articles/13986039797389-Creative-Debugger#h_01HC10588YWTJHYE1E35HWQTX7}
      */
     networkName: string;
 
@@ -31,12 +31,12 @@ export type AdInfo = {
 
     /**
      *  The ad’s revenue amount. In the case where no revenue amount exists, or it is not available
-     *  yet, will return a value of 0.
+     *  yet, return 0.
      */
     revenue: number;
 
     /**
-     * The DSP network that provided the loaded ad when the ad is served through AppLovin Exchange.
+     * The DSP network that provides the loaded ad when the ad is served through AppLovin Exchange.
      */
     dspName?: string | null;
 
@@ -136,7 +136,7 @@ export type AdRewardInfo = AdInfo & {
 };
 
 /**
- * Represents a revenue given to the user.
+ * Represents revenue given to the publisher.
  */
 export type AdRevenueInfo = AdInfo & {
 
@@ -158,7 +158,7 @@ export type AdRevenueInfo = AdInfo & {
     revenuePrecision: string;
 
     /**
-     * The current country code.
+     * The current country code where the ad was shown.
      */
     countryCode: string;
 };
@@ -169,47 +169,47 @@ export type AdRevenueInfo = AdInfo & {
 export type AdNativeInfo = {
 
     /**
-     * The native ad title text.
+     * The native ad title text for {@link TitleView}.
      */
     title?: string;
 
     /**
-     * The native ad advertiser text.
+     * The native ad advertiser text for {@link AdvertiserView}.
      */
     advertiser?: string;
 
     /**
-     * The native ad body text.
+     * The native ad body text for {@link BodyView}}.
      */
     body?: string;
 
     /**
-     * The native ad CTA button text.
+     * The native ad CTA (call to action) text for {@link CallToActionView}.
      */
     callToAction?: string;
 
     /**
-     * The star rating of the native ad.
+     * The star rating of the native ad in the [0.0, 5.0] range for {@link StarRatingView}, if provided by the network.
      */
     starRating?: number;
 
     /**
-     * The aspect ratio for the media view if provided by the network.
+     * The aspect ratio (width-to-height) for {@link MediaView} if provided by the network.
      */
     mediaContentAspectRatio?: number;
 
     /**
-     * Whether or not the icon is available.
+     * Whether or not the content for {@link IconView} is available.
      */
     isIconImageAvailable: boolean;
 
     /**
-     * Whether or not the Options view is available.
+     * Whether or not the content for {@link OptionsView} is available.
      */
     isOptionsViewAvailable: boolean;
 
     /**
-     * Whether or not the Media view is available.
+     * Whether or not the content for {@link MediaView} is available.
      */
     isMediaViewAvailable: boolean;
 };
@@ -243,8 +243,8 @@ export type AdWaterfallInfo = {
 };
 
 /**
- * This enum contains possible states of an ad in the waterfall the adapter response info could
- * represent.
+ * This enum contains possible states of an ad in the waterfall. 
+ * Each adapter response {@link AdNetworkResponseInfo} corresponds to one of these states.
  */
 export enum AdLoadState {
 
@@ -292,7 +292,7 @@ export type AdErrorInfo = {
 export type AdNetworkResponseInfo = {
 
     /**
-     * The state of the ad that this object represents.  For more info, see the {@link AdLoadState} enum.
+     * The state of the ad that this object represents. For more info, see the {@link AdLoadState} enum.
      */
     adLoadState: AdLoadState;
 
@@ -308,15 +308,15 @@ export type AdNetworkResponseInfo = {
 
     /**
      * The ad load error this network response resulted in. Will be unavailable if an attempt to
-     * load an ad has not been made or an ad was loaded successfully (i.e. the loadState is NOT
-     * LoadStateAdFailedToLoad).
+     * load an ad has not been made or an ad was loaded successfully (i.e. {@link adLoadState} 
+     * is NOT LoadStateAdFailedToLoad).
      */
     error?: AdErrorInfo;
 
     /**
-     * The amount of time the network took to load (either successfully or not) an ad, in
-     * milliseconds. If an attempt to load an ad has not been made (i.e. the loadState is
-     * LoadStateAdLoadNotAttempted), the value will be -1.
+     * The amount of time the network took to load (either successfully or not) an ad, in milliseconds. 
+     * If an attempt to load an ad has not been made (i.e. {@link adLoadState} is LoadStateAdLoadNotAttempted), 
+     * the value will be -1.
      */
     latencyMillis: number;
 };

package/src/types/AdProps.ts

@@ -6,7 +6,7 @@ import type { AdDisplayFailedInfo, AdInfo, AdLoadFailedInfo, AdRevenueInfo } fro
 export type AdProps = {
 
     /**
-     * A string value representing the ad unit id to load ads for.
+     * A string value representing the ad unit ID to load ads for.
      */
     adUnitId: string;
 
@@ -34,27 +34,27 @@ export type AdProps = {
     localExtraParameters?: { [key: string]: any };
 
     /**
-     * A callback fuction to be fired when a new ad has been loaded.
+     * A callback fuction that {@link Adview} or {@link NativeAdView} fires when it loads a new ad.
      */
     onAdLoaded?: (adInfo: AdInfo) => void;
 
     /**
-     * A callback fuction to be fired when an ad could not be retrieved.
+     * A callback fuction that {@link Adview} or {@link NativeAdView} fires when it could not load a new ad.
      */
     onAdLoadFailed?: (error: AdLoadFailedInfo) => void;
 
     /**
-     * A callback fuction to be fired when the ad failed to display.
+     * A callback fuction that {@link Adview} or {@link NativeAdView} fires when it fails to display the ad.
      */
     onAdDisplayFailed?: (error: AdDisplayFailedInfo) => void;
 
     /**
-     * A callback fuction to be fired when ad is clicked.
+     * A callback fuction that {@link Adview} or {@link NativeAdView} fires when the user clicks the ad.
      */
     onAdClicked?: (adInfo: AdInfo) => void;
 
     /**
-     * A callback fuction to be fired when the revenue event is detected.
+     * A callback fuction that {@link Adview} or {@link NativeAdView} fires when it pays ad revenue to the publisher.
      */
     onAdRevenuePaid?: (adInfo: AdRevenueInfo) => void;
 };

package/src/types/AdViewProps.ts

@@ -8,7 +8,7 @@ import type { AdFormat } from "../AdView";
 export type AdViewProps = AdProps & {
 
     /**
-     * A string value representing the ad format to load ads for. Should be either 
+     * An enum value representing the ad format to load ads for. Should be either 
      * {@link AdFormat.BANNER} or {@link AdFormat.MREC}.
      */
     adFormat: AdFormat;
@@ -25,12 +25,12 @@ export type AdViewProps = AdProps & {
     autoRefresh?: boolean;
 
     /**
-     * A callback fuction to be fired when the ad view is expanded.
+     * A callback fuction that {@link AdView} fires when it expands the ad.
      */
     onAdExpanded?: (adInfo: AdInfo) => void;
 
     /**
-     * A callback fuction to be fired when the ad view is collapsed.
+     * A callback fuction that {@link AdView} fires when it collapses the ad.
      */
     onAdCollapsed?: (adInfo: AdInfo) => void;
 };

package/src/types/AppLovinMAX.ts

@@ -6,14 +6,15 @@ import type { Configuration } from "./Configuration";
 export type AppLovinMAXType = {
 
     /**
-     * Whether the SDK has fully been initialized without errors and the completion callback called.
+     * Indicates whether or not the AppLovinMAX SDK has fully initialized without errors and 
+     * {@link AppLovinMAX.initialize()} has called the completion callback.
      */
     isInitialized(): Promise<boolean>;
 
     /**
-     * Initializes the SDK, and returns Configuration when it finishes initializing.
+     * Initializes the AppLovinMAX SDK, and returns {@link Configuration} when it finishes initializing.
      * 
-     * @param sdkKey SDK key to use for the instance of the AppLovin SDK.
+     * @param sdkKey SDK key to use for the instance of the AppLovinMAX SDK.
      */
     initialize(sdkKey: string): Promise<Configuration>;
 
@@ -28,7 +29,7 @@ export type AppLovinMAXType = {
     isTablet(): Promise<boolean>;
 
     /**
-     * Sets an id for the current user.  This identifier will be tied to SDK events and AppLovin’s
+     * Sets an ID for the current user. AppLovin ties this identifier to SDK events and AppLovin’s
      * optional S2S postbacks.
      * 
      * @param userId User id.
@@ -36,7 +37,7 @@ export type AppLovinMAXType = {
     setUserId(userId: string): void;
 
     /**
-     * Sets a muted state or not for beginning video ads.
+     * Sets a muted state (or not) as the initial state for video ads.
      *
      * @param muted If ads should begin in a muted state.
      */
@@ -48,29 +49,29 @@ export type AppLovinMAXType = {
     isMuted(): Promise<boolean>;
 
     /**
-     * A toggle for verbose logging for the SDK.
+     * A toggle for verbose logging for the AppLovinMAX SDK.
      *
-     * @param verboseLoggingEnabled True if log messages should be output.
+     * @param verboseLoggingEnabled true if the AppLovinMAX SDK should output log messages.
      */
     setVerboseLogging(verboseLoggingEnabled: boolean): void;
 
     /**
-     * Enable devices to receive test ads by passing in the advertising identifier (IDFA) of each
-     * test device.  Refer to AppLovin logs for the IDFA of your current device.
+     * Enables devices to receive test ads by passing in the advertising identifier (IDFA) of each
+     * test device. Refer to AppLovin logs for the IDFA of your current device.
      * 
      * @param advertisingIds A list of the advertising ids.
      */
     setTestDeviceAdvertisingIds(advertisingIds: string[]): void;
 
     /**
-     * Whether the Creative Debugger will be displayed after flipping the device screen down twice.
+     * Whether the Creative Debugger displays after you flip the device screen down twice.
      *
      * @param enabled Default to true.
      */
     setCreativeDebuggerEnabled(enabled: boolean): void;
 
     /**
-     * Set an extra parameter to pass to the AppLovin server.
+     * Sets an extra parameter to pass to the AppLovin server.
      * 
      * @param key Parameter key.
      * @param value Parameter value.
@@ -78,7 +79,7 @@ export type AppLovinMAXType = {
     setExtraParameter(key: string, value: string | null): void;
 
     /**
-     * Whether or not the SDK will collect the device location.
+     * Whether or not the AppLovinMAX SDK collects the device location.
      *
      * @param enabled Defaults to true.
      */

package/src/types/BannerAd.ts

@@ -8,8 +8,8 @@ export type BannerAdType = ViewAdType & {
      * 
      * @param adUnitId The Ad Unit ID to load ads for.
      * @param position {@ AdViewPosition} position.
-     * @param xOffset Offset from the left corner.
-     * @param yOffset Offset from the top corner.
+     * @param xOffset Horizontal offset from the left position.
+     * @param yOffset Vertical offset from the top position.
      */
     createAd(adUnitId: string, position: AdViewPosition, xOffset?: number, yOffset?: number): void;
 
@@ -33,8 +33,8 @@ export type BannerAdType = ViewAdType & {
      * Updates the banner position offsets.
      * 
      * @param adUnitId The Ad Unit ID to load ads for.
-     * @param xOffset Offset from the left corner.
-     * @param yOffset Offset from the top corner.
+     * @param xOffset Horizontal offset from the left position.
+     * @param yOffset Vertical offset from the top position.
      */
     updateOffsets(adUnitId: string, xOffset: number, yOffset: number): void;
 

package/src/types/Configuration.ts

@@ -1,5 +1,5 @@
 /**
- * Encapsulates various data for the SDK configuration.
+ * Encapsulates data for the AppLovinMAX SDK configuration.
  */
 export type Configuration = {
 

package/src/types/FullscreenAd.ts

@@ -2,29 +2,29 @@ import type { AdEventListener } from "./AdEvent";
 import type { AdInfo, AdLoadFailedInfo, AdRevenueInfo, AdDisplayFailedInfo } from "./AdInfo";
 
 /**
- * Define a fullscreen ad (i.e Intestitial / Rewarded / AppOpen)
+ * Defines a full-screen ad (i.e Intestitial / Rewarded / AppOpen)
  */
 export type FullscreenAdType = {
 
     /**
      * Whether or not this ad is ready to be shown.
      * 
-     * @param adUnitId The Ad Unit ID to load ads for.
+     * @param adUnitId The ad unit ID of the ad to check whether it is ready to be shown.
      */
     isAdReady(adUnitId: string): Promise<boolean>;
 
     /**
      * Loads an interstitial ad.
      * 
-     * @param adUnitId The Ad Unit ID to load ads for.
+     * @param adUnitId The ad unit ID to load an ad for.
      */
     loadAd(adUnitId: string): void;
 
     /**
-     * Show the loaded interstitial ad, optionallly for a given placement and custom data to tie ad
+     * Shows the loaded interstitial ad, optionallly for a given placement and custom data to tie ad
      * events to.
      * 
-     * @param adUnitId The Ad Unit ID to load ads for.
+     * @param adUnitId The ad unit ID of the ad to show.
      * @param placement The placement to tie the showing ad's events to.
      * @param customData The custom data to tie the showing ad's events to. Maximum size is 8KB.
      */
@@ -33,103 +33,109 @@ export type FullscreenAdType = {
     /**
      * Sets an extra key/value parameter for the ad.
      * 
-     * @param adUnitId The Ad Unit ID to load ads for.
+     * @param adUnitId The ad unit ID of the ad to set a parameter for.
      * @param key Parameter key.
      * @param value Parameter value.
      */
     setExtraParameter(adUnitId: string, key: string, value: string | null): void;
 
     /**
-     * Set a local extra parameter to pass to the adapter instances.
+     * Sets a local extra parameter to pass to the adapter instances.
      *
-     * @param adUnitId The Ad Unit ID to load ads for.
+     * @param adUnitId The ad unit ID of the ad to set a local parameter for.
      * @param key Parameter key.
      * @param value Parameter value.
      */
     setLocalExtraParameter(adUnitId: string, key: string, value: any): void;
 
     /**
-     * Adds the specified event listener to receive {@link AdInfo} when a new ad has been loaded.
+     * Adds the specified event listener to receive {@link AdInfo} when a full-screen ad loads a new ad.
      * 
      * @param listener Listener to be notified.
      */
     addAdLoadedEventListener(listener: AdEventListener<AdInfo>): void;
 
     /**
-     * Removes the event listener to receive {@link AdInfo} when a new ad has been loaded.
+     * Removes the event listener to receive {@link AdInfo} when a full-screen ad loads a new ad.
      */
     removeAdLoadedEventListener(): void;
 
     /**
-     * Adds the specified event listener to receive {@link AdLoadFailedInfo} when an ad could not be loaded.
+     * Adds the specified event listener to receive {@link AdLoadFailedInfo} when a full-screen ad
+     * could not load a new ad.
      * 
      * @param listener Listener to be notified.
      */
     addAdLoadFailedEventListener(listener: AdEventListener<AdLoadFailedInfo>): void;
 
     /**
-     * Removes the event listener to receive {@ link adLoadFailedInfo} when an ad could not be loaded.
+     * Removes the event listener to receive {@ link adLoadFailedInfo} when a full-screen ad could
+     * not load a new ad.
       */
     removeAdLoadFailedEventListener(): void;
 
     /**
-     * Adds the specified event listener to receive {@link AdInfo} when the ad is clicked.
+     * Adds the specified event listener to receive {@link AdInfo} when the user clicks the ad.
      * 
      * @param listener Listener to be notified.
      */
     addAdClickedEventListener(listener: AdEventListener<AdInfo>): void;
 
     /**
-     * Removes the event listener to receive {@link AdInfo} when the ad is clicked.
+     * Removes the event listener to receive {@link AdInfo} when the user clicks the ad.
      */
     removeAdClickedEventListener(): void;
 
     /**
-     * Adds the specified event listener to receive {@link AdInfo} when the ad is displayed.
+     * Adds the specified event listener to receive {@link AdInfo} when a full-screen ad displays the ad.
      * 
      * @param listener Listener to be notified.
      */
     addAdDisplayedEventListener(listener: AdEventListener<AdInfo>): void;
 
     /**
-     * Removes the event listener to receive {@link AdInfo} when the ad is displayed.
+     * Removes the event listener to receive {@link AdInfo} when a full-screen ad displays the ad.
      */
     removeAdDisplayedEventListener(): void;
 
     /**
-     * Adds the specified event listener to receive {@link AdDisplayFailedInfo} when the ad is failed to
-     * display.
+     * Adds the specified event listener to receive {@link AdDisplayFailedInfo} when a full-screen
+     * ad fails to display the ad.
      * 
      * @param listener Listener to be notified.
      */
     addAdFailedToDisplayEventListener(listener: AdEventListener<AdDisplayFailedInfo>): void;
 
     /**
-     * Removes the event listener to receive {@link AdDisplayFailedInfo} when the ad is failed to display.
+     * Removes the event listener to receive {@link AdDisplayFailedInfo} when a full-screen ad
+     * fails to display the ad.
      */
     removeAdFailedToDisplayEventListener(): void;
 
     /**
-     * Adds the specified event listener to receive {@link AdInfo} when the ad is hidden.
+     * Adds the specified event listener to receive {@link AdInfo} when a full-screen ad hides the
+     * ad.
      * 
      * @param listener Listener to be notified.
      */
     addAdHiddenEventListener(listener: AdEventListener<AdInfo>): void;
 
     /**
-     * Removes the event listener to receive {@link AdInfo} when the ad is hidden.
+     * Removes the event listener to receive {@link AdInfo} when a full-screen ad hides the ad.
      */
     removeAdHiddenEventListener(): void;
 
-    /**
-     * Adds the specified event listener to receive {@link AdRevenueInfo} when the ad revenue is paid.
+    /** 
+     * Adds the specified event listener to receive {@link AdRevenueInfo} when a full-screen ad 
+     * pays ad revenue to the publisher.
      * 
      * @param listener Listener to be notified.
      */
     addAdRevenuePaidListener(listener: AdEventListener<AdRevenueInfo>): void;
 
     /**
-     * Removes the event listener to receive {@link AdRevenueInfo} when the ad revenue is paid.
+     * Removes the event listener to receive {@link AdRevenueInfo} when a full-screen ad pays 
+     * ad revenue to the publisher.
      */
     removeAdRevenuePaidListener(): void;
 };

package/src/types/Privacy.ts

@@ -5,19 +5,19 @@ export type PrivacyType = {
     /**********************************************************************************/
 
     /**
-     * Show the user consent dialog to the user using one from AppLovin's SDK.
+     * Shows the user consent dialog to the user by using a dialog in the AppLovinMAX SDK.
      */
     showConsentDialog(): Promise<void>;
 
     /**
-     * Sets whether or not the user has provided consent for information-sharing with AppLovin.
+     * Sets whether or not the user provided consent for information-sharing with AppLovin.
      * 
-     * @param hasUserConsent true if the user has provided consent for information sharing.
+     * @param hasUserConsent true if the user provided consent for information sharing.
      */
     setHasUserConsent(hasUserConsent: boolean): void;
 
     /**
-     * Checks if user has set consent for information sharing.
+     * Checks if user set consent for information sharing.
      */
     hasUserConsent(): Promise<boolean>;
 
@@ -34,14 +34,14 @@ export type PrivacyType = {
     isAgeRestrictedUser(): Promise<boolean>;
 
     /**
-     * Sets whether or not the user has opted out of the sale of their personal information.
+     * Sets whether or not the user opted out of the sale of their personal information.
      * 
-     * @param doNotSell true if the user has opted out of the sale of their personal information.
+     * @param doNotSell true if the user opted out of the sale of their personal information.
      */
     setDoNotSell(doNotSell: boolean): void;
 
     /**
-     * Checks if the user has opted out of the sale of their personal information.
+     * Checks if the user opted out of the sale of their personal information.
      */
     isDoNotSell(): Promise<boolean>;
 
@@ -50,22 +50,23 @@ export type PrivacyType = {
     /**********************************************************************************/
 
     /**
-     * Enable the MAX Terms Flow.
+     * Enables the MAX Terms Flow.
      *
-     * @param enabled Enable the MAX Terms Flow.
+     * @param enabled true to enable the MAX Terms Flow.
      */
     setConsentFlowEnabled(enabled: boolean): Promise<void>;
 
     /**
-     * URL for your company’s privacy policy. This is required in order to enable the Terms Flow.
+     * The URL of your company’s privacy policy, as a string. This is required in order to enable
+     * the Terms Flow.
      * 
      * @param urlString The URL string to point your company’s privacy policy.
      */
     setPrivacyPolicyUrl(urlString: string): Promise<void>;
 
     /**
-     * URL for your company’s terms of service. This is optional; you can enable the Terms Flow with
-     * or without it.
+     * The URL of your company’s terms of service, as a string. This is optional; you can enable 
+     * the Terms Flow with or without it.
      * 
      * @param urlString The URL string to point your company’s terms of service. 
      */

package/src/types/RewardedAd.ts

@@ -5,14 +5,16 @@ import type { FullscreenAdType } from "./FullscreenAd";
 export type RewardedAdType = FullscreenAdType & {
 
     /**
-     * Adds the specified event listener to receive {@link AdRewardInfo} when the ad is rewarded.
+     * Adds the specified event listener to receive {@link AdRewardInfo} when {@link RewardedAd}
+     * rewards the user.
      * 
      * @param listener Listener to be notified.
      */
     addAdReceivedRewardEventListener(listener: AdEventListener<AdRewardInfo>): void;
 
     /**
-     * Removes the event listener to receive {@link AdRewardInfo} when the ad is rewarded.
+     * Removes the event listener to receive {@link AdRewardInfo} when {@link RewardedAd} rewards
+     * the user.
      */
     removeAdReceivedRewardEventListener(): void;
 };

package/src/types/TargetingData.ts

@@ -0,0 +1,51 @@
+import type { AdContentRating, UserGender } from "src/TargetingData";
+
+/**
+ * Defines additional data for the publisher to send to AppLovin.
+ *
+ * @see {@link https://support.applovin.com/hc/en-us/articles/13964925614733-Data-and-Keyword-Passing}
+ */
+export type TargetingDataType = {
+
+    /**
+     * Sets the year of birth of the user. Set this to 0 to clear this value.
+     */
+    yearOfBirth: number | Promise<number>;
+
+    /**
+     * Sets the gender of the user. Set this to {@link UserGender.Unknown} to clear this value.
+     */
+    gender: UserGender | Promise<UserGender>;
+
+    /**
+     * Sets the maximum ad content rating shown to the user. The levels are based on IQG Media
+     * Ratings: 1=All Audiences, 2=Everyone Over 12, 3=Mature Audiences.
+     * Set this to {@link AdContentRating.None} to clear this value.
+     */
+    maximumAdContentRating: AdContentRating | Promise<AdContentRating>;
+
+    /**
+     * Sets the email of the user. Set this to null to clear this value.
+     */
+    email: string | null | Promise<string | null>;
+
+    /**
+     * Sets the phone number of the user. Set this to null to clear this value.
+     */
+    phoneNumber: string | null | Promise<string | null>;
+
+    /**
+     * Sets the keywords describing the application. Set this to null to clear this value.
+     */
+    keywords: string[] | null | Promise<string[] | null>;
+
+    /**
+     * Sets the interests of the user. Set this to null to clear this value.
+     */
+    interests: string[] | null | Promise<string[] | null>;
+
+    /**
+     * Clears all saved data from this class.
+     */
+    clearAll(): void;
+};

package/src/types/ViewAd.ts

@@ -3,35 +3,35 @@ import type { AdInfo, AdLoadFailedInfo, AdRevenueInfo } from "./AdInfo";
 import type { AdViewPosition } from "../AdView";
 
 /**
- * Define a view based ad (i.e. Banner / MREC)
+ * Define a view-based ad (i.e. Banner / MREC)
  */
 export type ViewAdType = {
 
     /**
-     * Destroys the banner/mrec.
+     * Destroys the banner/MREC.
      * 
-     * @param adUnitId The Ad Unit ID to  to load ads for.
+     * @param adUnitId The ad unit ID of the ad to destroy.
      */
     destroyAd(adUnitId: string): void;
 
     /**
-     * Shows the banner/mrec.
+     * Shows the banner/MREC.
      * 
-     * @param adUnitId The Ad Unit ID to  to load ads for.
+     * @param adUnitId The ad unit ID of the ad to show.
      */
     showAd(adUnitId: string): void;
 
     /**
-     * Hides the banner/mrec.
+     * Hides the banner/MREC.
      * 
-     * @param adUnitId The Ad Unit ID to  to load ads for.
+     * @param adUnitId The ad unit ID of the ad to hide.
      */
     hideAd(adUnitId: string): void;
 
     /**
      * Sets a placement to tie the showing ad’s events to.
      *
-     * @param adUnitId The Ad Unit ID to  to load ads for.
+     * @param adUnitId The ad unit ID of the ad to set a placement for.
      * @param placement The placement to tie the showing ad's events to.
      */
     setPlacement(adUnitId: string, placement: string | null): void;
@@ -39,7 +39,7 @@ export type ViewAdType = {
     /**
      * Sets custom data to tie the showing ad’s events to.
      * 
-     * @param adUnitId The Ad Unit ID to  to load ads for.
+     * @param adUnitId The ad unit ID of the ad to set custom data for.
      * @param customData The custom data to tie the showing ad's events to. Maximum size is 8KB.
      */
     setCustomData(adUnitId: string, customData: string | null): void;
@@ -47,7 +47,7 @@ export type ViewAdType = {
     /**
      * Updates the banner/mrec position.
      * 
-     * @param adUnitId The Ad Unit ID to  to load ads for.
+     * @param adUnitId The ad unit ID of the ad to update the position of.
      * @param bannerPosition {@link AdViewPosition} position.
      */
     updatePosition(adUnitId: string, bannerPosition: AdViewPosition): void;
@@ -55,7 +55,7 @@ export type ViewAdType = {
     /**
      * Sets an extra key/value parameter for the ad.
      * 
-     * @param adUnitId The Ad Unit ID to  to load ads for.
+     * @param adUnitId The ad unit ID of the ad to set a parameter for.
      * @param key Key parameter.
      * @param value Value parameter.
      */
@@ -64,7 +64,7 @@ export type ViewAdType = {
     /**
      * Set a local extra parameter to pass to the adapter instances.
      * 
-     * @param adUnitId The Ad Unit ID to  to load ads for.
+     * @param adUnitId The ad unit ID of the ad to set a local parameter for.
      * @param key Key parameter.
      * @param value Value parameter.
      */
@@ -73,86 +73,90 @@ export type ViewAdType = {
     /**
      * Starts or resumes auto-refreshing of the banner/mrec.
      * 
-     * @param adUnitId The Ad Unit ID to  to load ads for.
+     * @param adUnitId The ad unit ID of the ad to start or resume auto-refreshing.
      */
     startAutoRefresh(adUnitId: string): void;
 
     /**
      * Pauses auto-refreshing of the banner/mrec.
      * 
-     * @param adUnitId The Ad Unit ID to  to load ads for.
+     * @param adUnitId The ad unit ID of the ad to stop auto-refreshing.
      */
     stopAutoRefresh(adUnitId: string): void;
 
     /**
-     * Adds the specified event listener to receive {@link AdInfo} when a new ad has been loaded.
+     * Adds the specified event listener to receive {@link AdInfo} when a view-base ad loads a new ad.
      * 
      * @param listener Listener to be notified.
      */
     addAdLoadedEventListener(listener: AdEventListener<AdInfo>): void;
 
     /**
-     * Removes the event listener to receive {@link AdInfo} when a new ad has been loaded.
+     * Removes the event listener to receive {@link AdInfo} when a view-base ad loads a new ad.
      */
     removeAdLoadedEventListener(): void;
 
     /**
-     * Adds the specified event listener to receive {@link AdLoadFailedInfo} when an ad could not be loaded.
+     * Adds the specified event listener to receive {@link AdLoadFailedInfo} when a view-base ad
+     * could not load a new ad.
      * 
      * @param listener Listener to be notified.
      */
     addAdLoadFailedEventListener(listener: AdEventListener<AdLoadFailedInfo>): void;
 
     /**
-     * Removes the event listener to receive {@link AdLoadFailedInfo} when an ad could not be loaded.
+     * Removes the event listener to receive {@link AdLoadFailedInfo} when a view-base ad could not
+     * load a new ad.
      */
     removeAdLoadFailedEventListener(): void;
 
     /**
-     * Adds the specified event listener to receive {@link AdInfo} when the ad is clicked.
+     * Adds the specified event listener to receive {@link AdInfo} when the user clicks the ad.
      * 
      * @param listener Listener to be notified.
      */
     addAdClickedEventListener(listener: AdEventListener<AdInfo>): void;
 
     /**
-     * Removes the event listener to receive {@link AdInfo} when the ad is clicked.
+     * Removes the event listener to receive {@link AdInfo} when the user clicks the ad.
      */
     removeAdClickedEventListener(): void;
 
     /**
-     * Adds the specified event listener to receive {@link AdInfo} when the ad is collapsed.
+     * Adds the specified event listener to receive {@link AdInfo} when a view-base ad collapses the ad.
      * 
      * @param listener Listener to be notified.
      */
     addAdCollapsedEventListener(listener: AdEventListener<AdInfo>): void;
 
     /**
-     * Removes the event listener to receive {@link AdInfo} when the ad is collapsed.
+     * Removes the event listener to receive {@link AdInfo} when a view-base ad collapses the ad.
      */
     removeAdCollapsedEventListener(): void;
 
     /**
-     * Adds the specified event listener to receive {@link AdInfo} when the ad is expanded.
+     * Adds the specified event listener to receive {@link AdInfo} when a view-base ad expands the ad.
      * 
      * @param listener Listener to be notified.
      */
     addAdExpandedEventListener(listener: AdEventListener<AdInfo>): void;
 
     /**
-     * Removes the event listener to receive {@link AdInfo} when the ad is expanded.
+     * Removes the event listener to receive {@link AdInfo} when a view-base ad expands the ad.
      */
     removeAdExpandedEventListener(): void;
 
     /**
-     * Adds the specified event listener to receive {@link AdRevenueInfo} when the ad revenue is paid.
+     * Adds the specified event listener to receive {@link AdRevenueInfo} when a view-base ad pays
+     * ad revenue to the publisher.
      * 
      * @param listener Listener to be notified.
      */
     addAdRevenuePaidListener(listener: AdEventListener<AdRevenueInfo>): void;
 
     /**
-     * Removes the event listener to receive {@link AdRevenueInfo} when the ad revenue is paid.
+     * Removes the event listener to receive {@link AdRevenueInfo} when when a view-base ad pays ad
+     * revenue to the publisher.
      */
     removeAdRevenuePaidListener(): void;
 };