react-native-applovin-max 6.0.0 → 6.0.2

package/src/types/AdProps.ts

@@ -1,12 +1,16 @@
-import type { AdDisplayFailedInfo, AdInfo, AdLoadFailedInfo, AdRevenueInfo } from "./AdInfo";
+import type { AdDisplayFailedInfo, AdInfo, AdLoadFailedInfo, AdRevenueInfo } from './AdInfo';
+
+/**
+ * Local extra parameters can be of type: string, number, boolean, array, map, and null.
+ */
+export type LocalExtraParameterValue = string | number | boolean | object | null;
 
 /**
  * Defines the base properties for the UI component ads i.e {@link Adview} and {@link NativeAdView}.
  */
 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;
 
@@ -31,30 +35,30 @@ export type AdProps = {
      * A dictionary value representing the local extra parameters to set a list of key-value pairs
      * to pass to the adapter instances.
      */
-    localExtraParameters?: { [key: string]: any };
+    localExtraParameters?: { [key: string]: LocalExtraParameterValue };
 
     /**
-     * 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

@@ -1,14 +1,13 @@
-import type { AdProps } from "./AdProps";
-import type { AdInfo } from "./AdInfo";
-import type { AdFormat } from "../AdView";
+import type { AdProps } from './AdProps';
+import type { AdInfo } from './AdInfo';
+import type { AdFormat } from '../AdView';
 
 /**
  * Represents an {@link AdView} - Banner / MREC.
  */
 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 +24,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

@@ -1,19 +1,19 @@
-import type { Configuration } from "./Configuration";
+import type { Configuration } from './Configuration';
 
 /**
  * Represents the AppLovinMAX module.
  */
 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.
-     * 
-     * @param sdkKey SDK key to use for the instance of the AppLovin SDK.
+     * Initializes the AppLovinMAX SDK, and returns {@link Configuration} when it finishes initializing.
+     *
+     * @param sdkKey SDK key to use for the instance of the AppLovinMAX SDK.
      */
     initialize(sdkKey: string): Promise<Configuration>;
 
@@ -28,15 +28,15 @@ 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.
      */
     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,39 +48,39 @@ 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.
      */
     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.
      */
-    setLocationCollectionEnabled(enabled: boolean): Promise<void>;
+    setLocationCollectionEnabled(enabled: boolean): void;
 };

package/src/types/AppOpenAd.ts

@@ -1,3 +1,3 @@
-import type { FullscreenAdType } from "./FullscreenAd";
+import type { FullscreenAdType } from './FullscreenAd';
 
 export type AppOpenAdType = FullscreenAdType;

package/src/types/BannerAd.ts

