keitaro-api-skill/references/schemas/OfferRequest.yaml

78 lines
1.8 KiB
YAML

type: object
properties:
name:
description: Offer name
type: string
group_id:
description: Offer group ID
type: integer
offer_type:
description: Offer Type ('local'/'external'/'preloaded'/'action')
type: string
action_type:
description: Action or redirect type
type: string
action_payload:
description: Action payload or URL
oneOf:
- type: string
- type: object
affiliate_network_id:
description: Affiliate network ID
type: integer
payout_value:
description: Payout value
type: number
payout_currency:
description: Payout currency
type: string
payout_type:
description: Payout type
type: string
enum:
- CPA
- CPC
state:
type: string
enum:
- active
- deleted
description: Offer State
default: active
payout_auto:
description: If true, offer receives payout value from postback
type: boolean
default: false
payout_upsell:
description: Allow offer to get upsells
type: boolean
default: false
country:
description: Country codes (i.g, ["US", "DE", "JP"])
type: array
items:
type: string
notes:
description: Notes
type: string
archive:
description: ZIP-file encoded to base64
type: string
conversion_cap_enabled:
description: Turn on that feature if the offer limit conversions per day
type: boolean
default: false
daily_cap:
description: >-
Daily limit of conversions, after which the tracker will send traffic to
another offer
type: number
conversion_timezone:
description: >-
Which timezone is being used by the Affiliate network for calculating
conversions, e.g. UTC or Europe/Madrid
type: string
alternative_offer_id:
description: Offer id, where to send traffic when daily limit is reached
type: number