UnityMonetization

3.0.1

Generated by Doxygen 1.8.15

Mon Jan 28 2019 16:58:16

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
1.3 UnityEngine.Monetization Namespace Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

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 [[[]]]

Generated on Mon Jan 28 2019 16:58:16 for UnityMonetization by Doxygen

2

• class BannerOptions
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 Mon Jan 28 2019 16:58:16 for UnityMonetization by Doxygen

1.3 UnityEngine.Monetization Namespace Reference 3

Enumerator
Failed Indicates that the advertisement failed to complete.
Skipped Indicates that the advertisement was skipped.
Finished Indicates that the advertisement completed successfully.

1.3 UnityEngine.Monetization Namespace Reference

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 Mon Jan 28 2019 16:58:16 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←- Placement identifier.
Id

2.1.2.3 Initialize() [1/2]

static void UnityEngine.Advertisements.Advertisement.Initialize (

string gameId ) [static]

Initializes the advertisement system.

Generated on Mon Jan 28 2019 16:58:16 for UnityMonetization by Doxygen

2.1 UnityEngine.Advertisements.Advertisement Class Reference 5

Parameters
game←- Game identifier.
Id

2.1.2.4 Initialize() [2/2]

static void UnityEngine.Advertisements.Advertisement.Initialize (

string gameId,
bool testMode ) [static]

Initialize the advertisement system with specified gameId and testMode.

Parameters
gameId Game identifier.
testMode Test mode.

2.1.2.5 IsReady() [1/2]

static bool UnityEngine.Advertisements.Advertisement.IsReady ( ) [static]

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.

2.1.2.6 IsReady() [2/2]

static bool UnityEngine.Advertisements.Advertisement.IsReady (

string placementId ) [static]

Returns whether an advertisement is ready to be shown for specified placement. Placements are configured per
game in the UnityAds admin site.

Parameters
placement←- Placement identifier.
Id

2.1.2.7 SetMetaData()

static void UnityEngine.Advertisements.Advertisement.SetMetaData (

MetaData metaData ) [static]

Sets various metadata for the advertisement system.

Generated on Mon Jan 28 2019 16:58:16 for UnityMonetization by Doxygen

6

Parameters
metaData Metadata container

2.1.2.8 Show() [1/4]

static void UnityEngine.Advertisements.Advertisement.Show ( ) [static]

Show the default placement if it is ready.

2.1.2.9 Show() [2/4]

static void UnityEngine.Advertisements.Advertisement.Show (

ShowOptions showOptions ) [static]

Show the default placement if it is ready and returns the result in name="finishCallback".

Parameters
showOptions Various show options, including resultCallback.

2.1.2.10 Show() [3/4]

static void UnityEngine.Advertisements.Advertisement.Show (

string placementId ) [static]

Show the specified placement if it is ready.

Parameters
placement←- Placement identifier.
Id

2.1.2.11 Show() [4/4]

static void UnityEngine.Advertisements.Advertisement.Show (

string placementId,
ShowOptions showOptions ) [static]

Show the specified placement if it is ready and returns the result in name="finishCallback".

Parameters
placementId Placement identifier.
showOptions Various show options, including resultCallback.

Generated on Mon Jan 28 2019 16:58:16 for UnityMonetization by Doxygen

2.2 UnityEngine.Advertisements.Advertisement.Banner Class Reference 7

2.1.3 Property Documentation

2.1.3.1 debugMode

bool UnityEngine.Advertisements.Advertisement.debugMode [static], [get], [set]

Controls the amount of logging output from the advertisement system.

2.1.3.2 isInitialized

bool UnityEngine.Advertisements.Advertisement.isInitialized [static], [get], [set]

Returns whether the advertisement system is initialized successfully.

2.1.3.3 isShowing

bool UnityEngine.Advertisements.Advertisement.isShowing [static], [get], [set]

Returns if an advertisement is currently showing.

2.1.3.4 isSupported

bool UnityEngine.Advertisements.Advertisement.isSupported [static], [get]

Returns if the current platform is supported by the advertisement system.

2.1.3.5 version

string UnityEngine.Advertisements.Advertisement.version [static], [get]

Returns the current Unity Ads version.

The documentation for this class was generated from the following file:

• /Users/stevenb/Desktop/git/com.unity.ads(cds)/Runtime/Advertisement/Advertisement.cs

2.2 UnityEngine.Advertisements.Advertisement.Banner Class Reference

Unity Ads Banner

Generated on Mon Jan 28 2019 16:58:16 for UnityMonetization by Doxygen

8

Static Public Member Functions

• static void Show ()

Shows the banner with the default placement ID and no callbacks.
• static void Show (BannerOptions options)
Shows the banner with the default placement ID and will fire the callback name="showCallback" on show, and
name="hideCallback" on hide.
• static void Show (string placementId)
Shows the banner with the givden placement ID and no callbacks. and name="hideCallback" on hide.

