ads.create
Parameters
| struct |
user { |
|
| string |
session |
Session (as retrieved from client.loginByToken())
|
| int |
userId |
(optional) User ID
|
|
} |
|
|
| array |
ads ( |
|
| struct |
{ |
|
| int |
requestId |
(optional) Chosen id to identify item in response and diagnostics
|
| int |
groupId |
ID of the group where the ad will be placed
|
| string |
adType |
(optional) Type of created ad: [default: eta]
-
eta:
Extended ad
-
combined:
Combined ad
-
branding:
Branding ad
-
dynamicBanner:
Dynamic banner
|
| string |
name |
Ad name (only for adType in ["branding"])
|
| string |
headline1 |
Headline 1 (only for adType="eta")
|
| string |
headline2 |
Headline 2 (only for adType="eta")
|
| string |
headline3 |
(optional) Headline 3 (only for adType="eta")
|
| string |
path1 |
(optional) Part path 1 (only for adType="eta")
|
| string |
path2 |
(optional) Part path 2 (only for adType="eta";path1)
|
| string |
longLine |
Longer line of ad (only for adType="combined")
|
| string |
shortLine |
Shorter line of ad (only for adType="combined")
|
| string |
companyName |
Company or brand name (only for adType="combined")
|
| string |
colorAccent |
(optional) (can be null) Accent color in HEX format without leading # character (only for adType="combined")
|
| string |
colorMain |
(optional) (can be null) Main color in HEX format without leading # character (only for adType="combined")
|
| int |
imageId |
Id of image (excludes: image) (only for adType in ["combined", "branding"])
|
| int |
imageLogoId |
(optional) Id of logo (excludes: imageLogo) (only for adType="combined")
|
| int |
imageSquareId |
Id of square image (excludes: imageSquare) (only for adType="combined")
|
| int |
imageLandscapeLogoId |
(optional) Id of landscape logo (excludes: imageLandscapeLogo) (only for adType="combined")
|
| binary |
image |
Image data (jpg, png, gif) (excludes: imageId) (only for adType in ["combined", "branding"])
|
| binary |
imageLogo |
(optional) Image logo data (jpg, png, gif) (excludes: imageLogoId) (only for adType="combined")
|
| binary |
imageSquare |
Image square data (jpg, png, gif) (excludes: imageSquareId) (only for adType="combined")
|
| binary |
imageLandscapeLogo |
(optional) Image landscape data (jpg, png, gif) (excludes: imageLandscapeLogoId) (only for adType="combined")
|
| string |
description |
Description (only for adType in ["eta", "combined"])
|
| string |
description2 |
(optional) Description 2 (only for adType="eta")
|
| string |
finalUrl |
Final URL (only for adType in ["eta", "combined", "branding"])
|
| string |
trackingTemplate |
(optional) Tracking template (only for adType in ["eta", "combined", "branding"])
|
| string |
mobileFinalUrl |
(optional) Mobile final URL (only for adType in ["eta", "combined"])
|
| string |
impressionTrackingTemplate |
(optional) Template for impressions measuring codes (only for adType in ["combined", "branding"])
|
| string |
impressionTrackingTemplate2 |
(optional) Template 2 for impressions measuring codes (only for adType in ["combined", "branding"])
|
| string |
status |
(optional) ad status: [default: active]
-
active:
active
-
suspend:
suspended
|
| string |
premiseMode |
(optional) Premise display mode (for connection with catalog Firmy.cz) (only for adType in ["eta", "banner"]):
-
disabled:
Assigned premise is not shown
-
one:
Premise specified in premiseId is shown
-
nearest:
Client nearest premise is shown
-
inherit:
Premise is inherited from campaign
|
| int |
premiseId |
(can be null) Premise id (or nil; for connection with catalog Firmy.cz) (only for premiseMode='one';adType in ["eta", "banner"])
|
| int |
dynamicTemplateId |
(optional) Id of dynamic template (only for adType="dynamicBanner")
|
| array |
schedule ( |
(optional) (can be null) Delivery schedule of ad. Array of 7 days, week starts at monday.
|
) |
|
|
|
} |
|
|
|
) |
|
|
Response
| struct |
{ |
|
| string |
statusMessage |
Status code description
|
| string |
session |
Refreshed session
|
| array |
adIds ( |
Array of created ads(their ids)
|
|
int
|
|
|
(optional) ID of the created ad
|
|
) |
|
|
| array |
diagnostics ( |
(optional) Various diagnostics(warnings, errors, other information)
|
|
|
) |
|
|
|
} |
|
|
Response status codes:
List of all possible response status codes:
200: OK206: Partially OK301: User is serviced400: Bad arguments401: Invalid session403: Access Denied404: Not found406: Bad values of attributes413: Too many items requested.429: Too many requests. Has to wait.500: Server Error.409: Conflict
Diagnostics:
List of all possible diagnostics:
ad_attribute_no_changead_duplicate_in_dbad_duplicate_in_requestbad_lengthbad_urlbad_url_textclickthruText_is_too_longclickthruUrl_is_too_longcompanyName_is_too_longconsecutive_same_wordsconsecutive_two_and_more_punctuation_charsconsecutive_two_and_more_uppercasecreative1_is_too_longcreative2_is_too_longcreative3_is_too_longdescription2_is_too_longdescription_is_too_longexclamation_mark_in_titleexclusive_struct_fieldfailed_checksum_calculationfinalUrl_is_too_longgroup_access_deniedheadline1_is_too_longheadline2_is_too_longheadline3_is_too_longhyphen_at_the_endimage_access_deniedimage_height_too_lowimage_no_accessimage_no_rule_set_passedimage_ratio_incorrectimage_size_too_largeimage_width_too_lowimpressionTrackingTemplate2_is_too_longimpressionTrackingTemplate_is_too_longinvalid_charsinvalid_schedule_day_sizeinvalid_schedule_sizeleft_parenthesis_at_the_endlongLine_is_too_longmissing_required_attributemissing_space_after_colonmissing_space_after_commamissing_space_after_dotmissing_space_after_exclamation_markmissing_space_after_hyphenmissing_space_after_question_markmissing_space_after_right_parenthesismissing_space_after_semicolonmissing_space_before_hyphenmissing_space_before_left_parenthesismissing_textmobileFinalUrl_is_too_longmore_then_one_exclamation_mark_in_textnine_and_more_uppercasenot_allowed_for_campaign_typepath1_is_too_longpath2_is_too_longpath2_set_path1_unsetpath_contains_unsupported_characterspunctuation_char_at_the_beginschedule_value_too_largeschedule_value_too_lowshortLine_is_too_longspace_after_left_parenthesisspace_before_colonspace_before_commaspace_before_dotspace_before_exclamation_markspace_before_question_markspace_before_right_parenthesisspace_before_semicolontrackingTemplate_is_too_longuser_access_deniedwords_more_than_three_times_in_all_textwrong_attribute
