YMMAdRevenueInfo class

The class contains immutable information about advertising revenue (Ad Revenue).

Use the YMMMutableAdRevenueInfo class to change information about advertising revenue.

The YMMAdRevenueInfo instance should be passed to the AppMetrica server using the reportAdRevenue method of the YMMYandexMetrica class.

Instance methods


-initWithAdRevenue:adRevenue:currency:	Initializes the instance of the `YMMAdRevenueInfo` class for sending information about advertising revenue.

Properties


adRevenue	The amount of money received from advertising revenue. Can't be negative.
currency	The currency in which adRevenue is represented. Must be in ISO-4217 format.
adType	Ad type. See the possible values in YMMAdType.
adNetwork	Yandex Advertising Network. The maximum length is 100 characters. If the value exceeds this limit, it will be truncated by AppMetrica.
adUnitID	Ad block ID. The maximum length is 100 characters. If the value exceeds this limit, it will be truncated by AppMetrica.
adUnitName	Ad block name. The maximum length is 100 characters. If the value exceeds this limit, it will be truncated by AppMetrica.
adPlacementID	Ad display location ID. The maximum length is 100 characters. If the value exceeds this limit, it will be truncated by AppMetrica.
adPlacementName	Ad display location name. The maximum length is 100 characters. If the value exceeds this limit, it will be truncated by AppMetrica.
precision	Accuracy. For example: “publisher_defined”, “estimated”. The maximum length is 100 characters. If the value exceeds this limit, it will be truncated by AppMetrica.
payload	Accuracy. For example: “publisher_defined”, “estimated”. Arbitrary payload: Additional information presented as key-value pairs. The maximum size is 30 KB. If the value exceeds this limit, it will be truncated by AppMetrica.


adRevenue	The amount of money received from advertising revenue. Can't be negative.
currency	The currency in which adRevenue is represented. Must be in ISO-4217 format.
adType	Ad type. See the possible values in YMMAdType.
adNetwork	Yandex Advertising Network. The maximum length is 100 characters. If the value exceeds this limit, it will be truncated by AppMetrica.
adUnitID	Ad block ID. The maximum length is 100 characters. If the value exceeds this limit, it will be truncated by AppMetrica.
adUnitName	Ad block name. The maximum length is 100 characters. If the value exceeds this limit, it will be truncated by AppMetrica.
adPlacementID	Ad display location ID. The maximum length is 100 characters. If the value exceeds this limit, it will be truncated by AppMetrica.
adPlacementName	Ad display location name. The maximum length is 100 characters. If the value exceeds this limit, it will be truncated by AppMetrica.
precision	Accuracy. For example: “publisher_defined”, “estimated”. The maximum length is 100 characters. If the value exceeds this limit, it will be truncated by AppMetrica.
payload	Accuracy. For example: “publisher_defined”, “estimated”. Arbitrary payload: Additional information presented as key-value pairs. The maximum size is 30 KB. If the value exceeds this limit, it will be truncated by AppMetrica.

Method descriptions

-initWithAdRevenue:adRevenue:currency:

- (instancetype)initWithAdRevenue:(NSDecimalNumber *)adRevenue currency:(NSString *)currency

Initializes the instance of the YMMAdRevenueInfo class for sending information about advertising revenue.

Parameters:


adRevenue	The amount of money received from advertising revenue. Can't be negative.
currency	The currency in which adRevenue is represented. Must be in ISO-4217 format.

Returns:

The YMMAdRevenueInfo class instance.

Property descriptions

adRevenue

(nonatomic, strong, readonly) NSDecimalNumber *adRevenue

The amount of money received from advertising revenue. Can't be negative.

currency

(nonatomic, copy, readonly) NSString *currency

The currency in which adRevenue is represented. Must be in ISO-4217 format.

adType

(nonatomic, assign, readonly) YMMAdType adType

Ad type. See the possible values in YMMAdType.

adNetwork

(nonatomic, copy, nullable, readonly) NSString *adNetwork

Yandex Advertising Network. The maximum length is 100 characters. If the value exceeds this limit, it will be truncated by AppMetrica.

adUnitID

(nonatomic, copy, nullable, readonly) NSString *adUnitID

Ad block ID. The maximum length is 100 characters. If the value exceeds this limit, it will be truncated by AppMetrica.

adUnitName

(nonatomic, copy, nullable, readonly) NSString *adUnitName

Ad block name. The maximum length is 100 characters. If the value exceeds this limit, it will be truncated by AppMetrica.

adPlacementID

(nonatomic, copy, nullable, readonly) NSString *adPlacementID

Ad display location ID. The maximum length is 100 characters. If the value exceeds this limit, it will be truncated by AppMetrica.

adPlacementName

(nonatomic, copy, nullable, readonly) NSString *adPlacementName

Ad display location name. The maximum length is 100 characters. If the value exceeds this limit, it will be truncated by AppMetrica.

precision

(nonatomic, copy, nullable, readonly) NSString *precision

Accuracy. For example: “publisher_defined”, “estimated”. The maximum length is 100 characters. If the value exceeds this limit, it will be truncated by AppMetrica.

payload

(nonatomic, copy, nullable, readonly) NSDictionary<NSString *, NSString *> *payload

Accuracy. For example: “publisher_defined”, “estimated”. Arbitrary payload: Additional information presented as key-value pairs. The maximum size is 30 KB. If the value exceeds this limit, it will be truncated by AppMetrica.