2.2.1 Detailed Description

Unity Ads Banner

2.2.2 Member Function Documentation

2.2.2.1 Show() [1/3]

static void UnityEngine.Advertisements.Advertisement.Banner.Show ( ) [static]

Shows the banner with the default placement ID and no callbacks.

2.2.2.2 Show() [2/3]

static void UnityEngine.Advertisements.Advertisement.Banner.Show (

BannerOptions options ) [static]

Shows the banner with the default placement ID and will fire the callback name="showCallback" on show, and
name="hideCallback" on hide.

2.2.2.3 Show() [3/3]

static void UnityEngine.Advertisements.Advertisement.Banner.Show (

string placementId ) [static]

Shows the banner with the givden placement ID and no callbacks. and name="hideCallback" on hide.

The documentation for this class was generated from the following file:

• /Users/stevenb/Desktop/git/com.unity.ads(cds)/Runtime/Advertisement/Advertisement.cs

2.3 UnityEngine.Advertisements.BannerLoadOptions Class Reference

Options that can be passed to [[[]]]

Generated on Mon Jan 28 2019 16:58:16 for UnityMonetization by Doxygen

2.4 UnityEngine.Advertisements.BannerOptions Class Reference 9

Properties

• LoadCallback loadCallback [get, set]

Callback that is fired when when the banner is loaded and available to show.
• ErrorCallback errorCallback [get, set]
Callback that is fired when an error occurs during banner loading. If this callback is invoked, one should assume that
the banner is not loaded and one may call Load again at a later point in time.

2.3.1 Detailed Description

Options that can be passed to [[[]]]

2.3.2 Property Documentation

2.3.2.1 errorCallback

ErrorCallback UnityEngine.Advertisements.BannerLoadOptions.errorCallback [get], [set]

Callback that is fired when an error occurs during banner loading. If this callback is invoked, one should assume
that the banner is not loaded and one may call Load again at a later point in time.

2.3.2.2 loadCallback

LoadCallback UnityEngine.Advertisements.BannerLoadOptions.loadCallback [get], [set]

Callback that is fired when when the banner is loaded and available to show.

The documentation for this class was generated from the following file:

• /Users/stevenb/Desktop/git/com.unity.ads(cds)/Runtime/Advertisement/BannerOptions.cs

2.4 UnityEngine.Advertisements.BannerOptions Class Reference

Collection of options that can be passed to [[Advertisements.Banner.Show]] to be notified of events within the
banner.

Properties

• BannerCallback showCallback [get, set]

Callback that is fired when when the banner is visible to the gamer.
• BannerCallback hideCallback [get, set]
Callback that is fired when the banner is hidden to the gamer.

Generated on Mon Jan 28 2019 16:58:16 for UnityMonetization by Doxygen

10

2.4.1 Detailed Description

Collection of options that can be passed to [[Advertisements.Banner.Show]] to be notified of events within the
banner.

2.4.2 Property Documentation

2.4.2.1 hideCallback

BannerCallback UnityEngine.Advertisements.BannerOptions.hideCallback [get], [set]

Callback that is fired when the banner is hidden to the gamer.

2.4.2.2 showCallback

BannerCallback UnityEngine.Advertisements.BannerOptions.showCallback [get], [set]

Callback that is fired when when the banner is visible to the gamer.

The documentation for this class was generated from the following file:

• /Users/stevenb/Desktop/git/com.unity.ads(cds)/Runtime/Advertisement/BannerOptions.cs

2.5 UnityEngine.Advertisements.MetaData Class Reference

Class for sending various metadata to UnityAds.

Public Member Functions

• MetaData (string category)

Constructs an metadata instance that can be passed to the Advertisement class.
• void Set (string key, object value)
Sets new metadata fields.
• object Get (string key)
Returns the stored metadata key.
• IDictionary< string, object > Values ()
Returns the stored metadata.

Properties

• string category [get]

Metadata category.

Generated on Mon Jan 28 2019 16:58:16 for UnityMonetization by Doxygen

2.5 UnityEngine.Advertisements.MetaData Class Reference 11

2.5.1 Detailed Description

Class for sending various metadata to UnityAds.

2.5.2 Constructor & Destructor Documentation

2.5.2.1 MetaData()

UnityEngine.Advertisements.MetaData.MetaData (
string category )

Constructs an metadata instance that can be passed to the Advertisement class.

2.5.3 Member Function Documentation

2.5.3.1 Get()

object UnityEngine.Advertisements.MetaData.Get (
string key )

Returns the stored metadata key.

2.5.3.2 Set()

void UnityEngine.Advertisements.MetaData.Set (
string key,
object value )

Sets new metadata fields.

Parameters
key Metadata key.
value Metadata value. Must be JSON serializable.

2.5.3.3 Values()

IDictionary<string, object> UnityEngine.Advertisements.MetaData.Values ( )

