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

75 lines
1.7 KiB
YAML

type: object
properties:
alias:
description: Campaign Alias which is Used in URL http://domain.com/ALIAS
type: string
type:
description: Flow Rotation Type
type: string
default: position
enum:
- position
- weight
name:
description: Campaign Name
type: string
cookies_ttl:
description: When the Click Gets Unique Status Again, in Hours
type: integer
default: 24
state:
type: string
enum:
- active
- disabled
- deleted
description: Campaign State
default: active
cost_type:
description: Cost Type
type: string
default: CPC
enum:
- CPC
- CPUC
- CPM
cost_value:
description: Cost Value
type: number
cost_currency:
description: >-
Currency Value EUR/USD/RUB/UAH/GBP. Default Value is Taken from the
Tracker's Settings.
type: string
cost_auto:
description: Enable Automatic Costs (0/1)
type: boolean
default: false
group_id:
description: Campaign Group ID
type: string
bind_visitors:
description: >-
Bind Visitors Feature (null - disabled/ s - only to streams/ sl - to
streams and LPs/ slo — to streams, LPs and offers)
type: string
traffic_source_id:
description: Traffic source ID
type: integer
parameters:
$ref: ../schemas/SourceParameters.yaml
token:
description: Token to gain access to Click API
type: string
domain_id:
description: Domain ID
type: integer
postbacks:
description: Campaign S2S postback
type: array
items:
$ref: ../schemas/S2SPostback.yaml
notes:
description: Notes for the campaign
type: string