@@ -1,21 +1,20 @@
-import type { ViewAdType } from "./ViewAd";
-import type { AdViewPosition } from "../AdView";
+import type { ViewAdType } from './ViewAd';
+import type { AdViewPosition } from '../AdView';
 
 export type BannerAdType = ViewAdType & {
-
     /**
      * Creates a banner at the specified position and offsets.
-     * 
+     *
      * @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;
 
     /**
-     * Sets a background color for the banner.  
-     * 
+     * Sets a background color for the banner.
+     *
      * @param adUnitId The Ad Unit ID to load ads for.
      * @param hexColorCode Hexadecimal color (#rrggbb).
      */
@@ -23,7 +22,7 @@ export type BannerAdType = ViewAdType & {
 
     /**
      * Sets the banner width.
-     * 
+     *
      * @param adUnitId The Ad Unit ID to load ads for.
      * @param width The desired banner width.
      */
@@ -31,16 +30,16 @@ 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;
 
     /**
      * Gets the adaptive banner size for the provided width at the current orientation.
-     * 
+     *
      * @param width The banner width.
      */
     getAdaptiveHeightForWidth(width: number): Promise<number>;

package/src/types/Configuration.ts

@@ -1,11 +1,9 @@
 /**
- * Encapsulates various data for the SDK configuration.
+ * Encapsulates data for the AppLovinMAX SDK configuration.
  */
 export type Configuration = {
-
     /**
-     * The country code of this user. 
+     * The country code of this user.
      */
     countryCode: string;
 };
-

package/src/types/FullscreenAd.ts

@@ -1,30 +1,30 @@
-import type { AdEventListener } from "./AdEvent";
-import type { AdInfo, AdLoadFailedInfo, AdRevenueInfo, AdDisplayFailedInfo } from "./AdInfo";
+import type { AdEventListener } from './AdEvent';
+import type { AdInfo, AdLoadFailedInfo, AdRevenueInfo, AdDisplayFailedInfo } from './AdInfo';
+import type { LocalExtraParameterValue } from './AdProps';
 
 /**
- * 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.
      */
@@ -32,104 +32,110 @@ 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;
+    setLocalExtraParameter(adUnitId: string, key: string, value: LocalExtraParameterValue): 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/InterstitialAd.ts

@@ -1,3 +1,3 @@
-import type { FullscreenAdType } from "./FullscreenAd";
+import type { FullscreenAdType } from './FullscreenAd';
 
 export type InterstitialAdType = FullscreenAdType;

package/src/types/MRecAd.ts

@@ -1,11 +1,10 @@
-import type { ViewAdType } from "./ViewAd";
-import type { AdViewPosition } from "../AdView";
+import type { ViewAdType } from './ViewAd';
+import type { AdViewPosition } from '../AdView';
 
 export type MRecAdType = ViewAdType & {
-
     /**
      * Creates a MREC at the specified position.
-     * 
+     *
      * @param adUnitId The Ad Unit ID to  to load ads for.
      * @param position {@link AdViewPosition} position.
      */

package/src/types/NativeAd.ts

@@ -1,8 +1,7 @@
 /**
- * Represents a native ad for rendering `NativeAdView`.  Internal use only. 
+ * Represents a native ad for rendering `NativeAdView`.  Internal use only.
  */
 export type NativeAd = {
-
     /**
      * The native ad title text.
      */

package/src/types/NativeAdViewProps.ts

@@ -1,10 +1,9 @@
-import type { AdProps } from "./AdProps";
+import type { AdProps } from './AdProps';
 
 /**
  * A handler of {@link NativeAdView}.
  */
 export type NativeAdViewHandler = {
-
     /**
      * Loads a native ad.
      */

package/src/types/Privacy.ts

@@ -1,29 +1,23 @@
 export type PrivacyType = {
-
     /**********************************************************************************/
     /* Privacy */
     /**********************************************************************************/
 
     /**
-     * Show the user consent dialog to the user using one from AppLovin's SDK.
-     */
-    showConsentDialog(): Promise<void>;
-
-    /**
-     * Sets whether or not the user has provided consent for information-sharing with AppLovin.
-     * 
-     * @param hasUserConsent true if the user has provided consent for information sharing.
+     * Sets whether or not the user provided consent for information-sharing with AppLovin.
+     *
+     * @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>;
 
     /**
      * Marks the user as age-restricted (i.e. under 16).
-     * 
+     *
      * @param isAgeRestrictedUser true if the user is age restricted (i.e. under 16).
      */
     setIsAgeRestrictedUser(isAgeRestrictedUser: boolean): void;
@@ -34,14 +28,14 @@ export type PrivacyType = {
     isAgeRestrictedUser(): Promise<boolean>;
 
     /**
-     * Sets whether or not the user has 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.
+     * Sets whether or not the user 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,24 +44,25 @@ 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.
-     * 
-     * @param urlString The URL string to point your company’s terms of service. 
+     * 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.
      */
     setTermsOfServiceUrl(urlString: string): Promise<void>;
 };

package/src/types/RewardedAd.ts

@@ -1,18 +1,19 @@
-import type { AdEventListener } from "./AdEvent";
-import type { AdRewardInfo } from "./AdInfo";
-import type { FullscreenAdType } from "./FullscreenAd";
+import type { AdEventListener } from './AdEvent';
+import type { AdRewardInfo } from './AdInfo';
+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,50 @@
+import type { AdContentRating, UserGender } from '../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;
+};