react-native-applovin-max 5.7.2 → 6.0.0

package/src/types/FullscreenAd.ts

@@ -0,0 +1,135 @@
+import type { AdEventListener } from "./AdEvent";
+import type { AdInfo, AdLoadFailedInfo, AdRevenueInfo, AdDisplayFailedInfo } from "./AdInfo";
+
+/**
+ * Define a fullscreen 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.
+     */
+    isAdReady(adUnitId: string): Promise<boolean>;
+
+    /**
+     * Loads an interstitial ad.
+     * 
+     * @param adUnitId The Ad Unit ID to load ads for.
+     */
+    loadAd(adUnitId: string): void;
+
+    /**
+     * Show 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 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 to load ads 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.
+     *
+     * @param adUnitId The Ad Unit ID to load ads 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.
+     * 
+     * @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.
+     */
+    removeAdLoadedEventListener(): void;
+
+    /**
+     * Adds the specified event listener to receive {@link AdLoadFailedInfo} when an ad could not be loaded.
+     * 
+     * @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.
+      */
+    removeAdLoadFailedEventListener(): void;
+
+    /**
+     * Adds the specified event listener to receive {@link AdInfo} when the ad is clicked.
+     * 
+     * @param listener Listener to be notified.
+     */
+    addAdClickedEventListener(listener: AdEventListener<AdInfo>): void;
+
+    /**
+     * Removes the event listener to receive {@link AdInfo} when the ad is clicked.
+     */
+    removeAdClickedEventListener(): void;
+
+    /**
+     * Adds the specified event listener to receive {@link AdInfo} when the ad is displayed.
+     * 
+     * @param listener Listener to be notified.
+     */
+    addAdDisplayedEventListener(listener: AdEventListener<AdInfo>): void;
+
+    /**
+     * Removes the event listener to receive {@link AdInfo} when the ad is displayed.
+     */
+    removeAdDisplayedEventListener(): void;
+
+    /**
+     * Adds the specified event listener to receive {@link AdDisplayFailedInfo} when the ad is failed to
+     * display.
+     * 
+     * @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.
+     */
+    removeAdFailedToDisplayEventListener(): void;
+
+    /**
+     * Adds the specified event listener to receive {@link AdInfo} when the ad is hidden.
+     * 
+     * @param listener Listener to be notified.
+     */
+    addAdHiddenEventListener(listener: AdEventListener<AdInfo>): void;
+
+    /**
+     * Removes the event listener to receive {@link AdInfo} when the ad is hidden.
+     */
+    removeAdHiddenEventListener(): void;
+
+    /**
+     * Adds the specified event listener to receive {@link AdRevenueInfo} when the ad revenue is paid.
+     * 
+     * @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.
+     */
+    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,73 @@
+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.
+     */
+    setHasUserConsent(hasUserConsent: boolean): void;
+
+    /**
+     * Checks if user has 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 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.
+     */
+    setDoNotSell(doNotSell: boolean): void;
+
+    /**
+     * Checks if the user has opted out of the sale of their personal information.
+     */
+    isDoNotSell(): Promise<boolean>;
+
+    /**********************************************************************************/
+    /* TERM FLow */
+    /**********************************************************************************/
+
+    /**
+     * Enable the MAX Terms Flow.
+     *
+     * @param enabled 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.
+     * 
+     * @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. 
+     */
+    setTermsOfServiceUrl(urlString: string): Promise<void>;
+};

package/src/types/RewardedAd.ts

@@ -0,0 +1,18 @@
+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.
+     * 
+     * @param listener Listener to be notified.
+     */
+    addAdReceivedRewardEventListener(listener: AdEventListener<AdRewardInfo>): void;
+
+    /**
+     * Removes the event listener to receive {@link AdRewardInfo} when the ad is rewarded.
+     */
+    removeAdReceivedRewardEventListener(): void;
+};

package/src/types/ViewAd.ts

@@ -0,0 +1,158 @@
+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 to  to load ads for.
+     */
+    destroyAd(adUnitId: string): void;
+
+    /**
+     * Shows the banner/mrec.
+     * 
+     * @param adUnitId The Ad Unit ID to  to load ads for.
+     */
+    showAd(adUnitId: string): void;
+
+    /**
+     * Hides the banner/mrec.
+     * 
+     * @param adUnitId The Ad Unit ID to  to load ads for.
+     */
+    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 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 to  to load ads 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 to  to load ads for.
+     * @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 to  to load ads 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 to  to load ads 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 to  to load ads for.
+     */
+    startAutoRefresh(adUnitId: string): void;
+
+    /**
+     * Pauses auto-refreshing of the banner/mrec.
+     * 
+     * @param adUnitId The Ad Unit ID to  to load ads for.
+     */
+    stopAutoRefresh(adUnitId: string): void;
+
+    /**
+     * Adds the specified event listener to receive {@link AdInfo} when a new ad has been loaded.
+     * 
+     * @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.
+     */
+    removeAdLoadedEventListener(): void;
+
+    /**
+     * Adds the specified event listener to receive {@link AdLoadFailedInfo} when an ad could not be loaded.
+     * 
+     * @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.
+     */
+    removeAdLoadFailedEventListener(): void;
+
+    /**
+     * Adds the specified event listener to receive {@link AdInfo} when the ad is clicked.
+     * 
+     * @param listener Listener to be notified.
+     */
+    addAdClickedEventListener(listener: AdEventListener<AdInfo>): void;
+
+    /**
+     * Removes the event listener to receive {@link AdInfo} when the ad is clicked.
+     */
+    removeAdClickedEventListener(): void;
+
+    /**
+     * Adds the specified event listener to receive {@link AdInfo} when the ad is collapsed.
+     * 
+     * @param listener Listener to be notified.
+     */
+    addAdCollapsedEventListener(listener: AdEventListener<AdInfo>): void;
+
+    /**
+     * Removes the event listener to receive {@link AdInfo} when the ad is collapsed.
+     */
+    removeAdCollapsedEventListener(): void;
+
+    /**
+     * Adds the specified event listener to receive {@link AdInfo} when the ad is expanded.
+     * 
+     * @param listener Listener to be notified.
+     */
+    addAdExpandedEventListener(listener: AdEventListener<AdInfo>): void;
+
+    /**
+     * Removes the event listener to receive {@link AdInfo} when the ad is expanded.
+     */
+    removeAdExpandedEventListener(): void;
+
+    /**
+     * Adds the specified event listener to receive {@link AdRevenueInfo} when the ad revenue is paid.
+     * 
+     * @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.
+     */
+    removeAdRevenuePaidListener(): void;
+};

package/src/types/index.ts

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