Class Events.AdImpressionArgs

Helper object to handle arguments for recording an AdImpression event.

Inheritance

Object

Events.AdImpressionArgs

Namespace: Unity.Services.Analytics

Syntax

[Obsolete("This class has been aligned with other interfaces. Please use AdImpressionParameters with the AnalyticsService.Instance API instead. This class will be removed in an upcoming release")]
public class AdImpressionArgs

Constructors

AdImpressionArgs(Events.AdCompletionStatus, Events.AdProvider, String, String)

Declaration

public AdImpressionArgs(Events.AdCompletionStatus adCompletionStatus, Events.AdProvider adProvider, string placementID, string placementName)

Parameters

Type	Name	Description
Events.AdCompletionStatus	adCompletionStatus	(Required) Indicates a successful Ad view. Select one of the AdCompletionStatus values.
Events.AdProvider	adProvider	(Required) The Ad SDK that provided the Ad. Select one of the AdProvider values.
String	placementID	(Required) The unique identifier for the placement as integrated into the game.
String	placementName	(Required) If there is a place in the game that can show Ads from multiple networks, there won’t be a single placementId. This field compensates for that by providing a single name for your placement. Ideally, this would be an easily human-readable name such as ‘revive’ or ‘daily bonus’. This value is here for reporting purposes only.

Properties

AdCompletionStatus

Indicates whether the Ad view was successful or not.

Declaration

public Events.AdCompletionStatus AdCompletionStatus { get; set; }

Property Value

Type	Description
Events.AdCompletionStatus

AdEcpmUsd

Optional. The estimated ECPM in USD, you should populate this value if you can.

Declaration

public double? AdEcpmUsd { get; set; }

Property Value

Type	Description
Nullable<Double>

AdHasClicked

Optional.

Declaration

public bool? AdHasClicked { get; set; }

Property Value

Type	Description
Nullable<Boolean>

AdImpressionID

Optional.

Declaration

public string AdImpressionID { get; set; }

Property Value

Type	Description
String

AdLengthMs

Optional.

Declaration

public long? AdLengthMs { get; set; }

Property Value

Type	Description
Nullable<Int64>

AdMediaType

Optional.

Declaration

public string AdMediaType { get; set; }

Property Value

Type	Description
String

AdProvider

The Ad SDK that provided the Ad.

Declaration

public Events.AdProvider AdProvider { get; set; }

Property Value

Type	Description
Events.AdProvider

AdSource

Optional.

Declaration

public string AdSource { get; set; }

Property Value

Type	Description
String

AdStatusCallback

Optional.

Declaration

public string AdStatusCallback { get; set; }

Property Value

Type	Description
String

AdStoreDstID

Optional.

Declaration

public string AdStoreDstID { get; set; }

Property Value

Type	Description
String

AdTimeCloseButtonShownMs

Optional.

Declaration

public long? AdTimeCloseButtonShownMs { get; set; }

Property Value

Type	Description
Nullable<Int64>

AdTimeWatchedMs

Optional.

Declaration

public long? AdTimeWatchedMs { get; set; }

Property Value

Type	Description
Nullable<Int64>

PlacementID

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

Declaration

public string PlacementID { get; set; }

Property Value

Type	Description
String

PlacementName

If there is a place in the game that can show Ads from multiple networks, there won’t be a single placementId. This field compensates for that by providing a single name for your placement. Ideally, this would be an easily human-readable name such as ‘revive’ or ‘daily bonus’. This value is here for reporting purposes only.

Declaration

public string PlacementName { get; set; }

Property Value

Type	Description
String

PlacementType

Optional. The placementType should indicate what type of Ad is shown. This value is here for reporting purposes only.

Declaration

public string PlacementType { get; set; }

Property Value

Type	Description
String

SdkVersion

Optional. The Ad SDK version you are using.

Declaration

public string SdkVersion { get; set; }

Property Value

Type	Description
String