Args Reference
This page documents the argument objects used across the CiaoSDK API.
CiaoConsent
Passed to CiaoSDK.Initialize and CiaoSDK.UpdateConsent.
If adsConsent, mmpConsent, or analyticsConsent are not explicitly set, they inherit the value of gdprConsent .
| Field | Type | Description | Default |
|---|---|---|---|
gdprConsent | bool | GDPR consent granted. | true |
adsConsent | bool? | Ads (LevelPlay) consent. Overrides gdprConsent for ads only. | Inherits from gdprConsent |
mmpConsent | bool? | MMP (Singular) consent. Overrides gdprConsent for MMP only. | Inherits from gdprConsent |
analyticsConsent | bool? | Analytics (ByteBrew) consent. Overrides gdprConsent for analytics only. | Inherits from gdprConsent |
isChildDirected | bool | COPPA — user is under 13. | false |
isUnderAgeOfConsent | bool | GDPR — user is under the age of digital consent (typically 16). | false |
attGranted | bool | iOS App Tracking Transparency granted. | false |
LevelCompletedArgs
Passed to CiaoSDK.SendLevelCompleted.
| Field | Type | Description |
|---|---|---|
level | int | Level ID. |
interstitialViews | int | Interstitials shown during this level. |
rewardedViews | int | Rewarded ads shown during this level. |
time | int | Time spent in level (seconds). |
session | int | Current session number. |
ltv | float | Lifetime value (USD) so far. |
playerLevel | int | Player's overall progression level. |
currencyName | string (optional) | Name of the in-game currency tracked. |
currencyBalance | int (optional) | Currency balance at end of level. |
IAPArgs
Passed to CiaoSDK.SendIAPPurchased for Unity IAP purchases. Supports Unity IAP v4 (Product) and v5 (Order). For non-Unity IAP purchases (DTC, web shops, etc), see RevenueArgs.
| Field | Type | Description |
|---|---|---|
order (Unity IAP v5) | Order | The Unity IAP v5 Order object. |
product (Unity IAP v4) | Product | The Unity IAP v4 Product object. |
restored | bool | true if this is a restored purchase. Default: false. |
category | string | Optional product category. Default: "". |
RevenueArgs
Passed to CiaoSDK.SendIAPPurchased for non-Unity IAP purchases (DTC, web shop, etc). Use when you don’t have a Unity IAP Product or Order.
| Field | Type | Description |
|---|---|---|
currency | string | Required. ISO 4217 code, UPPERCASE (e.g. USD, EUR). |
amount | double | Required. Total transaction amount. Must be > 0. |
productSKU | string | Required. Product identifier in your catalog. |
transactionId | string | Required. Unique transaction ID. |
source | string | Required. Payment rail name (e.g. "Appcharge", "Stripe", "Hive", etc). |
productName | string | Optional. Human-readable product name. |
productCategory | string | Optional. Product category. |
productQuantity | int | Optional. Default 1. |
productPrice | double | Optional. Unit price. |
extra | Dictionary<string, object> | Optional. Extra attributes forwarded to MMP (promo codes, user tier, etc.). |
AdImpressionArgs
Passed to CiaoSDKAnalytics.SendAdImpression.
| Field | Type | Description |
|---|---|---|
adType | AdType | Enum: Interstitial, Rewarded, or Banner. |
adCount | int | Total impressions of this ad type so far. |
levelId | int | Current level ID. |
placement | string | Placement name. Default: null. |
CheatArgs
Passed to CiaoSDK.SendCheaterDetected.
| Field | Type | Description |
|---|---|---|
reason | CheatReason | Required. Enum: LevelJump, ThirdPartyInstall, TimeCheat, IAPFraud, MemoryEdit, SpeedHack. |
playtime | int? | Optional playtime in seconds. |
session | int? | Optional session number. |
claimedLevel | int? | Optional level claimed by client. |
lastValidLevel | int? | Optional last server-validated level. |
installSource | string | Optional install source. |
deviceTime | string | Optional device timestamp. |
serverTime | string | Optional server timestamp. |
productId | string | Optional product ID (for IAPFraud). |
Updated about 1 month ago
Did this page help you?
