Sklik API

Ads

ads.update

This method sets ads attributes (status or connection to Firmy.cz catalog).

Ad title, content and URLs (creative1, creative2, creative3, clickthruText) cannot be changed. Old ad will be deleted and new one will be created and newIds will be provided in response.

Parameters

struct user {
string session Session (as retrieved from client.login())
int userId (optional) User ID
}
array ads (
struct {
int id Ad ID
int requestId (optional) Chosen id to identify item in response and diagnostics
string adType (optional) Type of created ad: [default: text]
  • text: Text ad
  • eta: Extended ad
  • combined: Combined ad
  • branding: Branding ad
string name (optional) Ad Name (only for adType in ["branding"])
string creative1 (optional) First line of ad (title) (only for adType="text")
string creative2 (optional) Second line of ad (only for adType="text")
string creative3 (optional) Third line of ad (only for adType="text")
string clickthruText (optional) URL that is displayed (only for adType="text")
string clickthruUrl (optional) URL to which is the user redirected
string headline1 (optional) Headline 1 (only for adType="eta")
string headline2 (optional) 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")
string longLine (optional) Longer line of ad (only for adType="combined")
string shortLine (optional) Shorter line of ad (only for adType="combined")
string companyName (optional) Company or brand name (only for adType="combined")
int imageId (optional) Id of image (excludes: image) (only for adType in ["combined", "branding"])
int imageLogoId (optional) (can be null) Id of logo (excludes: imageLogo) (only for adType="combined")
int imageSquareId (optional) Id of square image (excludes: imageSquare) (only for adType="combined")
int imageLandscapeLogoId (optional) (can be null) Id obdelnikoveho loga (excludes: imageLandscapeLogo) (only for adType="combined")
binary image (optional) Image data (jpg, png, gif) (excludes: imageId) (only for adType in ["combined", "branding"])
binary imageLogo (optional) Image data (jpg, png, gif) (excludes: imageLogoId) (only for adType="combined")
binary imageSquare (optional) Image data (jpg, png, gif) (excludes: imageSquareId) (only for adType="combined")
binary imageLandscapeLogo (optional) Image data (jpg, png, gif) (excludes: imageLandscapeLogoId) (only for adType="combined")
string description (optional) Description (only for adType in ["eta", "combined"])
string description2 (optional) Description 2 (only for adType="eta")
string finalUrl (optional) Final URL (only for adType in ["eta", "combined", "branding"])
string trackingTemplate (optional) (can be null) Tracking template (only for adType in ["eta", "combined", "branding"])
string mobileFinalUrl (optional) (can be null) Mobile final URL (only for adType in ["eta", "combined"])
string impressionTrackingTemplate (optional) (can be null) Template for impressions measuring codes (only for adType in ["combined"
string status (optional) Change ad status:
  • active: Ad is active
  • suspend: Ad is suspended
string premiseMode (optional) Premise display mode (for connection with catalog Firmy.cz):
  • 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) (only for premiseMode='one') Premise id (or nil; for connection with catalog Firmy.cz)
}
)

Response

struct {
int status Status code
string statusMessage Status code description
string session Refreshed session
array newAdIds ( (optional) Array of new created ads.
int ID of new created ad
)
array diagnostics ( (optional) Array of various diagnostics(warnings, errors, other information)
struct {
...
}
)
}

Response status codes:

List of all possible response status codes:

Diagnostics:

List of all possible diagnostics:

            
        

Copyright © 1996-2019

www.seznam.cz   Help   Contact