Class AdImpressionEvent

Use this class to record adImpression events.

For more information about the adImpression event, see the documentation page: https://docs.unity.com/ugs/en-us/manual/analytics/manual/record-ad-impression-events

Inheritance
object
Event
AdImpressionEvent
Inherited Members
Namespace: Unity.Services.Analytics
Assembly: Unity.Services.Analytics.dll
Syntax
public class AdImpressionEvent : Event

Constructors

AdImpressionEvent()

Declaration
public AdImpressionEvent()

Properties

AdCompletionStatus

Whether the user watched the entire ad (COMPLETED), part of the ad (PARTIAL) or none of the ad (INCOMPLETE). Most applicable for interstitial ads which can be skipped by players

Declaration
public AdCompletionStatus AdCompletionStatus { set; }
Property Value
Type Description
AdCompletionStatus

AdEcpmUsd

(Optional) eCPM ("effective Cost Per Mille" - the revenue generated by 1000 impressions) in US Dollars. This value is often passed on a per-impression level by your mediation provider or ad network and used in ad LTV calculations.

Declaration
public double AdEcpmUsd { set; }
Property Value
Type Description
double

AdHasClicked

(Optional)

Declaration
public bool AdHasClicked { set; }
Property Value
Type Description
bool

AdImpressionId

(Optional)

Declaration
public string AdImpressionId { set; }
Property Value
Type Description
string

AdLengthMs

(Optional)

Declaration
public long AdLengthMs { set; }
Property Value
Type Description
long

AdMediaType

(Optional)

Declaration
public string AdMediaType { set; }
Property Value
Type Description
string

AdProvider

The ad network that served the ad - ie, UNITY, IRONSOURCE. This value is often passed on a per-impression level by your mediation provider or ad network.

Declaration
public AdProvider AdProvider { set; }
Property Value
Type Description
AdProvider

AdSdkVersion

(Optional) The Ad SDK version you are using.

Declaration
public string AdSdkVersion { set; }
Property Value
Type Description
string

AdSource

(Optional)

Declaration
public string AdSource { set; }
Property Value
Type Description
string

AdStatusCallback

(Optional)

Declaration
public string AdStatusCallback { set; }
Property Value
Type Description
string

AdStoreDestinationId

(Optional) The store the player is directed to after clicking the ad - for example, Google Play, App Store, Amazon.

Declaration
public string AdStoreDestinationId { set; }
Property Value
Type Description
string

AdTimeCloseButtonShownMs

(Optional)

Declaration
public long AdTimeCloseButtonShownMs { set; }
Property Value
Type Description
long

AdTimeWatchedMs

(Optional)

Declaration
public long AdTimeWatchedMs { set; }
Property Value
Type Description
long

PlacementId

The unique identifier for the placement where the Ad appeared as integrated into the game.

Declaration
public string PlacementId { set; }
Property Value
Type Description
string

PlacementName

The name of the placement as integrated in the game - for example, "Boosters" or "Daily Reward". This would correlate with the placement name configured in your ad network or mediation provider.

Declaration
public string PlacementName { set; }
Property Value
Type Description
string

PlacementType

(Optional) Indicates what type of ad is shown - for example, REWARDED, INTERSTITIAL or BANNER.

Declaration
public AdPlacementType PlacementType { set; }
Property Value
Type Description
AdPlacementType

Methods

Validate()

Note that failing validation will not prevent event serialisation or upload. This method is intended to produce warning logs to assist in implementation and debugging. Events will still be validated properly by the server on reaching it.

Declaration
public override void Validate()
Overrides