/// import { Stream } from 'stream'; import { MediationGroupPriority } from './models/adsource_priority'; import { InstanceConfig } from './models/instance_config'; import { BaseAPI } from './base_api'; import { Placement } from './models/placement'; export declare namespace MonetizeEnums { enum AdUnitStatus { Live = "Live", Off = "Off", Test = "Test" } enum AdUnits { RewardedVideo = "rewardedVideo", Interstitial = "interstitial", Banner = "banner", Offerwall = "OfferWall" } enum PLATFORM { iOS = "iOS", Android = "Android" } enum Networks { IronSource = "ironSource", IronSourceBidding = "ironSourceBidding", Vungle = "Vungle", VungleBidding = "vungleBidding", AppLovin = "AppLovin", AdColony = "AdColony", AdColonyBidding = "adColonyBidding", AdMob = "AdMob", AdManager = "AdManager", Amazon = "Amazon", Chartboost = "Chartboost", CrossPromotionBidding = "crossPromotionBidding", CSJ = "CSJ", DirectDeals = "DirectDeals", Facebook = "Facebook", FacebookBidding = "facebookBidding", Fyber = "Fyber", HyperMX = "HyprMX", InMobi = "InMobi", InMobiBidding = "inMobiBidding", Maio = "Maio", LiftOff = "Liftoff Bidding", MyTarget = "myTargetBidding", TapJoy = "TapJoy", TapJoyBidding = "TapJoyBidding", Pangle = "Pangle", PangleBidding = "pangleBidding", Tencent = "Tencent", UnityAds = "UnityAds", Smaato = "smaatoBidding", Snap = "Snap", SuperAwesome = "SuperAwesomeBidding", YahooBidding = "yahooBidding" } enum Metrics { impressions = "impressions", revenue = "revenue", eCPM = "ecpm", appFillRate = "appfillrate", appRequests = "appRequests", completions = "completions", revenuePerCompletion = "revenuePerCompletion", appFills = "appFills", useRate = "useRate", activeUsers = "activeUsers", engagedUsers = "engagedUsers", engagedUsersRate = "engagedUsersRate", impressionsPerEngagedUser = "impressionsPerEngagedUser", revenuePerActiveUser = "revenuePerActiveUser", revenuePerEngagedUser = "revenuePerEngagedUser", clicks = "clicks", clickThroughRate = "clickThroughRate", completionRate = "completionRate", adSourceChecks = "adSourceChecks", adSourceResponses = "adSourceResponses", adSourceAvailabilityRate = "adSourceAvailabilityRate", sessions = "sessions", engagedSessions = "engagedSessions", impressionsPerSession = "impressionsPerSession", impressionPerEngagedSessions = "impressionPerEngagedSessions", sessionsPerActiveUser = "sessionsPerActiveUser" } enum Breakdowns { Date = "date", Application = "app", Platform = "platform", Network = "adSource", AdUnits = "adUnits", Instance = "instance", Country = "country", Segment = "segment", Placement = "placement", IOSVersion = "iosVersion", ConnectionType = "connectionType", SDKVersion = "sdkVersion", AppVersion = "appVersion", ATT = "att", IDFA = "idfa", ABTest = "abTest" } const Genres: { CASUAL: { HYPER_CASUAL: { STACKING: string; DEXTERITY: string; RISING_OR_FALLING: string; SWERVE: string; MERGE: string; IDLE: string; IO: string; PUZZLE: string; TAP_OR_TIMING: string; TURNING: string; BALL: string; OTHER: string; }; AR_LOCATION_BASED: { AR_LOCATION_BASED: string; }; PUZZLE: { ACTION_PUZZLE: string; MATCH_3: string; BUBBLE_SHOOTER: string; JIGSAW: string; CROSSWORD: string; WORD: string; TRIVIA: string; BOARD: string; COLORING_GAMES: string; HIDDEN_OBJECTS: string; SOLITAIRE: string; NON_CASINO_CARD_GAME: string; OTHER_PUZZLE: string; }; ARCADE: { PLATFORMER: string; IDLER: string; SHOOT_EN_UP: string; ENDLESS_RUNNER: string; TOWER_DEFENSE: string; OTHER_ARCADE: string; }; LIFESTYLE: { CUSTOMIZATION: string; INTERACTIVE_STORY: string; MUSIC_BAND: string; OTHER_LIFESTYLE: string; }; SIMULATION: { ADVENTURES: string; BREEDING: string; TYCOON_CRAFTING: string; SANDBOX: string; COOKING_TIME_MANAGEMENT: string; FARMING: string; OTHER_SIMULATION: string; IDLE_SIMULATION: string; }; KIDS_AND_FAMILY: { KINDS_AND_FAMILY: string; }; OTHER_CASUAL: { OTHER_CASUAL: string; }; LUCKY_REWARDS: { LUCKY_CASINO: string; LUCKY_PUZZLE: string; LUCKY_GAME_DISCOVERY: string; }; }; CASINO: { CASINO: { BINGO: string; POKER: string; NON_POKER_CARDS: string; BLACKJACK: string; SLOTS: string; SPORTS_BETTING: string; }; OTHER_CASINO: { OTHER_CASINO: string; }; }; MID_CORE: { SHOOTER: { BATTLE_ROYALE: string; CLASSIC_FPS: string; SNIPERS: string; TACTICAL_SHOOTER: string; OTHER_SHOOTER: string; }; RPG: { ACTION_RPG: string; TURN_BASED_RPG: string; FIGHTING: string; MMORPG: string; PUZZLE_RPG: string; SURVIVAL: string; OTHER_RPG: string; IDLE_RPG: string; }; CARD_GAMES: { CARD_BATTLER: string; }; STRATEGY: { '4X_STRATEGY': string; BUILD_AND_BATTLE: string; MOBA: string; SYNC_BATTLER: string; OTHER_STRATEGY: string; IDLE_STRATEGY: string; }; OTHER_MID_CORE: { OTHER_MID_CORE: string; }; }; SPORT_AND_RACING: { SPORTS: { CASUAL_SPORTS: string; LICENSED_SPORTS: string; }; RACING: { CASUAL_RACING: string; SIMULATION_RACING: string; OTHER_RACING: string; }; OTHER_SPORTS_AND_RACING: { OTHER_SPORTS_AND_RACING: string; }; }; NON_GAMING: { ENTERTAINMENT: { EDUCATION: string; ENTERTAINMENT: string; NEWS_AND_MAGAZINES: string; PHOTOGRAPHY: string; EVENTS_AND_TICKETS: string; PERSONALIZATION: string; }; FINANCE: { FINANCE: string; }; SHOPPING: { SHOPPING: string; MARKETPLACE: string; }; SOCIAL: { DATING: string; SOCIAL: string; COMMUNICATIONS: string; }; LIFESTYLE_NON_GAME: { BOOKS_AND_REFERENCE: string; MUSIC_AND_AUDIO: string; PARENTING: string; COMICS: string; REAL_ESTATE_AND_HOME: string; LIFESTYLE: string; }; OTHER_NON_GAMING: { OTHER_NON_GAMING: string; }; TRAVEL: { MAPS_AND_NAVIGATION: string; TRAVEL_AIR_AND_HOTEL: string; TRAVEL_AND_LOCAL: string; CAR_SHARING: string; TAXI_RIDE_SHARING: string; BIKE: string; }; HEALTH: { FOOD_AND_DRINK: string; HEALTH_AND_FITNESS: string; MEDICAL: string; SPORTS: string; }; }; }; } export declare namespace IronSourceMonetizeAPI { /** * IronSource Monetization API */ class API extends BaseAPI { [Symbol.toStringTag]: 'MonetizeAPI'; [Symbol.toPrimitive]: 'MonetizeAPI'; /** * * @param date {string} - Date in the following formate YYYY-MM-DD * @param appKey {string} - Application key of the app * * @returns {Stream} - A stream of the ARM data from the request */ getARMReportAsStream(date: string, appKey: string): Promise; /** * * @param date {string} - Date in the following formate YYYY-MM-DD * @param appKey {string} - Application key of the app * * @returns {String} ARM data in csv format */ getARMReport(date: string, appKey: string): Promise; /** * * @param date {string} - Date in the following formate YYYY-MM-DD * @param appKey {string} - Application key of the app * * @returns {Stream} - A stream of the UAR data from the request */ getUserAdRevenueAsStream(date: string, appKey: string): Promise; /** * * @param date {string} - Date in the following formate YYYY-MM-DD * @param appKey {string} - Application key of the app * * @returns {String} UAR data in csv format */ getUserAdRevenue(date: string, appKey: string): Promise; /** * * @param {string} startDate - Report start date in the following format YYYY-MM-DD * @param {string} endDate - Report end date in the following format YYYY-MM-DD * @param {Object} optionsParams - Object containing optional * @param {string} optionsParams.applicationKey - The application key for the report * @param {string} optionsParams.country - Country code in 2 letter country code, as per {@link https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes | [ISO 3166-1 Alpha-2]} * @param {MonetizeEnums.AdUnits} optionsParams.adUnit - Filter for specific AdUnit (RewardedVideo, Interstitial, Banner, Offerwall) {@link AdUnits} * @param {MonetizeEnums.Networks} optionsParams.adSource - Filter for specific Ad Source - network {@link Networks}. * @param {[MonetizeEnums.Metrics]} optionsParams.metrics - List of metrics see {@link https://developers.ironsrc.com/ironsource-mobile/air/supported-breakdown-metric/ | Metrics} see supported metrics and breakdowns * @param {[MonetizeEnums.Breakdowns]} optionsParams.breakdowns - List of breakdowns see {@link https://developers.ironsrc.com/ironsource-mobile/air/supported-breakdown-metric/ | Breakdowns} see supported breakdown and metrics * @returns {String} Report data in json format. */ getMonetizationData(startDate: string, endDate: string, optionsParams?: { appKey?: string; country?: string; adUnits?: MonetizeEnums.AdUnits; adSource?: MonetizeEnums.Networks; metrics?: Array; breakdowns?: Array; [key: string]: any; }): Promise; /** * * @param {string} applicationKey - The application key to get the mediation groups for * @returns {Promise} - String in JSON format describing the mediation group (https://developers.ironsrc.com/ironsource-mobile/android/mediationmanagement/#step-1) */ getMediationGroups(applicationKey: string): Promise; /** * * @param {string} applicationKey - The application key to create the group for. * @param {MonetizeEnums.AdUnits} adUnit - The Ad Unit to create the application for see [[AdUnits]] * @param {string} groupName - Group name * @param {[groupCountries]} groupCountries - List of group countries in [ISO 3166-1 Alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) * @param {object} groupOptions - Optional group parameters * @param {number} groupOptions.groupPosition - Position of the group in the group list * @param {number} groupOptions.groupSegments - Segment ID attached to the group * @param {MediationGroupPriority} groupOptions.adSourcePriority - AdSource and their priority * @returns {String} */ createMediationGroup(applicationKey: string, adUnit: MonetizeEnums.AdUnits, groupName: string, groupCountries: string[], groupOptions: { groupPosition?: number; groupSegments?: number; adSourcePriority?: MediationGroupPriority; }): Promise; /** * * @param {string} applicationKey - The application key to update the group for. * @param {number} groupId - Id of the group to update * @param {object} groupOptions - Optional group parameters * @param {[groupCountries]} groupOptions.groupCountries - List of group countries in [ISO 3166-1 Alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) * @param {string} groupOptions.groupName - Group name * @param {number} groupOptions.groupPosition - Position of the group in the group list * @param {number} groupOptions.groupSegments - Segment ID attached to the group * @param {MediationGroupPriority} groupOptions.adSourcePriority - AdSource and their priority * @returns {String} */ updateMediationGroup(applicationKey: string, groupId: number, groupOptions?: { groupName?: string; groupCountries?: string[]; groupPosition?: number; groupSegments?: number; adSourcePriority?: MediationGroupPriority; }): Promise; /** * * @param {string} applicationKey - Application Key to delete the group for. * @param {number} groupId - Group ID to delete. * * @return {String} */ deleteMediationGroup(applicationKey: string, groupId: number): Promise; /** * @returns {String} List of apps from the account */ getApps(): Promise; /** * * @param {string} storeUrl - URL to the store of the live app * @param {boolean} coppa - Is app COPPA. * @param {Map} options.adUnitStatus - Optional: Map of AdUnits [[MonetizeEnums.AdUnits]] and their status [[MonetizeEnums.AdUnitStatus]] * @param {boolean} options.ccpa - Optional: Is app CCPA. * @returns {String} */ addApp(storeUrl: string, taxonomy: typeof MonetizeEnums.Genres | string, coppa: boolean, options?: { adUnitStatus?: Map; ccpa?: boolean; }): Promise; /** * * @param {string} appName - Temporary app's name * @param {string} platform - Temporary app's platform * @param {boolean} coppa - Is app COPPA. * @param {Map} adUnitStatus - Optional: Map of AdUnits [[MonetizeEnums.AdUnits]] and their status [[MonetizeEnums.AdUnitStatus]] * @param {boolean} options.ccpa - Optional: Is app CCPA. * @returns {String} */ addApp(appName: string, platform: MonetizeEnums.PLATFORM, coppa: boolean, options?: { adUnitStatus?: Map; ccpa?: boolean; }): Promise; /** * * @param {string} applicationKey - Application Key to get instances for. * @returns {String} */ getInstances(applicationKey: string): Promise; /** * * @param {string} applicationKey - Application Key to add instance to. * @param {[InstanceConfig]} instances - List of InstanceConfigs to be add. * @returns {String} */ addInstances(applicationKey: string, instances: InstanceConfig[]): Promise; /** * * @param {string} applicationKey - Application key to delete instance for. * @param {number} instanceId - Instance ID to delete. * @returns {String} */ deleteInstance(applicationKey: string, instanceId: number): Promise; /** * * @param {string} applicationKey - Application key to update instance for. * @param {[InstanceConfig]} instances - List of Instance Configs [[InstanceConfig]] * @returns {String} */ updateInstance(applicationKey: string, instances: InstanceConfig[]): Promise; getPlacements(applicationKey: string): Promise; addPlacements(applicationKey: string, placements: Placement[]): Promise; updatePlacements(applicationKey: string, placements: Placement[]): Promise; deletePlacement(applicationKey: string, adUnit: MonetizeEnums.AdUnits, placementId: number): Promise; } }