Skip to main content
Version: SDK 5.0.x

Class AdImpression

Constructors

Constructor

new AdImpression(adUnit: string, adSdkName: string): AdImpression

Parameters

NameTypeDescription
adUnitstring-
adSdkNamestring-

Returns

AdImpression

Methods

withAdNetwork

withAdNetwork(adNetwork: null | string): AdImpression

Parameters

NameTypeDescription
adNetworknull | string-

Returns

AdImpression

withBundleId

withBundleId(bundleId: null | string): AdImpression

Parameters

NameTypeDescription
bundleIdnull | string-

Returns

AdImpression

withInstanceName

withInstanceName(instanceName: null | string): AdImpression

Parameters

NameTypeDescription
instanceNamenull | string-

Returns

AdImpression

withPlacement

withPlacement(placement: null | string): AdImpression

Parameters

NameTypeDescription
placementnull | string-

Returns

AdImpression

withRevenue

withRevenue(revenue: null | Money): AdImpression

Parameters

NameTypeDescription
revenuenull | Money-

Returns

AdImpression

withSegmentName

withSegmentName(segmentName: null | string): AdImpression

Parameters

NameTypeDescription
segmentNamenull | string-

Returns

AdImpression

withTestGroup

withTestGroup(testGroup: null | string): AdImpression

Parameters

NameTypeDescription
testGroupnull | string-

Returns

AdImpression

Properties

adNetwork

adNetwork?: null | string

The name of the ad network which provided the ad. May be null.

adSdkName

adSdkName: string

The name of the SDK which provided the event; for example "ironsource" or "admob".

adUnit

adUnit: string

The format of the ad impression.

bundleId

bundleId?: null | string

The bundle ID of the advertised app. May be null.

instanceName

instanceName?: null | string

The name of the instance of the ad. May be null.

placement

placement?: null | string

The placement of the ad. May be null.

revenue

revenue?: null | Money

The amount of revenue this ad generated. May be zero (or missing) but must not be negative.

segmentName

segmentName?: null | string

The name of the segment of the ad. May be null.

testGroup

testGroup?: null | string

The test group of the user if we are A/B testing. May be null.