react-native-applovin-max 5.7.2 → 6.0.1

package/src/types/FullscreenAd.ts

@@ -0,0 +1,141 @@
+import type { AdEventListener } from "./AdEvent";
+import type { AdInfo, AdLoadFailedInfo, AdRevenueInfo, AdDisplayFailedInfo } from "./AdInfo";
+
+/**
+ * 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 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 an ad for.
+     */
+    loadAd(adUnitId: string): void;
+
+    /**
+     * Shows the loaded interstitial ad, optionallly for a given placement and custom data to tie ad
+     * events to.
+     * 
+     * @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.
+     */
+    showAd(adUnitId: string, placement?: string | null, customData?: string | null): void;
+
+    /**
+     * Sets an extra key/value parameter for the ad.
+     * 
+     * @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;
+
+    /**
+     * Sets a local extra parameter to pass to the adapter instances.
+     *
+     * @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 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 full-screen ad loads a new ad.
+     */
+    removeAdLoadedEventListener(): void;
+
+    /**
+     * 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 a full-screen ad could
+     * not load a new ad.
+      */
+    removeAdLoadFailedEventListener(): void;
+
+    /**
+     * 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 user clicks the ad.
+     */
+    removeAdClickedEventListener(): void;
+
+    /**
+     * 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 a full-screen ad displays the ad.
+     */
+    removeAdDisplayedEventListener(): void;
+
+    /**
+     * 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 a full-screen ad
+     * fails to display the ad.
+     */
+    removeAdFailedToDisplayEventListener(): void;
+
+    /**
+     * 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 a full-screen ad hides the ad.
+     */
+    removeAdHiddenEventListener(): void;
+
+    /** 
+     * 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 a full-screen ad pays 
+     * ad revenue to the publisher.
+     */
+    removeAdRevenuePaidListener(): void;
+};

package/src/types/InterstitialAd.ts

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

package/src/types/MRecAd.ts

@@ -0,0 +1,13 @@
+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.
+     */
+    createAd(adUnitId: string, position: AdViewPosition): void;
+};

package/src/types/NativeAd.ts

@@ -0,0 +1,50 @@
+/**
+ * Represents a native ad for rendering `NativeAdView`.  Internal use only. 
+ */
+export type NativeAd = {
+
+    /**
+     * The native ad title text.
+     */
+    title?: string | null;
+
+    /**
+     * The native ad advertiser text.
+     */
+    advertiser?: string | null;
+
+    /**
+     * The native ad body text.
+     */
+    body?: string | null;
+
+    /**
+     * The native ad CTA button text.
+     */
+    callToAction?: string | null;
+
+    /**
+     * Whether or not this has an image icon.
+     */
+    image?: boolean;
+
+    /**
+     * The URL string of the icon.
+     */
+    url?: string | null;
+
+    /**
+     * The star rating of the native ad.
+     */
+    starRating?: number | null;
+
+    /**
+     * Whether or not the Options view is available.
+     */
+    isOptionsViewAvailable: boolean;
+
+    /**
+     * Whether or not the Media view is available.
+     */
+    isMediaViewAvailable: boolean;
+};

package/src/types/NativeAdViewProps.ts

@@ -0,0 +1,17 @@
+import type { AdProps } from "./AdProps";
+
+/**
+ * A handler of {@link NativeAdView}.
+ */
+export type NativeAdViewHandler = {
+
+    /**
+     * Loads a native ad.
+     */
+    loadAd(): void;
+};
+
+/**
+ * Represents a {@link NativeAdView}.
+ */
+export type NativeAdViewProps = AdProps;

package/src/types/Privacy.ts

@@ -0,0 +1,74 @@
+export type PrivacyType = {
+
+    /**********************************************************************************/
+    /* Privacy */
+    /**********************************************************************************/
+
+    /**
+     * 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 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 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;
+
+    /**
+     * Checks if the user is age-restricted.
+     */
+    isAgeRestrictedUser(): Promise<boolean>;
+
+    /**
+     * 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 opted out of the sale of their personal information.
+     */
+    isDoNotSell(): Promise<boolean>;
+
+    /**********************************************************************************/
+    /* TERM FLow */
+    /**********************************************************************************/
+
+    /**
+     * Enables the MAX Terms Flow.
+     *
+     * @param enabled true to enable the MAX Terms Flow.
+     */
+    setConsentFlowEnabled(enabled: boolean): Promise<void>;
+
+    /**
+     * 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>;
+
+    /**
+     * 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

@@ -0,0 +1,20 @@
+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 {@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 {@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

@@ -0,0 +1,162 @@
+import type { AdEventListener } from "./AdEvent";
+import type { AdInfo, AdLoadFailedInfo, AdRevenueInfo } from "./AdInfo";
+import type { AdViewPosition } from "../AdView";
+
+/**
+ * Define a view-based ad (i.e. Banner / MREC)
+ */
+export type ViewAdType = {
+
+    /**
+     * Destroys the banner/MREC.
+     * 
+     * @param adUnitId The ad unit ID of the ad to destroy.
+     */
+    destroyAd(adUnitId: string): void;
+
+    /**
+     * Shows the banner/MREC.
+     * 
+     * @param adUnitId The ad unit ID of the ad to show.
+     */
+    showAd(adUnitId: string): void;
+
+    /**
+     * Hides the banner/MREC.
+     * 
+     * @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 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;
+
+    /**
+     * Sets custom data to tie the showing ad’s events to.
+     * 
+     * @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;
+
+    /**
+     * Updates the banner/mrec position.
+     * 
+     * @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;
+
+    /**
+     * Sets an extra key/value parameter for the ad.
+     * 
+     * @param adUnitId The ad unit ID of the ad to set a parameter for.
+     * @param key Key parameter.
+     * @param value Value parameter.
+     */
+    setExtraParameter(adUnitId: string, key: string, value: string | null): void;
+
+    /**
+     * Set a local extra parameter to pass to the adapter instances.
+     * 
+     * @param adUnitId The ad unit ID of the ad to set a local parameter for.
+     * @param key Key parameter.
+     * @param value Value parameter.
+     */
+    setLocalExtraParameter(adUnitId: string, key: string, value: any): void;
+
+    /**
+     * Starts or resumes auto-refreshing of the banner/mrec.
+     * 
+     * @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 of the ad to stop auto-refreshing.
+     */
+    stopAutoRefresh(adUnitId: string): void;
+
+    /**
+     * 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 view-base ad loads a new ad.
+     */
+    removeAdLoadedEventListener(): void;
+
+    /**
+     * 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 a view-base ad could not
+     * load a new ad.
+     */
+    removeAdLoadFailedEventListener(): void;
+
+    /**
+     * 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 user clicks the ad.
+     */
+    removeAdClickedEventListener(): void;
+
+    /**
+     * 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 a view-base ad collapses the ad.
+     */
+    removeAdCollapsedEventListener(): void;
+
+    /**
+     * 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 a view-base ad expands the ad.
+     */
+    removeAdExpandedEventListener(): void;
+
+    /**
+     * 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 when a view-base ad pays ad
+     * revenue to the publisher.
+     */
+    removeAdRevenuePaidListener(): void;
+};

package/src/types/index.ts

@@ -0,0 +1,4 @@
+export * from "./Configuration";
+export * from "./AdInfo";
+export * from "./AdViewProps";
+export * from "./NativeAdViewProps";