Input schema (JSON)
{
"type": "object",
"required": [
"title_id",
"value"
],
"properties": {
"value": {
"type": "object",
"title": "CommunityMarketingDefinitions",
"properties": {
"Teams": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityTeamSettings"
}
],
"description": "Creator teams: whether they are enabled and how a team-level reward is divided among members."
},
"Presets": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityMarketingPresetRegistry"
}
],
"description": "Preset registry: shared blocks referenced by campaigns through their Presets bindings. null = presets unused."
},
"Showcase": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityShowcaseSettings"
}
],
"description": "Public showcase of the program on the game's public page (idosgames.com/app/{id}): which parts everyone can see - rules, fund, creators' works with their metrics and rewards, likes and comments. Not set = the showcase is shown for an enabled program, works are approved-only."
},
"AntiFraud": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityAntiFraudSettings"
}
],
"description": "Anti-fraud policy: the hold period before earnings mature, the anomaly thresholds that freeze accrual, and the clawback rules."
},
"Campaigns": {
"type": [
"null",
"object"
],
"description": "Catalog of the title's campaigns, key = CampaignID. A title may run several campaigns at once (e.g. a launch push and an always-on program), each with its own rules and its own budget.",
"additionalProperties": {
"$ref": "#/definitions/CommunityCampaignDefinition"
}
},
"IsEnabled": {
"type": [
"boolean",
"null"
],
"description": "Master switch for the Community Marketing module. Not set = DISABLED (unlike Chat/Tutorial): the program hands real value to people outside the game, so a title that never configured it must not discover it running. Same reasoning as Referral."
},
"Providers": {
"type": [
"null",
"object"
],
"description": "Where the numbers come from, per social platform. Key = the CommunitySocialPlatform name (e.g. \"YouTube\", \"TikTok\", \"Instagram\"). A platform with no entry is treated as disabled.",
"additionalProperties": {
"$ref": "#/definitions/CommunityProviderSettings"
}
},
"Moderation": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityModerationSettings"
}
],
"description": "Submission moderation policy: what a human reviews and what passes automatically."
},
"Participation": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityParticipationSettings"
}
],
"description": "Who may join the program and how (open enrolment vs. application, requirements on the creator)."
}
},
"description": "Configuration of the title's Community Marketing program: campaigns that reward community members for posting about the game on external social platforms (YouTube/TikTok/Instagram), the payout rules (per-metric rate cards and milestone thresholds), budgets and caps, the moderation policy, the anti-fraud policy and where the view/like/comment/share numbers are pulled from. Submissions, metric snapshots, accruals and the payout journal are NOT here - they are operational data in their own collections. The Community Marketing pool is funded by a fee on player crypto withdrawals, configured in the Currency section (CryptoCurrencyDefinition.CommunityMarketingWithdrawalFeePercent), not here."
},
"title_id": {
"type": "string",
"description": "TitleID, для которого сохраняются данные."
}
},
"definitions": {
"LimitSpec": {
"type": "object",
"properties": {
"DailyCap": {
"type": "integer",
"format": "int32",
"description": "Cap on triggers/actions per calendar day (UTC). 0 = no limit."
},
"TotalCap": {
"type": "integer",
"format": "int32",
"description": "Lifetime cap per user. 0 = no limit."
},
"MaxPerWindow": {
"type": "integer",
"format": "int32",
"description": "Sliding window: max triggers within WindowSeconds. 0 = disabled."
},
"WindowSeconds": {
"type": "integer",
"format": "int32",
"description": "Sliding-window length (seconds). Used only when MaxPerWindow > 0."
},
"DailyWeightCap": {
"type": "integer",
"format": "int64",
"description": "Cap on weight (e.g. token amount) per calendar day (UTC). 0 = no limit."
},
"CooldownSeconds": {
"type": "integer",
"format": "int32",
"description": "Cooldown between triggers (seconds). 0 = no cooldown."
},
"PerActivationCap": {
"type": "integer",
"format": "int32",
"description": "Cap within a single activation/session. 0 = no limit."
}
},
"description": "Unified anti-farm limits (\"how much / how often\"). Replaces TriggerLimits (Scheduling), DealNodeLimitsDefinition (DealOffer), StoreOfferRules caps (Store) and ClaimRewardDefinition sliding fields (Reward). 0 on an axis = no limit. Superset of axes with DIFFERENT enforcement semantics: DailyCap/DailyWeightCap = calendar UTC day; MaxPerWindow/WindowSeconds = sliding window. Usually one set is filled per system, the rest = 0. Counters are stored/enforced by each system; this is config thresholds only."
},
"SegmentGate": {
"type": "object",
"properties": {
"MaxLevel": {
"type": "integer",
"format": "int64",
"description": "Maximum Board Rank. 0 = no upper bound."
},
"MinLevel": {
"type": "integer",
"format": "int64",
"description": "Minimum Board Rank (matches PublicData.BoardRank). 0 = no lower bound."
},
"Segments": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Allowed economy segments (matches PlayerEconomyTuningState.Segment: \"F2P\",\"Dolphin\",\"Whale\",\"VIP\"). Empty = any."
},
"Tutorial": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/TutorialGateCondition"
}
],
"description": "Tutorial condition: the gate passes only if the player is in the required progression state (TutorialGateCondition). null = not applied. By the same trick as Experiment, this gives \"after onboarding\" gating in every module already using SegmentGate, with no edits to them. To close a whole module there is a cheaper path — TutorialGlobalSettings.Blocking: one check in ClientRun instead of a condition on every entity."
},
"Countries": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Country filter (ISO 3166-1 alpha-2; matches PublicData.Country, else RegistrationCountry). Empty = all countries."
},
"Platforms": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/ClientPlatform"
},
"description": "Platforms the entity is available on. Empty/null = all. Unlike the other axes this one comes from the request platform (IGSService.ClientPlatform), not from the player document, and is passed to SegmentGateEvaluator.Passes as a separate REQUIRED argument. The axis is skipped when the platform is Unknown — deliberately soft, because it governs what is shown, not what is charged: payments are guarded by PriceOptionSelector.IsAvailableOn, where Unknown does not pass a non-empty platform list. Not needed to hide entities that simply cannot be paid for on a platform: storefronts already drop whatever has no available price option."
},
"Experiment": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/ExperimentVariantCondition"
}
],
"description": "A/B experiment condition: the gate passes only if the player is assigned to the required variant (ExperimentVariantCondition). null = not applied. A/B variants thus reuse the whole SegmentGate stack: two configs, each gated to its variant. Assignment is read from UserDataDocument.Experiments (sticky, stable-hash — see ExperimentAssigner)."
},
"MinPremiumTier": {
"type": "integer",
"format": "int32",
"description": "Minimum active premium tier (matches Premium.MaxActiveTier). 0 = no requirement."
},
"ActiveWithinDays": {
"type": "integer",
"format": "int32",
"description": "Active within the last X days (matches Usage.LastActiveAt). 0 = no restriction."
},
"RequiredPremiumIDs": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Required active premium IDs (ANY of the list is enough, via PremiumHelpers.GetActivePremiumIDs). Empty = no requirement."
},
"RegisteredWithinDays": {
"type": "integer",
"format": "int32",
"description": "Registered no earlier than X days ago (new players; matches RegistrationDate). 0 = no restriction."
}
},
"description": "Unified \"who it is available/applies to\" gate. Replaces BoostSegmentGate (TimedBoost), MailboxSegmentDefinition filters and StoreOfferRules premium fields. All conditions are AND-ed. An empty/unset field = no constraint on that axis; an empty/null gate = available to everyone. Resolved by SegmentGateEvaluator.Passes."
},
"ScheduleMode": {
"enum": [
"AlwaysOn",
"Scheduled",
"Chained",
"Triggered",
"Cyclic",
"Relative"
],
"type": "string",
"description": "",
"x-enumNames": [
"AlwaysOn",
"Scheduled",
"Chained",
"Triggered",
"Cyclic",
"Relative"
],
"x-enum-descriptions": [
"Active whenever enabled, no time gate (eternal leaderboard, manual boost).",
"Single fixed window [StartUtc..EndUtc] (see ScheduledWindow).",
"Recurring ordered list of phases (see ScheduleChain).",
"Activated/granted when a source fires (see ScheduleSpec.ActivationTriggers).",
"Calendar-aligned cycles with reset (see CyclicSchedule).",
"Window defined RELATIVE to the parent instance's start (see RelativeWindow). Resolved only when a parent is passed to ScheduleResolver.ResolveActive. Enables staged unlocking of sub-entities inside a recurring event (e.g. \"Day N opens (N-1)x24h after the current cycle instance start\"), so one config auto-repeats without absolute dates."
]
},
"ScheduleSpec": {
"type": "object",
"properties": {
"Mode": {
"oneOf": [
{
"$ref": "#/definitions/ScheduleMode"
}
],
"description": "Activation mode. Determines which sub-field is used."
},
"Chain": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/ScheduleChain"
}
],
"description": "Chain config. Required and used only when Mode = Chained."
},
"Cyclic": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CyclicSchedule"
}
],
"description": "Calendar-cycle config. Required and used only when Mode = Cyclic."
},
"IsActive": {
"type": "boolean",
"description": "Unified global on/off. false = entity paused without deleting config (replaces scattered IsActive/Enabled)."
},
"Relative": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/RelativeWindow"
}
],
"description": "Relative-window config. Required and used only when Mode = Relative."
},
"Scheduled": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/ScheduledWindow"
}
],
"description": "Single-window config. Required and used only when Mode = Scheduled."
},
"ActivationTriggers": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/TriggerSource"
},
"description": "Sources that cause activation/grant. Required and used only when Mode = Triggered. Matched via TriggerMatcher."
}
},
"description": "\"How an entity activates\" container, embedded into each system's definition. Exactly one sub-field is filled for the chosen Mode (plus ActivationTriggers for Triggered). Resolved via ScheduleResolver."
},
"CommunityCaps": {
"type": "object",
"properties": {
"CrossPost": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityCrossPostMode"
}
],
"description": "How a copy of the same video posted on another platform (cross-post) is paid. Not set = PayEach. A copy is declared by the creator on submission or marked by the publisher in moderation; the platform does not detect copies by itself."
},
"PeriodDays": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "Length of the period for the per-period caps, in days. Not set = 30. The window is rolling: counted backwards from now."
},
"PerSubmission": {
"type": [
"null",
"number"
],
"format": "decimal",
"description": "Maximum payout for a single submission. Not set or 0 = uncapped. This is the primary safety valve: one viral clip must not consume the whole fund overnight."
},
"PerTeamPerPeriod": {
"type": [
"null",
"number"
],
"format": "decimal",
"description": "Maximum payout to one team per period. Not set or 0 = uncapped."
},
"PerCreatorPerPeriod": {
"type": [
"null",
"number"
],
"format": "decimal",
"description": "Maximum payout to one creator per period. Not set or 0 = uncapped."
},
"MaxSubmissionsPerCreatorPerPeriod": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "How many submissions one creator may enter into this campaign per period. Not set or 0 = unlimited."
}
},
"description": "Spending caps. All caps are evaluated against PAID amounts, never earned ones."
},
"PresetBinding": {
"type": "object",
"properties": {
"Remove": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Keys removed from the merged result. Dictionary key for dictionaries; element key for keyed lists (Rank / SlotID / RuleID). null = remove nothing. Ignored when no preset is set."
},
"PresetID": {
"type": [
"null",
"string"
],
"description": "Preset key in the module registry (e.g. LeaderboardDefinitions.Presets.Milestones[PresetID]). Empty/null = preset unused (inline layer only)."
}
},
"description": "Wiring for one preset block of an entity: a reference into the module's preset registry + optional keys to drop. Reusable Core container, one per preset-able block, held inside the entity's Presets container. Replaces the former scattered flat *PresetID / *Remove fields. Combination is data-driven, no mode (PresetResolver): no PresetID -> inline only; preset + empty inline -> preset; preset + inline -> merge (preset base + inline overrides/adds by key), Remove drops keys. For a single object (Character Equipment) there is nothing to key-merge, so inline wins when both are present."
},
"ResourceEntry": {
"type": "object",
"properties": {
"Type": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/ResourceEntryType"
}
],
"description": "Resource type. Determines which fields must be populated: Item (catalog item), VirtualCurrency (off-chain), CryptoCurrency (on-chain), or Purchase (real-money payment in a store)."
},
"Amount": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Amount of the resource. Used by every type except Purchase, where the quantity is decided by the store itself and this field is ignored. Amount=0 is valid in Consume.PremiumTiers and means 'do not charge'."
},
"ItemID": {
"type": [
"null",
"string"
],
"description": "Item identifier within the catalog. Used only when Type is Item. Corresponds to a key in cfg.Item.Catalogs[Catalog].Items."
},
"AmountUsd": {
"type": [
"null",
"number"
],
"format": "decimal",
"description": "CryptoCurrency only: the amount in USD instead of a token count. At the moment of the operation the engine converts it to tokens at the LIVE market price of the token (charge: rounded up to a whole token; grant: rounded down). When set, Amount is ignored; the operation result carries the converted Amount."
},
"CatalogID": {
"type": [
"null",
"string"
],
"description": "Item catalog identifier. Used only when Type is Item. Corresponds to a key in cfg.Item.Catalogs (e.g. \"main\", \"season\")."
},
"ProductID": {
"type": [
"null",
"string"
],
"description": "IAP product identifier. Used only when Type is Purchase. Corresponds to a key in cfg.Purchase.Products — OUR stable product ID, not the store SKU (per-store SKUs live in IapProductDefinition.StoreProductIDs)."
},
"CurrencyID": {
"type": [
"null",
"string"
],
"description": "Currency identifier. Used only when Type is VirtualCurrency or CryptoCurrency. Corresponds to a key in cfg.Currency.VirtualCurrencies or cfg.Currency.CryptoCurrencies."
}
},
"description": "Universal container for a single entry in a resource bundle (item or currency). The set of populated fields depends on Type: Item uses CatalogID/ItemID/Amount; VirtualCurrency or CryptoCurrency uses CurrencyID/Amount; Purchase uses only ProductID (paid in a store)."
},
"ResourceGrant": {
"type": "object",
"properties": {
"Standard": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/ResourceBundle"
}
],
"description": "Base — what to grant to all players including F2P."
},
"PremiumTiers": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/PremiumTierBundle"
},
"description": "Structurally different rewards for premium players (different ItemID/Target/...). Governed by global cfg.Reward.TierRewards.RewardMode (Additive/Replace) and RewardStackLowerTiers."
},
"PremiumBonuses": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/PremiumTierBonus"
},
"description": "Percentage uplift on Standard for premium players. Single best matching tier wins (no stacking): Amount = ceil(Amount * (1 + Bonus)). Wiped under Mode=Replace if any PremiumTier matches."
}
},
"description": "Grant direction container for ResourceOperation. Two independent premium mechanisms over Standard: PremiumBonuses applies a percentage uplift to Standard (single best tier wins, no stack), and PremiumTiers provides structurally different rewards governed by cfg.Reward.TierRewards (Additive or Replace mode; in Replace the bonused Standard is wiped). Both mechanisms can be used together or independently."
},
"ScheduleChain": {
"type": "object",
"properties": {
"AnchorUtc": {
"type": [
"null",
"string"
],
"format": "date-time",
"description": "Anchor date (UTC). The first phase of the first cycle starts here; all subsequent dates are computed from the anchor + phase durations + pauses. null = no anchor → the chain is unconfigured and never resolves."
},
"MaxCycles": {
"type": "integer",
"format": "int32",
"description": "Maximum number of full cycles. 0 = infinite."
},
"PauseBetweenCyclesSec": {
"type": "integer",
"format": "int32",
"description": "Pause between full cycles (seconds). 0 = no pause."
},
"PauseBetweenPhasesSec": {
"type": "integer",
"format": "int32",
"description": "Pause between phases inside one cycle (seconds). 0 = no pause."
}
},
"description": "Recurring phase chain. Holds ONLY chain timing — the phase list lives on the module (a phase composes ScheduleChainPhase + its payload), so the resolver takes a projected IReadOnlyList<ScheduleChainPhase>. Unified replacement of the schedule parts of EventChainDefinition / LeaderboardChainConfig / BoostChainDefinition / CoopEventChainDefinition / SeasonChainDefinition."
},
"TriggerSource": {
"type": "object",
"properties": {
"Limits": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/LimitSpec"
}
],
"description": "Anti-farm limits of the source — unified LimitSpec (per-day weight cap DailyWeightCap, per-day trigger cap DailyCap, CooldownSeconds). null = no limits (e.g. leaderboards intentionally apply none)."
},
"Params": {
"type": [
"null",
"object"
],
"description": "Context parameters for filtering/identifying the source. CustomAction: {\"ActionName\":\"watch_ad\"}. QuestComplete: {\"QuestID\":\"win_5_raids\"} and/or {\"CycleID\":\"daily\"}. StorePurchase: {\"OfferID\":\"starter_pack\"}. MarketplaceSell/MarketplaceBuy: CatalogID / ItemID / OfferType. An unset or empty parameter means \"any\". Keys not listed here are not checked by the matcher.",
"additionalProperties": {
"type": "string"
}
},
"BaseWeight": {
"type": "integer",
"format": "int64",
"description": "Base \"weight\" per trigger: token amount (TimedEvent) or score (Leaderboard). Unifies the former BaseAmount/BaseScore. Unused for TimedBoost triggers (a boost has no quantity)."
},
"SourceType": {
"oneOf": [
{
"$ref": "#/definitions/EventTokenSourceType"
}
],
"description": "Source type. Identifies which game event fires."
},
"OutcomeFilter": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Only for SourceType = BoardAttack / BoardRaid / BoardBuild. Whitelist of outcomes. Empty/null = any. BoardAttack: [\"HIT\"]/[\"BLOCKED\"]; BoardRaid: [\"FINISHED_SMALL\"]/[\"FINISHED_MEDIUM\"]/[\"FINISHED_BIG\"]; BoardBuild: [\"BUILD\"]/[\"STAGE_COMPLETE\"]."
},
"TileTypeFilter": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Only for SourceType = BoardTileLanding. Whitelist of tile types (BoardTileType names or CustomTypeID) that fire on landing. Case-insensitive. Empty/null = any tile (not recommended)."
},
"TileIndexFilter": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"format": "int32"
},
"description": "Only for SourceType = BoardTileLanding. Whitelist of tile indices. Empty/null = any index. Works in AND with TileTypeFilter."
},
"ChanceOutcomeFilter": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Only for SourceType = BoardTileLanding on Chance tiles. Whitelist of ChanceOutcome.OutcomeID values. Case-insensitive. Works in AND with TileTypeFilter/TileIndexFilter. Empty/null = not applied."
},
"ScaleWithRollMultiplier": {
"type": "boolean",
"description": "Whether BaseWeight scales with the player's RollMultiplier. true: Weight = BaseWeight x M_roll. false: fixed amount."
}
},
"description": "Unified trigger source: which game event grants progress/grant and under which filters. Replaces EventTokenSource (TimedEvent), LeaderboardScoreSource (Leaderboard) and BoostTriggerSource (TimedBoost). SourceType reuses the existing EventTokenSourceType. Matched via TriggerMatcher."
},
"ClientPlatform": {
"enum": [
"Unknown",
"Web",
"Android",
"Ios"
],
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"Web",
"Android",
"Ios"
],
"x-enum-descriptions": [
"Platform was not reported, or the reported one contradicts the request fingerprint.",
"Browser: web build, WebGL, or a messenger mini-app.",
"Android build (Google Play Billing).",
"iOS / iPadOS build (App Store, StoreKit)."
]
},
"CyclicSchedule": {
"type": "object",
"properties": {
"Reset": {
"oneOf": [
{
"$ref": "#/definitions/ScheduleResetPeriod"
}
],
"description": "Cycle reset frequency."
},
"AnchorUtc": {
"type": [
"null",
"string"
],
"format": "date-time",
"description": "FixedInterval only: anchor instant (coerced to UTC, used as-is including time-of-day) from which IntervalSeconds windows are counted; the anchor defines alignment. null/unset = 2026-01-01 00:00 UTC. Ignored for calendar resets."
},
"ClaimGraceHours": {
"type": "integer",
"format": "int32",
"description": "Grace window (hours) after cycle end to claim previous-cycle rewards. 0 = current cycle only."
},
"IntervalSeconds": {
"type": "integer",
"format": "int64",
"description": "FixedInterval only: window length in SECONDS (e.g. 86400 = 1 day, 21600 = 6 hours, 864000 = 10 days). default = 86400 (1 day). Ignored for calendar resets."
},
"PauseBetweenCyclesSec": {
"type": "integer",
"format": "int64",
"description": "FixedInterval only: pause (SECONDS) between active windows. 0 = back-to-back. When >0 the cycle 'pulses': active for IntervalSeconds, then a pause of this length (inactive during the pause — CanEarn=false/IsInPause), then the next window. Full period = IntervalSeconds + PauseBetweenCyclesSec. Ignored for calendar resets (they are gapless by definition)."
}
},
"description": "Calendar-aligned cycles with reset. Unified replacement of LeaderboardScheduleMode.Cyclic + LeaderboardCycleReset."
},
"EventTokenType": {
"enum": [
"TimedEvent",
"Leaderboard",
"CoopEvent",
"Season",
"Quest",
"DealOffer"
],
"type": "string",
"description": "",
"x-enumNames": [
"TimedEvent",
"Leaderboard",
"CoopEvent",
"Season",
"Quest",
"DealOffer"
]
},
"RelativeWindow": {
"type": "object",
"properties": {
"ClaimGraceHours": {
"type": "integer",
"format": "int32",
"description": "Grace window (hours) after the window ends for claiming rewards. Default 0."
},
"DurationSeconds": {
"type": "integer",
"format": "int64",
"description": "Window length in SECONDS. 0 (or less) = the window lasts until the parent's end (typical for \"stage opens and stays until the event ends\"). >0 = lasts exactly that long (but never longer than the parent)."
},
"AllowEarningAfterEnd": {
"type": "boolean",
"description": "Whether progress can still be earned after the window ends (until grace ends). Default false."
},
"OffsetSecondsFromParentStart": {
"type": "integer",
"format": "int64",
"description": "Window start offset in SECONDS from the parent instance start. 0 = open immediately with the parent. E.g. \"Day N\" = (N-1) * 86400."
}
},
"description": "Window defined RELATIVE to the parent instance's start (see ScheduleMode.Relative). Window start = parent.StartUtc + OffsetSecondsFromParentStart. End = start + DurationSeconds, or (if DurationSeconds <= 0) the parent's end; never extends past the parent's end. Lets one config auto-repeat: sub-entity dates are computed from the current parent instance instead of being written absolutely."
},
"ResourceBundle": {
"type": "object",
"properties": {
"Entries": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/ResourceEntry"
},
"description": "Items and currencies."
},
"EventTokens": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/EventTokenOperation"
},
"description": "Event tokens."
}
},
"description": "Set of items, currencies and tokens for a single operation direction (grant only or consume only)."
},
"CommunityBudget": {
"type": "object",
"properties": {
"OnExhausted": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityBudgetExhaustedBehavior"
}
],
"description": "What happens when the fund is exhausted. Not set = StopAccruing."
},
"TotalAmount": {
"type": [
"null",
"number"
],
"format": "decimal",
"description": "Total campaign fund, in units of the payout currency. Not set or 0 = no overall fund; only the per-submission and per-creator caps limit spending."
},
"WarnAtSpentFraction": {
"type": [
"null",
"number"
],
"format": "decimal",
"description": "Fraction of the fund (0..1) at which the publisher is warned. Not set = 0.8."
}
},
"description": "The campaign's budget."
},
"ScheduledWindow": {
"type": "object",
"properties": {
"EndUtc": {
"type": [
"null",
"string"
],
"format": "date-time",
"description": "Window end (UTC). After this, earning stops unless AllowEarningAfterEnd. null = unset -> the window is unconfigured and never active."
},
"StartUtc": {
"type": [
"null",
"string"
],
"format": "date-time",
"description": "Window start (UTC). The entity is active from this moment. null = unset -> the window is unconfigured and never active (BOTH bounds are required)."
},
"ClaimGraceHours": {
"type": "integer",
"format": "int32",
"description": "Grace window (hours) after EndUtc for claiming rewards. Default 48."
},
"AllowEarningAfterEnd": {
"type": "boolean",
"description": "Whether progress can still be earned after EndUtc (until grace ends). Default false."
}
},
"description": "Single fixed-date window. Unified replacement of the schedule parts of ScheduledEventDefinition / LeaderboardScheduledConfig / ScheduledBoostDefinition."
},
"PremiumTierBonus": {
"type": "object",
"properties": {
"Bonus": {
"type": [
"null",
"number"
],
"format": "double",
"description": "Bonus as a SHARE: 0.1 = +10%, 1.0 = double (x2). Empty or 0 = no bonus. The unit is the same across the whole platform — never a 0..100 percent."
},
"MinPremiumTier": {
"type": "integer",
"format": "int32",
"description": "Minimum tier required to qualify for this modifier."
},
"RequiredPremiumID": {
"type": [
"null",
"string"
],
"description": "Optional specific subscription ID. null = any subscription matching MinPremiumTier."
}
},
"description": "Percentage bonus on ResourceGrant.Standard for a premium tier. All Standard Amounts are multiplied by (1 + Bonus) with Math.Ceiling rounding. Applies only to Standard; in Replace mode the bonused Standard is wiped when any PremiumTier matches. Best matching tier wins, bonuses do not stack. Symmetric to PremiumTierDiscount."
},
"TutorialGateMode": {
"enum": [
"Completed",
"Started",
"StepReached"
],
"type": "string",
"description": "",
"x-enumNames": [
"Completed",
"Started",
"StepReached"
],
"x-enum-descriptions": [
"The flow is finished. Default.",
"The flow is started (in progress or already finished).",
"A specific step has been reached (TutorialGateCondition.StepID)."
]
},
"CommunityRateCard": {
"type": "object",
"properties": {
"Amount": {
"type": [
"null",
"number"
],
"format": "decimal",
"description": "How much currency is paid per PerUnits of the metric. Not set and zero are DIFFERENT: not set falls through to the preset, zero is a final \"this metric pays nothing\" that overrides the preset."
},
"PerUnits": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "How many units of the metric Amount is paid for. Not set = 1000 (the industry-standard per-mille rate). Zero or negative is treated as 1000."
},
"IsEnabled": {
"type": [
"boolean",
"null"
],
"description": "Whether this metric is paid at all. Not set = yes."
},
"NetworkID": {
"type": [
"null",
"string"
],
"description": "Network whose Community Marketing pool bucket the payout is drawn from. Required when CurrencyKind = CryptoCurrency, ignored for virtual currency. The title's pool is tracked per (network, currency) pair and one currency may be bound to several networks, so this cannot be guessed."
},
"CurrencyID": {
"type": [
"null",
"string"
],
"description": "Currency key in cfg.Currency.VirtualCurrencies or cfg.Currency.CryptoCurrencies, depending on CurrencyKind."
},
"CurrencyKind": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityPayoutCurrencyKind"
}
],
"description": "Payout currency kind. Not set = VirtualCurrency. CryptoCurrency additionally moves value out of the title's Community Marketing pool bucket at claim time."
},
"MaxModeratorCoefficient": {
"type": [
"null",
"number"
],
"format": "decimal",
"description": "Upper bound for the moderator coefficient. Not set = 10. Exists so a typo in the coefficient field cannot bill the campaign an order of magnitude more than intended."
},
"AllowModeratorCoefficient": {
"type": [
"boolean",
"null"
],
"description": "Whether a moderator may set a per-submission coefficient that multiplies this rate. Not set = yes. The coefficient itself lives on the submission, not here."
}
},
"description": "Payout rate for one metric. This carries a currency and a number rather than a full ResourceGrant (which milestones use) because a rate is LINEAR: the amount scales with the metric, and there is no meaningful way to scale items or premium tier overlays by a fractional view count. Fixed rewards where an item makes sense are milestones."
},
"EventTokenAddress": {
"type": "object",
"properties": {
"Type": {
"oneOf": [
{
"$ref": "#/definitions/EventTokenType"
}
],
"description": "System the tokens belong to."
},
"EntityID": {
"type": [
"null",
"string"
],
"description": "Event identifier within the system. In TITLE CONFIG (rewards written by a designer or an AI agent) scheduled systems use the SHORT form — the cycle number is unknowable at config time: \"{TimedEventID}\" / \"{LeaderboardID}\" = whichever instance is active at grant time, or \"{ID}:{ChainedEventID}\" = that chain phase in the current cycle. The engine (EventTokenAddressResolver in ResourceService) expands it before granting; a grant with no active instance is dropped. At RUNTIME the bucket address is always the full form \"{EntityID}:{InstanceKey}\": TimedEvent Scheduled → \"{TimedEventID}:s{yyyyMMddHHmm}\"; TimedEvent Chain → \"{chainID}:{cycleIndex}:{chainedEventID}\"; Leaderboard → \"{leaderboardID}:{instanceKey}\"; CoopEvent → CoopChainID; Season → SeasonChainID."
}
},
"description": "Universal event-token address. Uniquely identifies the system and event the tokens belong to."
},
"PremiumTierBundle": {
"type": "object",
"properties": {
"Resources": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/ResourceBundle"
}
],
"description": "Items, currencies and tokens of this tier. Entries with Amount=0 are valid and mean 'skip'. Empty/null Resources in Consume.PremiumTiers means 'premium pays nothing' (equivalent to Discounts: 1.0)."
},
"MinPremiumTier": {
"type": "integer",
"format": "int32",
"description": "Minimum tier required to qualify for this modifier."
},
"RequiredPremiumID": {
"type": [
"null",
"string"
],
"description": "Optional specific subscription ID. null = any subscription matching MinPremiumTier."
}
},
"description": "Per-tier bundle describing a structurally different set of resources (different ItemIDs/tokens/currencies) available only to subscribers. Used in both ResourceGrant.PremiumTiers (rewards) and ResourceConsume.PremiumTiers (price). Differs from PremiumTierBonus/PremiumTierDiscount which only modify Standard Amounts by percentage."
},
"ResourceEntryType": {
"enum": [
"Item",
"VirtualCurrency",
"CryptoCurrency",
"Purchase",
"RewardedVideoCredit"
],
"type": "string",
"description": "",
"x-enumNames": [
"Item",
"VirtualCurrency",
"CryptoCurrency",
"Purchase",
"RewardedVideoCredit"
],
"x-enum-descriptions": [
"Catalog item. Requires CatalogID, ItemID and Amount.",
"In-game (off-chain) virtual currency. Requires CurrencyID and Amount. Looked up in cfg.Currency.VirtualCurrencies.",
"On-chain cryptocurrency. Requires CurrencyID and Amount. Looked up in cfg.Currency.CryptoCurrencies.",
"Real-money payment in a store. Requires only ProductID (a product from cfg.Purchase.Products); the amount and currency are decided by the store from the SKU price tier. NOT a storable resource and never passes through ResourceService — the money is paid outside before the server learns about it, so the entry is consumed by the receipt check (ExternalPaymentGate) and stripped before the resource operation. Allowed only in Consume and only for Consumable products.",
"Rewarded-video credit. One credit equals one verified ad view that can be spent in systems requiring rewarded video (lootbox open, reward double, re-roll, booster). Granted +1 per server-verified view, or as N from milestones/quests/premium perks; spent -1 per gated action."
]
},
"CommunityBriefItem": {
"type": "object",
"properties": {
"Text": {
"type": [
"null",
"string"
],
"description": "Item text shown to creators."
},
"ItemID": {
"type": [
"null",
"string"
],
"description": "Stable item ID - a moderator's rejection references it. Keep it when editing the text."
}
},
"description": "One brief item."
},
"CommunityBriefLink": {
"type": "object",
"properties": {
"Url": {
"type": [
"null",
"string"
],
"description": "Absolute http(s) URL."
},
"Title": {
"type": [
"null",
"string"
],
"description": "Link title."
}
},
"description": "A link in the brief."
},
"CommunityMetricKind": {
"enum": [
"Views",
"Likes",
"Comments",
"Shares"
],
"type": "string",
"description": "",
"x-enumNames": [
"Views",
"Likes",
"Comments",
"Shares"
],
"x-enum-descriptions": [
"Views / plays / impressions, depending on what the platform calls it.",
"Likes.",
"Comments.",
"Shares / reposts."
]
},
"EventTokenOperation": {
"type": "object",
"properties": {
"Amount": {
"type": "integer",
"format": "int64",
"description": "Token amount — how many to grant or consume."
},
"Source": {
"type": [
"null",
"string"
],
"description": "Operation source (sourceKey used for analytics and limits)."
},
"Address": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/EventTokenAddress"
}
],
"description": "Event token address — where to grant or consume."
}
},
"description": "Information about granted event tokens. Returned in Board_Roll, QuestComplete and other responses. All multipliers (Roll/Premium/BonusWindow/ProgressiveTier/SeasonBuffs) are applied via ModifierService before ResourceService; this carries the final amount. Use ModifierApplyResult alongside ResourceOperation if UI needs multiplier breakdown."
},
"MilestoneDefinition": {
"type": "object",
"properties": {
"Rewards": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/ResourceGrant"
}
],
"description": "Base rewards. Always granted on a successful claim."
},
"SortOrder": {
"type": "integer",
"format": "int32",
"description": "Sort order in the UI (lower = higher/earlier)."
},
"AssetPaths": {
"type": [
"null",
"object"
],
"description": "Milestone images (icon, badge). null = unset.",
"additionalProperties": {
"type": "string"
}
},
"IsFeatured": {
"type": "boolean",
"description": "Featured milestone: special UI styling. With MilestoneClaimMode.FeaturedAfterEnd these can only be claimed after the instance ends."
},
"DisplayName": {
"type": [
"null",
"string"
],
"description": "Display name for UI/CMS. null = unset."
},
"MilestoneID": {
"type": [
"null",
"string"
],
"description": "Unique milestone ID within its owning entity (Mongo-safe, claim idempotency key)."
},
"BonusRewards": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/ResourceGrant"
}
],
"description": "Bonus-window overlay: extra rewards on top of Rewards when the bonus phase is active at claim time (MilestoneRewardContext.BonusActive). Applied via MilestoneRewardResolver. null = no bonus part."
},
"RequiredProgress": {
"type": "integer",
"format": "int64",
"description": "Threshold over ACCUMULATED progress to unlock. EventToken systems: EventTokenBalanceData.TotalEarned (not current balance). CommunityChest: shared group progress."
},
"SeasonTierRewards": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/SeasonTierRewardSet"
}
],
"description": "Season-tier overlay: reward scaling by the player's season tier. Applied via MilestoneRewardResolver (SeasonTierRewardResolver.Resolve) only when MilestoneRewardContext.SeasonChainID is set. null = disabled."
}
},
"description": "Unified milestone primitive for all platform systems (TimedEvent, Leaderboard, Quest, CommunityChest, DealOffer). Replaces the per-module milestone definitions. Threshold is checked against accumulated progress (RequiredProgress): EventToken systems use EventTokenBalanceData.TotalEarned; CommunityChest uses shared group progress. Reward overlays BonusRewards (bonus-window) and SeasonTierRewards (season-tier) are platform-wide optional fields applied via MilestoneRewardResolver; leave null if unused."
},
"ScheduleResetPeriod": {
"enum": [
"Hourly",
"Daily",
"Weekly",
"Monthly",
"Yearly",
"FixedInterval",
"Never"
],
"type": "string",
"description": "",
"x-enumNames": [
"Hourly",
"Daily",
"Weekly",
"Monthly",
"Yearly",
"FixedInterval",
"Never"
],
"x-enum-descriptions": [
null,
null,
null,
null,
null,
"Every CyclicSchedule.IntervalSeconds seconds from CyclicSchedule.AnchorUtc — a fixed interval, not calendar-aligned (e.g. \"every 6 hours\" or \"every 10 days\"). Alignment is defined by the anchor.",
"No reset — eternal (all-time) instance."
]
},
"SeasonTierRewardSet": {
"type": "object",
"properties": {
"Bundles": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/SeasonTierRewardBundle"
},
"description": "Structurally different rewards for specific tiers. On match, replaces the base ResourceGrant entirely (Replace)."
},
"Multipliers": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/SeasonTierRewardMultiplier"
},
"description": "Multipliers applied to Amount of the base ResourceGrant. Used ONLY if no Bundles entry matched."
}
},
"description": "Generic container of season-tier reward scaling. Used by any platform system (leaderboards, lootboxes, shop, daily) that wants to scale a ResourceGrant by the player's current tier in a season chain. Empty/null lists = neutral."
},
"WalletPlayTokenGate": {
"type": "object",
"properties": {
"Enabled": {
"type": "boolean",
"description": "Whether the requirement is active. False skips this gate (does not block)."
},
"NetworkID": {
"type": [
"null",
"string"
],
"description": "Network this gate applies to (key from Blockchain.Networks)."
},
"CurrencyID": {
"type": [
"null",
"string"
],
"description": "CurrencyID (cfg.Currency.CryptoCurrencies) whose balance is checked. Its binding for NetworkID provides ContractAddress (mint for Solana) and Decimals."
},
"MinBalance": {
"type": "number",
"format": "decimal",
"description": "Minimum balance in whole units (e.g. 1000 = 1000 game tokens)."
},
"DenyMessage": {
"type": [
"null",
"string"
],
"description": "Optional custom denial message shown to the client (otherwise a default text is used)."
},
"BalanceSource": {
"oneOf": [
{
"$ref": "#/definitions/WalletGateBalanceSource"
}
],
"description": "Where to read the balance compared against MinBalance: OnChain (wallet balance via RPC only), Combined (on-chain + in-game available balance InventoryV2.CryptoCurrencies[CurrencyID].Amount, excluding Frozen), InGame (in-game available balance only; no wallet, no RPC, NetworkID ignored). Default OnChain."
}
},
"description": "One wallet-balance requirement for play access. Token contract and on-chain decimals are resolved from CryptoCurrencyDefinition.Networks by (CurrencyID, NetworkID), not duplicated here."
},
"EventTokenSourceType": {
"enum": [
"BoardTileLanding",
"BoardPassStart",
"BoardAttack",
"BoardRaid",
"BoardBuild",
"BoardStageComplete",
"BoardSpecialComplete",
"QuestComplete",
"StorePurchase",
"DailyLogin",
"ReferralInvite",
"MilestoneReward",
"CustomAction",
"LeaderboardRankReward",
"MarketplaceSell",
"MarketplaceBuy",
"CurrencySpent",
"LootboxOpened",
"IapPurchase",
"CryptoDeposit",
"CryptoWithdraw",
"CryptoSpent",
"CurrencyEarned",
"CryptoEarned",
"ClientScore"
],
"type": "string",
"description": "",
"x-enumNames": [
"BoardTileLanding",
"BoardPassStart",
"BoardAttack",
"BoardRaid",
"BoardBuild",
"BoardStageComplete",
"BoardSpecialComplete",
"QuestComplete",
"StorePurchase",
"DailyLogin",
"ReferralInvite",
"MilestoneReward",
"CustomAction",
"LeaderboardRankReward",
"MarketplaceSell",
"MarketplaceBuy",
"CurrencySpent",
"LootboxOpened",
"IapPurchase",
"CryptoDeposit",
"CryptoWithdraw",
"CryptoSpent",
"CurrencyEarned",
"CryptoEarned",
"ClientScore"
],
"x-enum-descriptions": [
"Landing on an EventToken tile on the board.",
"Passing start (GO) on the board.",
"Successful board attack.",
"Successful board raid.",
"Building or repairing a structure on the board.",
"Completing a board stage.",
"Completing a board Special mode — either via Instant choice or via Claim after the Timed window. Post-resolution source (mirrors BoardAttack/BoardRaid): fires at the final Special reward grant, separately from BoardTileLanding (which fires on the actual tile landing during Roll).",
"Completing a quest.",
"Store purchase.",
"Daily login.",
"Referral invite.",
"Token grant as a reward for a milestone or streak in another event. Server-only source — the client cannot invoke it directly.",
"Arbitrary action — the developer calls the server API with ActionName in Params.",
null,
"Marketplace (v2) sale — deal settlement on the seller side. Server-only source. Filter Params: CatalogID / ItemID / OfferType.",
"Marketplace (v2) purchase — deal settlement on the buyer side. Server-only source. Filter Params: CatalogID / ItemID / OfferType.",
"In-game currency spend — any scenario where a resource operation actually consumed currency. Server-only source. The multiplier equals the amount spent. Filter Params: CurrencyID.",
"Opening a lootbox/chest. Server-only source. The multiplier equals how many boxes were opened in the call. Filter Params: LootboxID.",
"Real-money store purchase (IAP). Server-only source: fired in PurchaseV2 AFTER the receipt is verified and rewards are granted. The multiplier equals the number of product units granted. Filter Params: ProductID, Store. Deliberately separate from StorePurchase, which covers in-game currency spending.",
"Crypto deposit credited to the in-game balance. Multiplier is 1 (one operation). Filter Params: CurrencyID, NetworkID.",
"Crypto withdrawal CONFIRMED on chain. Multiplier is 1 (one operation). Filter Params: CurrencyID, NetworkID.",
"Spending crypto currency in-game. The multiplier equals the amount spent. Filter Params: CurrencyID.",
"In-game currency GRANT — mirror of CurrencySpent. The multiplier equals the amount granted, so ScaleWithRollMultiplier picks the meaning: \"earn N currency\" or \"receive currency N times\". Filter Params: CurrencyID and Origin (\"Gameplay\" | \"RewardClaim\"), the latter separating gameplay earnings from reward payouts — without it a goal like \"earn N\" would be closed by another quest's reward.",
"CRYPTO currency GRANT in-game (wallet deposits are NOT included — that is CryptoDeposit). The multiplier equals the amount granted. Filter Params: CurrencyID, Origin.",
"Leaderboard ScoreSources only: the board accepts the NUMBER the game submits itself (SubmitScore / SubmitScoresBatch). Not an event — it grants nothing and matches nothing, it only allows. Without it the board refuses a score from the game: an empty ScoreSources list means the board is not set up. Caps live in Limits: PerActivationCap = max score of ONE submission, DailyCap / DailyWeightCap = submissions / total score per UTC day, CooldownSeconds, MaxPerWindow + WindowSeconds, TotalCap = submissions for all time. A submission over a cap is refused, not trimmed. BaseWeight is not read. Set caps the game can really reach: the client is not trusted, they are the only limit on a forged score."
]
},
"CommunityPlatformRule": {
"type": "object",
"properties": {
"Weight": {
"type": [
"null",
"number"
],
"format": "decimal",
"description": "Multiplier applied to this platform's metrics. Not set = 1. Zero is valid and means \"submissions accepted but not paid\"."
},
"IsEnabled": {
"type": [
"boolean",
"null"
],
"description": "Whether the platform counts at all. Not set = yes."
},
"RateCards": {
"type": [
"null",
"object"
],
"description": "Per-platform rate overrides, key = CommunityMetricKind name. Merged field-by-field over the campaign rate cards: not set = inherit from the campaign, set = final (including zero, which means \"this metric is not paid on this platform\"). Not set = the platform has no own rates.",
"additionalProperties": {
"$ref": "#/definitions/CommunityRateCard"
}
},
"Milestones": {
"type": [
"null",
"object"
],
"description": "Per-platform milestone overrides, grouped by metric exactly like the campaign ones. Overriding happens PER METRIC, not per threshold: thresholds of one metric form a ladder, so a per-threshold merge would splice a campaign step into a platform ladder. Metric set here = this platform's ladder replaces the campaign's for that metric (an empty ladder means \"no milestones for this counter here\"); metric not set = the campaign ladder applies.",
"additionalProperties": {
"$ref": "#/definitions/CommunityMetricMilestones"
}
}
},
"description": "One platform's weight inside a campaign."
},
"CommunityProviderMode": {
"enum": [
"Off",
"Official",
"Aggregator",
"Manual"
],
"type": "string",
"description": "",
"x-enumNames": [
"Off",
"Official",
"Aggregator",
"Manual"
],
"x-enum-descriptions": [
"Disabled: submissions on this platform are not accepted.",
"The platform's own API, using the publisher's credentials.",
"A third-party aggregator, using the publisher's vendor key.",
"Numbers are entered by a moderator by hand. Always available and needs no credentials."
]
},
"CommunityShowcaseSort": {
"enum": [
"New",
"TopViews"
],
"type": "string",
"description": "",
"x-enumNames": [
"New",
"TopViews"
],
"x-enum-descriptions": [
"Newest submissions first.",
"Most viewed first."
]
},
"CommunityTeamSettings": {
"type": "object",
"properties": {
"IsEnabled": {
"type": [
"boolean",
"null"
],
"description": "Whether creator teams are enabled. Not set = no."
},
"SplitMode": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityTeamSplitMode"
}
],
"description": "How a team-level reward is divided among members. Not set = ByContribution."
},
"MaxMembers": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "Maximum members per team. Not set = 10."
},
"CaptainSharePercent": {
"type": [
"null",
"number"
],
"format": "decimal",
"description": "Fraction of a team reward taken by the captain on top of their normal share (0..1). Not set = 0."
},
"AllowCreatorCreatedTeams": {
"type": [
"boolean",
"null"
],
"description": "Whether a creator may create a team themselves. Not set = yes. Disabled means only the publisher creates teams."
}
},
"description": "Creator teams."
},
"TutorialGateCondition": {
"type": "object",
"properties": {
"Mode": {
"oneOf": [
{
"$ref": "#/definitions/TutorialGateMode"
}
],
"description": "What exactly must hold for those flows. Default Completed."
},
"Negate": {
"type": "boolean",
"description": "Invert the condition. Needed for the reverse case — \"show this starter offer ONLY to players still in the tutorial\". Default false."
},
"StepID": {
"type": [
"null",
"string"
],
"description": "The step that must be reached. Read only when Mode = StepReached, and applied to every flow in FlowIDs."
},
"FlowIDs": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Flows whose state is checked. Empty = the condition is not applied (the gate passes). Multiple entries are AND-ed: \"after the intro AND after the raid tutorial\"."
},
"SkippedCountsAsCompleted": {
"type": "boolean",
"description": "Whether a Skipped flow counts as finished under Mode = Completed. Default true: if the publisher allowed skipping, the skipper must get the same game as the completer."
}
},
"description": "\"The player finished the tutorial\" condition — embedded in SegmentGate.Tutorial exactly as ExperimentVariantCondition is embedded in SegmentGate.Experiment. Thanks to that, tutorial gating works for free in EVERY module already using SegmentGate (Store / DealOffer / Quest / Reward / Leaderboard / ...). This is the per-entity gating level; to close a whole module use TutorialBlockingPolicy, which is cheaper."
},
"CommunityCampaignBrief": {
"type": "object",
"properties": {
"Assets": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/CommunityBriefLink"
},
"description": "Assets for creators (trailer, logos, press kit) - as links, no uploads."
},
"Format": {
"type": [
"null",
"string"
],
"description": "Format and delivery (short video, review, guide, length, orientation...)."
},
"Summary": {
"type": [
"null",
"string"
],
"description": "What to film - the main message of the brief."
},
"Examples": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/CommunityBriefLink"
},
"description": "Examples of good works - as links."
},
"Forbidden": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/CommunityBriefItem"
},
"description": "What is forbidden in the work. Each item has a stable ItemID."
},
"MustInclude": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/CommunityBriefItem"
},
"description": "What must be in the work. Each item has a stable ItemID."
}
},
"description": "The campaign brief. Items carry a stable ItemID that a moderator's rejection references; the work stores a snapshot of the failed items, so editing the brief later never rewrites an earlier decision."
},
"CommunityCrossPostMode": {
"enum": [
"PayEach",
"Grouped",
"OriginalOnly"
],
"type": "string",
"description": "",
"x-enumNames": [
"PayEach",
"Grouped",
"OriginalOnly"
],
"x-enum-descriptions": [
"Every platform is its own submission and is paid separately.",
"The original and its copies are ONE work: each is paid at its own platform's rates, and the per-submission cap applies to their total.",
"Only the original is paid; copies are accepted and shown with their metrics but earn nothing."
]
},
"CommunityRecheckPolicy": {
"enum": [
"JoinOnly",
"OnSubmission"
],
"type": "string",
"description": "",
"x-enumNames": [
"JoinOnly",
"OnSubmission"
],
"x-enum-descriptions": [
"Once, at join time - like manual approval, the decision is made once.",
"At join and before every submission. Requires a fresh verdict; submission itself never evaluates the conditions."
]
},
"CommunityTeamSplitMode": {
"enum": [
"ByContribution",
"Equal",
"CaptainTakesAll"
],
"type": "string",
"description": "",
"x-enumNames": [
"ByContribution",
"Equal",
"CaptainTakesAll"
],
"x-enum-descriptions": [
"In proportion to each member's contribution to the metric that earned the reward.",
"Equally between all members who had at least one approved submission in the campaign.",
"Entirely to the captain, who distributes it outside the platform."
]
},
"SeasonTierRewardBundle": {
"type": "object",
"properties": {
"Rewards": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/ResourceGrant"
}
],
"description": "Rewards for this tier. Passed unmodified into ResourceService via a regular ResourceOperation.Grant."
},
"MinSeasonTier": {
"type": "integer",
"format": "int32",
"description": "Minimum player season tier required for this bundle to apply. Matches SeasonTierDefinition.Tier / UserSeasonState.CurrentTier."
},
"SeasonChainID": {
"type": [
"null",
"string"
],
"description": "SeasonChainID this tier is linked to. Selection matches only tiers with the same SeasonChainID."
}
},
"description": "Structurally different rewards for a season-chain tier. Analogous to PremiumTierBundle but the trigger is the player's season tier. Selection picks the single best match (MinSeasonTier <= playerTier); not stacked."
},
"CommunityMilestoneScope": {
"enum": [
"Submission",
"Creator",
"Team"
],
"type": "string",
"description": "",
"x-enumNames": [
"Submission",
"Creator",
"Team"
],
"x-enum-descriptions": [
"One submission: \"this clip passed 100K views\".",
"All of the creator's submissions in this campaign combined.",
"All of the team's submissions in this campaign combined. Ignored when teams are disabled."
]
},
"CommunityModerationMode": {
"enum": [
"Auto",
"PreApproval",
"PostAudit",
"Threshold"
],
"type": "string",
"description": "",
"x-enumNames": [
"Auto",
"PreApproval",
"PostAudit",
"Threshold"
],
"x-enum-descriptions": [
"Every submission is accepted automatically. Nothing is reviewed.",
"Nothing accrues until a human approves the submission.",
"Submissions accrue immediately; a human may audit and reject afterwards, which stops further accrual.",
"Submissions accrue on their own until the metric named by ThresholdMetric crosses AutoApproveBelowMetric, then they go to human review."
]
},
"WalletGateBalanceSource": {
"enum": [
"OnChain",
"Combined",
"InGame"
],
"type": "string",
"description": "",
"x-enumNames": [
"OnChain",
"Combined",
"InGame"
]
},
"CommunityItemRequirement": {
"type": "object",
"properties": {
"Count": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "How many. Not set = 1."
},
"ItemID": {
"type": [
"null",
"string"
],
"description": "Item ID the player must own."
},
"MinLevel": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Minimum item level. Not set = any level. Only instances at or above this level count."
}
},
"description": "One item ownership requirement."
},
"CommunityRequirementLoss": {
"enum": [
"Keep",
"BlockSubmissions",
"Suspend"
],
"type": "string",
"description": "",
"x-enumNames": [
"Keep",
"BlockSubmissions",
"Suspend"
],
"x-enum-descriptions": [
"Nothing - approval was a decision made at join time.",
"Cannot submit NEW work; existing submissions and rewards are untouched.",
"Status becomes Suspended until a human reviews it."
]
},
"CommunityCampaignIdentity": {
"type": "object",
"properties": {
"IconPath": {
"type": [
"null",
"string"
],
"description": "Path to the campaign cover image."
},
"SortOrder": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "Sort order in the campaign list. Not set = 0."
},
"DescriptionKey": {
"type": [
"null",
"string"
],
"description": "Localization key for the description shown to creators - what to film and what gets paid."
},
"DisplayNameKey": {
"type": [
"null",
"string"
],
"description": "Localization key for the campaign name. A literal is fine too - t() falls back to the key itself."
}
},
"description": "How the campaign is presented in the creator portal."
},
"CommunityJoinRequirements": {
"type": "object",
"properties": {
"Gate": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/SegmentGate"
}
],
"description": "Player-profile condition - the shared SegmentGate (level, country, premium, tutorial, platform, experiment variant)."
},
"Items": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/CommunityItemRequirement"
},
"description": "Items the player must own."
},
"Match": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityRequirementMatch"
}
],
"description": "How to combine conditions: All (default) or Any. The Gate counts as ONE condition (internally it is always AND)."
},
"OnLoss": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityRequirementLoss"
}
],
"description": "What happens to an ALREADY APPROVED creator who stops qualifying. Not set = BlockSubmissions. Never affects already-granted rewards."
},
"Recheck": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityRecheckPolicy"
}
],
"description": "When requirements are re-evaluated. Not set = JoinOnly."
},
"OnFailure": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityRequirementFailure"
}
],
"description": "What happens to an applicant that fails at join time. Not set = Review."
},
"DenyMessageKey": {
"type": [
"null",
"string"
],
"description": "Localization key for the denial message. Not set = default text."
},
"WalletBalances": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/WalletPlayTokenGate"
},
"description": "Wallet balance requirements - the same WalletPlayTokenGate used by wallet login, including BalanceSource OnChain|Combined."
},
"MinCryptoBalances": {
"type": [
"null",
"object"
],
"description": "Minimum IN-GAME crypto balances: currencyID -> amount. NOT the wallet balance - see WalletBalances.",
"additionalProperties": {
"type": "number",
"format": "decimal"
}
},
"AllowWalletConnect": {
"type": [
"boolean",
"null"
],
"description": "May the creator connect a wallet from the portal? Not set = no. Either way only a signature-verified linked wallet counts; connecting simply links one."
},
"MinVirtualCurrencies": {
"type": [
"null",
"object"
],
"description": "Minimum in-game virtual currency balances: currencyID -> amount.",
"additionalProperties": {
"type": "integer",
"format": "int64"
}
},
"RecheckMaxAgeMinutes": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "How fresh the verdict must be when Recheck = OnSubmission, in minutes. Not set = 60. Clamped to at least 1."
}
},
"description": "Conditions under which the system admits a creator without a human. All fields optional; unset means the condition does not exist."
},
"CommunityMetricMilestones": {
"type": "object",
"properties": {
"Milestones": {
"type": [
"null",
"object"
],
"description": "Thresholds for this metric, key = MilestoneID.",
"additionalProperties": {
"$ref": "#/definitions/MilestoneDefinition"
}
}
},
"description": "Threshold rewards for one metric."
},
"CommunityProviderSettings": {
"type": "object",
"properties": {
"Mode": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityProviderMode"
}
],
"description": "How metrics are obtained for this platform. Not set = Off."
},
"SecretName": {
"type": [
"null",
"string"
],
"description": "Name of the TitleSecrets entry holding the platform API key or the aggregator key. Required for Official and Aggregator modes."
},
"AggregatorBaseUrl": {
"type": [
"null",
"string"
],
"description": "Aggregator base URL. Used only in Aggregator mode."
},
"RevisionWindowDays": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "How many recent days to re-pull on every pass. Not set = 3. Platforms revise their numbers retroactively - fraud sweeps land days later."
},
"TrackingWindowDays": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "For how many days after publication a submission keeps being sampled; after that it is considered final. Not set = 90. A two-year-old clip must not be polled forever."
},
"SampleIntervalHours": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "How often to sample metrics, in hours. Not set = 24. Every sample costs platform quota and a live campaign has thousands of submissions."
},
"RefreshTokenSecretName": {
"type": [
"null",
"string"
],
"description": "Name of the TitleSecrets entry holding an OAuth refresh token, when the provider needs one. Not set = not required."
}
},
"description": "Where one platform's numbers come from. The config carries the NAME of a secret, never its value: the value lives in the title's TitleSecrets, exactly as ad-network reporting credentials do."
},
"CommunityRequirementMatch": {
"enum": [
"All",
"Any"
],
"type": "string",
"description": "",
"x-enumNames": [
"All",
"Any"
],
"x-enum-descriptions": [
"Every condition must hold.",
"At least one condition must hold."
]
},
"CommunityShowcaseSettings": {
"type": "object",
"properties": {
"ShowFund": {
"type": [
"boolean",
"null"
],
"description": "Whether the campaigns' fund and the program's crypto pool bucket are shown. Not set = yes."
},
"IsEnabled": {
"type": [
"boolean",
"null"
],
"description": "Whether the program section is shown on the game page at all. Not set = yes (for an enabled program)."
},
"DefaultSort": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityShowcaseSort"
}
],
"description": "Default order of works. Not set = New."
},
"EmbedVideos": {
"type": [
"boolean",
"null"
],
"description": "Whether the platform's player is embedded (loaded on click). Not set = yes."
},
"ShowMetrics": {
"type": [
"boolean",
"null"
],
"description": "Whether works' metrics are shown (views, likes, daily series). Not set = yes."
},
"AllowReports": {
"type": [
"boolean",
"null"
],
"description": "Whether works can be reported; the publisher reviews these reports. Not set = yes."
},
"ShowEarnings": {
"type": [
"boolean",
"null"
],
"description": "Whether amounts per work and per creator are shown (earned, granted, paid). Not set = yes."
},
"AllowComments": {
"type": [
"boolean",
"null"
],
"description": "Whether works can be commented on. Not set = yes."
},
"AllowReactions": {
"type": [
"boolean",
"null"
],
"description": "Whether works can be liked and disliked. Not set = yes."
},
"ShowCalculator": {
"type": [
"boolean",
"null"
],
"description": "Whether the \"how much would I earn\" calculator is shown. Not set = yes."
},
"ShowLeaderboard": {
"type": [
"boolean",
"null"
],
"description": "Whether the leaderboard is shown. Not set = yes."
},
"WorksVisibility": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityShowcaseWorksVisibility"
}
],
"description": "Which works are listed. Not set = ApprovedOnly."
},
"ShowCreatorIdentity": {
"type": [
"boolean",
"null"
],
"description": "Whether the author of a work is shown (profile with a link) or just \"Creator\". Not set = yes."
},
"ShowRejectionReasons": {
"type": [
"boolean",
"null"
],
"description": "Whether rejection reasons and the failed brief items are shown (meaningful with WorksVisibility = All). Not set = no."
}
},
"description": "What part of the program everyone sees on the game's public page. Hiding a work from the showcase is NOT moderating it: status, accrual and payout are unaffected."
},
"CommunityAntiFraudSettings": {
"type": "object",
"properties": {
"HoldDays": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "How many days earnings must age before they can be claimed. Not set = 14. The cheapest and most effective anti-fraud measure: platforms strip purchased views within days, so inflated numbers never reach a payout. Zero is valid and means instant maturity."
},
"ClawbackUnpaid": {
"type": [
"boolean",
"null"
],
"description": "Whether unclaimed earnings shrink when a metric falls. Not set = YES. Already-paid amounts are never taken back: the difference becomes a debt netted against future earnings."
},
"MaxDailyMetricGain": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Maximum plausible daily gain of the primary metric for one submission; above it the submission is frozen and queued for review. Not set or 0 = velocity check disabled."
},
"RatioChecksMinViews": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Minimum view count before the ratio checks apply at all. Not set = 1000. Ratios are pure noise on small numbers: ten views and one like is a ratio of 0.1 and means nothing."
},
"MaxLikesToViewsRatio": {
"type": [
"null",
"number"
],
"format": "decimal",
"description": "Maximum plausible likes-to-views ratio (0..1). Not set = 0.5. A higher ratio means the likes were inflated rather than the views."
},
"MinLikesToViewsRatio": {
"type": [
"null",
"number"
],
"format": "decimal",
"description": "Minimum plausible likes-to-views ratio (0..1). Not set = 0.001. Purchased views come with almost no engagement, which is the most visible fingerprint of a bought campaign."
}
},
"description": "Anti-fraud policy."
},
"CommunityParticipationMode": {
"enum": [
"Open",
"Application",
"Automatic"
],
"type": "string",
"description": "",
"x-enumNames": [
"Open",
"Application",
"Automatic"
],
"x-enum-descriptions": [
"Anyone is in, immediately. Requirements are not evaluated at all.",
"A human approves each applicant.",
"The system approves applicants that satisfy Requirements. Failures go to a human or are rejected, per OnFailure."
]
},
"ExperimentVariantCondition": {
"type": "object",
"properties": {
"Variants": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Allowed variants (any-of). Empty = being assigned to any variant is enough (enrolled). A player with no assignment for this experiment does NOT pass."
},
"ExperimentID": {
"type": [
"null",
"string"
],
"description": "Experiment ID whose assignment is checked."
}
},
"description": "Experiment-variant membership condition — embedded in SegmentGate.Experiment. The gate passes if the player is assigned to one of Variants of experiment ExperimentID (empty list = just enrolled). A/B variants thus reuse the whole SegmentGate stack: make two configs (offer A, offer B), each gated to its variant."
},
"SeasonTierRewardMultiplier": {
"type": "object",
"properties": {
"Multiplier": {
"type": "number",
"format": "double",
"description": "Multiplier. 1.0 = neutral (resolver returns the base reward without copying). Rounding: (long)Math.Round(Amount * Multiplier). Entries with final Amount <= 0 are dropped."
},
"MinSeasonTier": {
"type": "integer",
"format": "int32",
"description": "Minimum player season tier required for this multiplier to apply."
},
"SeasonChainID": {
"type": [
"null",
"string"
],
"description": "SeasonChainID this tier is linked to."
}
},
"description": "Multiplier applied to Amount of the base ResourceGrant for a season-chain tier. Applied to every ResourceEntry.Amount and EventTokenOperation.Amount in Standard and in PremiumTiers.Resources."
},
"CommunityCampaignDefinition": {
"type": "object",
"properties": {
"Caps": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityCaps"
}
],
"description": "Caps per submission, per creator and per team. Caps are evaluated against what has been PAID, not what has been earned - otherwise a clawback would silently re-open a cap the creator had already hit."
},
"Brief": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityCampaignBrief"
}
],
"description": "The brief for creators: what to film, format, what must be on screen, what is forbidden, examples and assets. Unlike Content it is checked by a human, and a moderator's rejection references its items."
},
"Budget": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityBudget"
}
],
"description": "The campaign's budget and what happens when it runs out."
},
"Content": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityContentRequirements"
}
],
"description": "Requirements the post itself must satisfy (hashtags, mention, minimum duration, verification code)."
},
"Presets": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityCampaignPresetBindings"
}
],
"description": "Preset bindings for this campaign's blocks."
},
"Identity": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityCampaignIdentity"
}
],
"description": "Presentation: how the campaign appears in the creator portal (localization keys, icon, sort order)."
},
"Schedule": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/ScheduleSpec"
}
],
"description": "When the campaign accepts submissions. Shared platform schedule primitive. Not set = always active."
},
"Platforms": {
"type": [
"null",
"object"
],
"description": "Which platforms count and at what weight, key = CommunitySocialPlatform name. A YouTube view and a TikTok view are not worth the same, and the weight is how the publisher says so. Not set = every platform with a configured provider counts at weight 1.",
"additionalProperties": {
"$ref": "#/definitions/CommunityPlatformRule"
}
},
"RateCards": {
"type": [
"null",
"object"
],
"description": "Per-metric rate cards, key = CommunityMetricKind name (e.g. \"Views\", \"Likes\"). Not set = no linear payout, milestones only.",
"additionalProperties": {
"$ref": "#/definitions/CommunityRateCard"
}
},
"CampaignID": {
"type": [
"null",
"string"
],
"description": "Unique campaign ID within the title. May be left empty in config - the resolver substitutes the dictionary key."
},
"Milestones": {
"type": [
"null",
"object"
],
"description": "Threshold rewards grouped BY METRIC: outer key = CommunityMetricKind name (\"Views\", \"Likes\"…), inner key = MilestoneID, value = the shared platform milestone primitive. A campaign can reward \"50000 views\" and \"10000 likes\" at the same time; the scope (per submission or per creator) is set by MilestoneScope.",
"additionalProperties": {
"$ref": "#/definitions/CommunityMetricMilestones"
}
},
"Availability": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityCampaignAvailability"
}
],
"description": "Who the campaign is available to."
},
"MilestoneScope": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityMilestoneScope"
}
],
"description": "Whether milestone progress accumulates per submission or across all of the creator's submissions in this campaign. Not set = Submission."
}
},
"description": "A single campaign: the rule set that turns a creator's post into a reward. Root carries only the ID; everything else is split into named blocks, each of which is one editor tab and one preset-able unit."
},
"CommunityModerationSettings": {
"type": "object",
"properties": {
"Mode": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityModerationMode"
}
],
"description": "How submissions are moderated. Not set = PreApproval (nothing accrues until a human approves)."
},
"ReviewSlaHours": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "Target review time in hours, used to highlight overdue items in the moderation queue. Not set = 72. Affects presentation only."
},
"ThresholdMetric": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityMetricKind"
}
],
"description": "Which metric the Threshold mode measures. Not set = Views."
},
"AccrueBeforeApproval": {
"type": [
"boolean",
"null"
],
"description": "Whether metrics collected BEFORE approval count. Not set = YES: time passes between posting and review, and the creator should not lose those views because a moderator was asleep."
},
"AutoApproveBelowMetric": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Metric threshold for Threshold mode: a submission accrues on its own until it crosses this value, then goes to human review. Not set = 10000. The point is to avoid making a human watch a thousand clips with a hundred views each, while never paying out real money unattended."
},
"RequireRejectionReason": {
"type": [
"boolean",
"null"
],
"description": "Whether a moderator comment is mandatory when rejecting. Not set = YES: a rejection with no reason is one the creator can neither fix nor dispute."
}
},
"description": "Submission moderation policy."
},
"CommunityPayoutCurrencyKind": {
"enum": [
"VirtualCurrency",
"CryptoCurrency"
],
"type": "string",
"description": "",
"x-enumNames": [
"VirtualCurrency",
"CryptoCurrency"
],
"x-enum-descriptions": [
"Off-chain virtual currency from cfg.Currency.VirtualCurrencies.",
"On-chain cryptocurrency from cfg.Currency.CryptoCurrencies. Claiming additionally moves value from the title's Community Marketing pool bucket into the players' bucket."
]
},
"CommunityRequirementFailure": {
"enum": [
"Review",
"Reject"
],
"type": "string",
"description": "",
"x-enumNames": [
"Review",
"Reject"
],
"x-enum-descriptions": [
"Leave the application for a human to review.",
"Reject outright, telling the applicant which condition failed."
]
},
"CommunityContentRequirements": {
"type": "object",
"properties": {
"RequiredMention": {
"type": [
"null",
"string"
],
"description": "A mention of the game's account that must appear in the description."
},
"RequiredHashtags": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Hashtags that must appear in the post description. Case-insensitive, the leading # is optional. Not set = no requirement."
},
"MinDurationSeconds": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "Minimum clip duration in seconds. Not set or 0 = no limit. Only enforced when the provider reports duration."
},
"RequireVerificationCode": {
"type": [
"boolean",
"null"
],
"description": "Whether the creator's personal verification code must appear in the post description or the account bio. Not set = YES. This is the only automatic proof of authorship: without it anyone can submit somebody else's popular clip."
}
},
"description": "Requirements the published post must satisfy."
},
"CommunityCampaignAvailability": {
"type": "object",
"properties": {
"Gate": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/SegmentGate"
}
],
"description": "Audience condition - the shared platform SegmentGate. Every field the gate reads must be present in the projection passed to the evaluator; an unprojected field silently never passes."
}
},
"description": "Who the campaign is available to."
},
"CommunityParticipationSettings": {
"type": "object",
"properties": {
"Mode": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityParticipationMode"
}
],
"description": "Open enrolment or by application. Not set = Application (the safer default: the publisher sees who is about to represent their game)."
},
"TermsKey": {
"type": [
"null",
"string"
],
"description": "Localization key of the program terms the creator accepts on enrolment. Not set = no terms step."
},
"MinFollowers": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Minimum follower count for a social account to be linkable. Not set or 0 = no requirement. Only enforced when the provider reports the number."
},
"Requirements": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/CommunityJoinRequirements"
}
],
"description": "Automatic-approval requirements. Only evaluated when Mode is Automatic."
},
"MaxLinkedAccounts": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "Maximum number of social accounts one creator may link. Not set = 5. A cap is required: the list is client-supplied and would otherwise grow without bound."
}
},
"description": "Who may join the program and how."
},
"CommunityCampaignPresetBindings": {
"type": "object",
"properties": {
"Caps": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/PresetBinding"
}
],
"description": "Preset for the Caps block."
},
"Brief": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/PresetBinding"
}
],
"description": "Preset for the Brief block."
},
"Content": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/PresetBinding"
}
],
"description": "Preset for the Content requirements block."
},
"Platforms": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/PresetBinding"
}
],
"description": "Preset for the Platforms dictionary."
},
"RateCards": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/PresetBinding"
}
],
"description": "Preset for the RateCards dictionary."
},
"Milestones": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/PresetBinding"
}
],
"description": "Preset for the Milestones dictionary."
},
"Availability": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/PresetBinding"
}
],
"description": "Preset for the Availability block."
}
},
"description": "Preset bindings for a campaign's blocks."
},
"CommunityBudgetExhaustedBehavior": {
"enum": [
"StopAccruing",
"CloseCampaign"
],
"type": "string",
"description": "",
"x-enumNames": [
"StopAccruing",
"CloseCampaign"
],
"x-enum-descriptions": [
"Stop accruing. Submissions stay visible and keep collecting metrics, but earn nothing further.",
"Close the campaign entirely: no new submissions are accepted either."
]
},
"CommunityMarketingPresetRegistry": {
"type": "object",
"properties": {
"Caps": {
"type": [
"null",
"object"
],
"description": "Caps presets, key = preset ID.",
"additionalProperties": {
"$ref": "#/definitions/CommunityCaps"
}
},
"Brief": {
"type": [
"null",
"object"
],
"description": "Brief presets, key = preset ID.",
"additionalProperties": {
"$ref": "#/definitions/CommunityCampaignBrief"
}
},
"Content": {
"type": [
"null",
"object"
],
"description": "Content-requirement presets, key = preset ID.",
"additionalProperties": {
"$ref": "#/definitions/CommunityContentRequirements"
}
},
"Platforms": {
"type": [
"null",
"object"
],
"description": "Platform-weight presets, key = preset ID, value = a Platforms dictionary keyed by platform name.",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/CommunityPlatformRule"
}
}
},
"RateCards": {
"type": [
"null",
"object"
],
"description": "Rate-card presets, key = preset ID, value = a RateCards dictionary keyed by metric name.",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/CommunityRateCard"
}
}
},
"Milestones": {
"type": [
"null",
"object"
],
"description": "Milestone presets, key = preset ID, value = milestone groups keyed by CommunityMetricKind name.",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/CommunityMetricMilestones"
}
}
},
"Availability": {
"type": [
"null",
"object"
],
"description": "Availability presets, key = preset ID.",
"additionalProperties": {
"$ref": "#/definitions/CommunityCampaignAvailability"
}
}
},
"description": "Preset registry for the Community Marketing program. Keys are preset IDs referenced from a campaign's Presets bindings."
},
"CommunityShowcaseWorksVisibility": {
"enum": [
"Hidden",
"ApprovedOnly",
"ApprovedAndPending",
"All"
],
"type": "string",
"description": "",
"x-enumNames": [
"Hidden",
"ApprovedOnly",
"ApprovedAndPending",
"All"
],
"x-enum-descriptions": [
"No works are listed; rules, fund and totals are still shown.",
"Only approved works.",
"Approved works and works awaiting review.",
"Every work, including rejected ones (with reasons if ShowRejectionReasons is on)."
]
}
},
"additionalProperties": false
}