Returns the stored metadata.

Generated on Mon Jan 28 2019 16:58:16 for UnityMonetization by Doxygen

12

2.5.4 Property Documentation

2.5.4.1 category

string UnityEngine.Advertisements.MetaData.category [get]

Metadata category.

The documentation for this class was generated from the following file:

• /Users/stevenb/Desktop/git/com.unity.ads(cds)/Runtime/Advertisement/MetaData.cs

2.6 UnityEngine.Advertisements.ShowOptions Class Reference

Collection of options that can be passed to [[Advertisements.Show]] to modify advertisement behaviour.

Properties

• Action< ShowResult > resultCallback [get, set]

Callback to receive the result of the advertisement.
• string gamerSid [get, set]
Add a string to specify an identifier for a specific user in the game.

2.6.1 Detailed Description

Collection of options that can be passed to [[Advertisements.Show]] to modify advertisement behaviour.

2.6.2 Property Documentation

2.6.2.1 gamerSid

string UnityEngine.Advertisements.ShowOptions.gamerSid [get], [set]

Add a string to specify an identifier for a specific user in the game.

2.6.2.2 resultCallback

Action<ShowResult> UnityEngine.Advertisements.ShowOptions.resultCallback [get], [set]

Callback to receive the result of the advertisement.

The documentation for this class was generated from the following file:

• /Users/stevenb/Desktop/git/com.unity.ads(cds)/Runtime/Advertisement/ShowOptions.cs

Generated on Mon Jan 28 2019 16:58:16 for UnityMonetization by Doxygen

Index
BannerPosition resultCallback
UnityEngine.Advertisements, 2 UnityEngine.Advertisements.ShowOptions, 12

category Set
UnityEngine.Advertisements.MetaData, 12 UnityEngine.Advertisements.MetaData, 11
SetMetaData
debugMode UnityEngine.Advertisements.Advertisement, 5
UnityEngine.Advertisements.Advertisement, 7 Show
Disabled UnityEngine.Advertisements.Advertisement, 6
UnityEngine.Advertisements, 2 UnityEngine.Advertisements.Advertisement.Banner,
8
errorCallback
showCallback
UnityEngine.Advertisements.BannerLoadOptions,
UnityEngine.Advertisements.BannerOptions, 10
9
ShowResult
UnityEngine.Advertisements, 2
Failed
Skipped
UnityEngine.Advertisements, 3
UnityEngine.Advertisements, 3
Finished
UnityEngine.Advertisements, 3
UnityEngine, 1
gamerSid UnityEngine.Advertisements, 1
UnityEngine.Advertisements.ShowOptions, 12 BannerPosition, 2
Get Disabled, 2
UnityEngine.Advertisements.MetaData, 11 Failed, 3
GetPlacementState Finished, 3
UnityEngine.Advertisements.Advertisement, 4 NoFill, 2
NotAvailable, 2
hideCallback PlacementState, 2
UnityEngine.Advertisements.BannerOptions, 10 Ready, 2
ShowResult, 2
Initialize Skipped, 3
UnityEngine.Advertisements.Advertisement, 4, 5 Waiting, 2
isInitialized UnityEngine.Advertisements.Advertisement, 3
UnityEngine.Advertisements.Advertisement, 7 debugMode, 7
IsReady GetPlacementState, 4
UnityEngine.Advertisements.Advertisement, 5 Initialize, 4, 5
isShowing isInitialized, 7
UnityEngine.Advertisements.Advertisement, 7 IsReady, 5
isSupported isShowing, 7
UnityEngine.Advertisements.Advertisement, 7 isSupported, 7
SetMetaData, 5
loadCallback Show, 6
UnityEngine.Advertisements.BannerLoadOptions, version, 7
9 UnityEngine.Advertisements.Advertisement.Banner, 7
Show, 8
MetaData
UnityEngine.Advertisements.BannerLoadOptions, 8
UnityEngine.Advertisements.MetaData, 11
errorCallback, 9
loadCallback, 9
NoFill
UnityEngine.Advertisements.BannerOptions, 9
UnityEngine.Advertisements, 2
hideCallback, 10
NotAvailable
showCallback, 10
UnityEngine.Advertisements, 2
UnityEngine.Advertisements.MetaData, 10
PlacementState category, 12
UnityEngine.Advertisements, 2 Get, 11
MetaData, 11
Ready Set, 11
UnityEngine.Advertisements, 2 Values, 11
14 INDEX

UnityEngine.Advertisements.ShowOptions, 12
gamerSid, 12
resultCallback, 12
UnityEngine.Monetization, 3

Values
UnityEngine.Advertisements.MetaData, 11
version
UnityEngine.Advertisements.Advertisement, 7

Waiting
UnityEngine.Advertisements, 2

Generated on Mon Jan 28 2019 16:58:16 for UnityMonetization by Doxygen