UnityMonetization
3.0.1
Generated by Doxygen 1.8.15
Tue Jan 29 2019 09:06:21
1 Namespace Documentation 1
1 Namespace Documentation 1
1.1 UnityEngine Namespace Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.2 UnityEngine.Advertisements Namespace Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.2.1 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
2 Class Documentation 3
2.1 UnityEngine.Advertisements.Advertisement Class Reference . . . . . . . . . . . . . . . . . . . . . 3
2.1.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.1.2 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.1.3 Property Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.2 UnityEngine.Advertisements.Advertisement.Banner Class Reference . . . . . . . . . . . . . . . . . 7
2.2.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.2.2 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.3 UnityEngine.Advertisements.BannerLoadOptions Class Reference . . . . . . . . . . . . . . . . . . 8
2.3.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.3.2 Property Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.4 UnityEngine.Advertisements.BannerOptions Class Reference . . . . . . . . . . . . . . . . . . . . . 9
2.4.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2.4.2 Property Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2.5 UnityEngine.Advertisements.MetaData Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 10
2.5.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.5.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.5.3 Member Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.5.4 Property Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2.6 UnityEngine.Advertisements.ShowOptions Class Reference . . . . . . . . . . . . . . . . . . . . . . 12
2.6.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2.6.2 Property Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Index 13
1 Namespace Documentation
1.1 UnityEngine Namespace Reference
1.2 UnityEngine.Advertisements Namespace Reference
Classes
• class Advertisement
Unity Ads Asset Store Package
• class BannerLoadOptions
Options that can be passed to [[[]]]
• class BannerOptions
Generated on Tue Jan 29 2019 09:06:21 for UnityMonetization by Doxygen
2
Collection of options that can be passed to [[Advertisements.Banner.Show]] to be notified of events within the banner.
• class MetaData
Class for sending various metadata to UnityAds.
• class ShowOptions
Collection of options that can be passed to [[Advertisements.Show]] to modify advertisement behaviour.
Enumerations
• enum BannerPosition
Banner position
• enum PlacementState {
PlacementState.Ready, PlacementState.NotAvailable, PlacementState.Disabled, PlacementState.Waiting,
PlacementState.NoFill }
Various states that Unity Ads placements can be in.
• enum ShowResult { ShowResult.Failed, ShowResult.Skipped, ShowResult.Finished }
ShowResult is passed to [[ShowOptions.resultCallback]] after the advertisement has completed.
1.2.1 Enumeration Type Documentation
1.2.1.1 BannerPosition
enum UnityEngine.Advertisements.BannerPosition [strong]
Banner position
1.2.1.2 PlacementState
enum UnityEngine.Advertisements.PlacementState [strong]
Various states that Unity Ads placements can be in.
Enumerator
Ready Placement is ready to show ads.
NotAvailable Placement is not available.
Disabled Placement has been disabled.
Waiting Placement is waiting to be ready.
NoFill Placement has no advertisements to show.
1.2.1.3 ShowResult
enum UnityEngine.Advertisements.ShowResult [strong]
ShowResult is passed to [[ShowOptions.resultCallback]] after the advertisement has completed.
Generated on Tue Jan 29 2019 09:06:21 for UnityMonetization by Doxygen
2 Class Documentation 3
Enumerator
Failed Indicates that the advertisement failed to complete.
Skipped Indicates that the advertisement was skipped.
Finished Indicates that the advertisement completed successfully.
2 Class Documentation
2.1 UnityEngine.Advertisements.Advertisement Class Reference
Unity Ads Asset Store Package
Classes
• class Banner
Unity Ads Banner
Static Public Member Functions
• static void Initialize (string gameId)
Initializes the advertisement system.
• static void Initialize (string gameId, bool testMode)
Initialize the advertisement system with specified gameId and testMode.
• static bool IsReady ()
Returns whether an advertisement is ready to be shown for the default placement. Placements are configured per
game in the UnityAds admin site, where you can also set your default placement.
• static bool IsReady (string placementId)
Returns whether an advertisement is ready to be shown for specified placement. Placements are configured per
game in the UnityAds admin site.
• static PlacementState GetPlacementState ()
Returns the state of the default placement.
• static PlacementState GetPlacementState (string placementId)
Returns the state of specified placement.
• static void Show ()
Show the default placement if it is ready.
• static void Show (ShowOptions showOptions)
Show the default placement if it is ready and returns the result in name="finishCallback".
• static void Show (string placementId)
Show the specified placement if it is ready.
• static void Show (string placementId, ShowOptions showOptions)
Show the specified placement if it is ready and returns the result in name="finishCallback".
• static void SetMetaData (MetaData metaData)
Sets various metadata for the advertisement system.
Generated on Tue Jan 29 2019 09:06:21 for UnityMonetization by Doxygen
4
Properties
• static bool isInitialized [get, set]
Returns whether the advertisement system is initialized successfully.
• static bool isSupported [get]
Returns if the current platform is supported by the advertisement system.
• static bool debugMode [get, set]
Controls the amount of logging output from the advertisement system.
• static string version [get]
Returns the current Unity Ads version.
• static bool isShowing [get, set]
Returns if an advertisement is currently showing.
2.1.1 Detailed Description
Unity Ads Asset Store Package
2.1.2 Member Function Documentation
2.1.2.1 GetPlacementState() [1/2]
static PlacementState UnityEngine.Advertisements.Advertisement.GetPlacementState ( ) [static]
Returns the state of the default placement.
2.1.2.2 GetPlacementState() [2/2]
static PlacementState UnityEngine.Advertisements.Advertisement.GetPlacementState (
string placementId ) [static]
Returns the state of specified placement.
Parameters
placement←-
Id
Placement identifier.
2.1.2.3 Initialize() [1/2]
static void UnityEngine.Advertisements.Advertisement.Initialize (
string gameId ) [static]
Initializes the advertisement system.
Generated on Tue Jan 29 2019 09:06:21 for UnityMonetization by Doxygen
