Create Campaign creative

Copied

                https://api.ocamba.com/v2/adex/campaigns/{campaign_id}/creatives

Creates a new Campaign creative object

path Parameters

Name

Description

campaign_idstringrequired

Unique campaign identifier.

Example: campaign_id=1000001

Request Body Schema

Name

Description

actions[ creative-action ]

An array of max 3 items, every item in the array must be an action object. This field is only available for web-push-object and web-push-external-demand types of creative.

Action

Name

Description

iconstring

Valid URL, max 500 chars, must start with https://

Example: https://someurl.com/favicon.ico

titleobject

Key-value pairs {key : value}. Maximum 20 key-value pairs.

Name

Description

keystring

Language code supported by the Ocamba platform (ISO 639-2, 2 letter language codes), key "en" is required.

Example: en

valuestring

Max 600 characters.

Example: en_demo_title

urlstring

Valid URL, max 500 chars, must start with http:// or https://

addressstring

Address. Maximum length of 100 characters. This field is only available for dynamic-native and dynamic-native-external-demand types of creative.

Example: Dragise Misovica 163B

advertiser_domainstring (url)

Valid URL. Maximum length of 400 characters. This field is only available for dynamic-native and dynamic-native-external-demand types of creative.

Example: https://example.com

badgestring

Monochromatic mini-icon which portrays to user source where he subscribed in the first place (https:// allowed). Valid URL, max 500 chars. This field is only available for web-push-object and web-push-external-demand types of creative.

Example: https://example.com

bannerobject

Key-value pairs {key:value}. Maximum 20 key-value pairs.

Name

Description

keystring

Key has to be a valid two letter country code supported by Ocamba.

Example: en

valuestring

Creative banner image url, must be a valid image url. Max length of 400 characters.

Example: https://somebannerurl.com/banner.jpg

banner_sizeobject

Key-value pairs {key:value}. Maximum 20 key-value pairs. Generated automatically by the Ocamba platform. Can not be directly changed by the user. This field is only available for dynamic-native and dynamic-native-external-demand types of creative.

Name

Description

keystring

Key has to be a valid two letter country code supported by Ocamba.

Example: en

valuestring

Describes the size of the image on the same key in the banner object.

Example: 1280x1024

bodyobject

Key-value pairs {key:value}. Maximum 20 key-value pairs. This field is only available for web-push-object and web-push-external-demand types of creative.

Name

Description

keystring

Key has to be a valid two letter country code supported by Ocamba.

Example: en

valuestring

Creative body. Maximum length of 600 characters.

Example: Body example

bundle_idstring

Maximum 100 characters. This field is only available for dynamic-native and dynamic-native-external-demand types of creative.

Example: 1017

campaign_idstring

A unique campaign identifier generated by the Ocamba platform.

Example: 1213323

company_idstring

A unique company identifier generated by the Ocamba platform.

Example: 1313232

ctatextstring

Descriptive text describing a ‘call to action’ button for the destination URL. Maximum length of 10000 characters. This field is only available for dynamic-native and dynamic-native-external-demand types of creative.

Example: 1

descriptionobject

Key-value pairs {key:value}. Maximum 20 key-value pairs.

Name

Description

keystring

Key has to be a valid two letter country code supported by Ocamba. This field is only available for dynamic-native and dynamic-native-external-demand types of creative.

Example: en

valuestring

Creative description. Maximum length of 400 characters.

Example: Simple description

description_2object

Key-value pairs {key:value}. Maximum 20 key-value pairs. This field is only available for dynamic-native and dynamic-native-external-demand types of creative.

Name

Description

keystring

Key has to be a valid two letter country code supported by Ocamba.

Example: en

valuestring

Second creative description. Maximum length of 400 characters.

Example: Simple description 2

display_urlstring (url)

Valid URL. Maximum length of 200 characters. This field is only available for dynamic-native and dynamic-native-external-demand types of creative.

Example: https://example.com

distribution_ratenumber (int)

Describes distribution rate of a creative on a campaign. This value is not settable or updatable except through a dedicated endpoint.

Example: 44

downloadsinteger

Number downloads/installs of this number product. This field is only available for dynamic-native and dynamic-native-external-demand types of creative.

Example: 5

html5string

HTML5 desc. Maximum length of 10000 characters. This field is only available for dynamic-native and dynamic-native-external-demand types of creative.

Example:

Test

iconstring (url)

Icon address that will be a secondary visual attribute presented to the user (https:// allowed). Valid URL, max 500 chars. This field is only available for web-push-object and web-push-external-demand types of creative.

Example: https://example_icon.com

idstring

A unique identifier generated by the Ocamba platform.

Example: 1319617

imageobject

Key-value pairs {key:value}. Maximum 20 key-value pairs.

Name

Description

keystring

Key has to be a valid two letter country code supported by Ocamba.

Example: en

valuestring

Creative image url, must be a valid image url. Max length of 400 characters.

Example: https://someimageurl.com/image.jpg

image_sizeobject

Name

Description

keystring

Key has to be a valid two letter country code supported by Ocamba.

Example: en

valuestring

Describes the size of the image on the same key in the image object.

Example: 600x800

landing_urlstring

Landing url of a creative.

Example: google.com

likesinteger

Number of social ratings or “likes” of the product being offered to the user. This field is only available for dynamic-native and dynamic-native-external-demand types of creative.

Example: 10

namestring

Creative Name is a user-provided keyword that will be your main keyword in search and tracking. Maximum 100 chars.

Example: Demo_creative

overrideoverride

Override object. Describes which fields to override from external demand. Only available for dynamic-native-external-demand and web-push-external-demand types of creatives.

Override

Name

Description

addressinteger

Describes the override status of address. Only available for dynamic-native-external-demand type of creatives.

Example: 1

Possible values: 0 | 1

advertiser_domaininteger

Describes the override status of advertiser_domain. Only available for dynamic-native-external-demand type of creatives.

Example: 1

Possible values: 0 | 1

bannerinteger

Describes the override status of banner. Only available for dynamic-native-external-demand type of creatives.

Example: 1

Possible values: 0 | 1

bodyinteger

Describes the override status of body. Only available for web-push-external-demand type of creatives.

Example: 1

Possible values: 0 | 1

ctatextinteger

Describes the override status of ctatext. Only available for dynamic-native-external-demand type of creatives.

Example: 1

Possible values: 0 | 1

descriptioninteger

Describes the override status of description. Only available for dynamic-native-external-demand type of creatives.

Example: 1

Possible values: 0 | 1

description_2integer

Describes the override status of description_2. Only available for dynamic-native-external-demand type of creatives.

Example: 1

Possible values: 0 | 1

display_urlinteger

Describes the override status of display_url. Only available for dynamic-native-external-demand type of creatives.

Example: 1

Possible values: 0 | 1

downloadsinteger

Describes the override status of downloads. Only available for dynamic-native-external-demand type of creatives.

Example: 1

Possible values: 0 | 1

html5integer

Describes the override status of html5. Only available for dynamic-native-external-demand type of creatives.

Example: 1

Possible values: 0 | 1

iconinteger

Describes the override status of icon. Only available for web-push-external-demand type of creatives.

Example: 1

Possible values: 0 | 1

imageinteger

Describes the override status of image.

Example: 1

Possible values: 0 | 1

likesinteger

Describes the override status of likes. Only available for dynamic-native-external-demand type of creatives.

Example: 1

Possible values: 0 | 1

phoneinteger

Describes the override status of phone. Only available for dynamic-native-external-demand type of creatives.

Example: 1

Possible values: 0 | 1

priceinteger

Describes the override status of price. Only available for dynamic-native-external-demand type of creatives.

Example: 1

Possible values: 0 | 1

ratinginteger

Describes the override status of rating. Only available for dynamic-native-external-demand type of creatives.

Example: 1

Possible values: 0 | 1

sale_priceinteger

Describes the override status of sale_price. Only available for dynamic-native-external-demand type of creatives.

Example: 1

Possible values: 0 | 1

sponsoredinteger

Describes the override status of sponsored. Only available for dynamic-native-external-demand type of creatives.

Example: 1

Possible values: 0 | 1

targetinteger

Describes the override status of target. Only available for dynamic-native-external-demand type of creatives.

Example: 1

Possible values: 0 | 1

third_party_codeinteger

Describes the override status of third_party_code. Only available for dynamic-native-external-demand type of creatives.

Example: 1

Possible values: 0 | 1

titleinteger

Describes the override status of title.

Example: 1

Possible values: 0 | 1

phonestring

Phone number. Maximum length of 50 characters. This field is only available for dynamic-native and dynamic-native-external-demand types of creative.

Example: 032456312

postbackinteger

Describes status of postback.

Example: 1

Possible values: 0 | 1

Default: 1

preferable_refererstring

Valid url. Maximum length of 500. This field is only available for web-push-object and web-push-external-demand types of creative.

Example: https://google.com

pricefloat

Price for product / app / in-app purchase. This field is only available for dynamic-native and dynamic-native-external-demand types of creative.

Example: 12.99

ratinginteger

Rating of the product being offered to the user. This field is only available for dynamic-native and dynamic-native-external-demand types of creative.

renotifyinteger

Replacing old notification with the new one using the silent method. Applicable only with tag option. This field is only available for web-push-object and web-push-external-demand types of creative.

Example: 1

Possible values: 0 | 1

require_interactioninteger

Demand action execution from the user. Applicable only for desktop users. This field is only available for web-push-object and web-push-external-demand types of creative.

Example: 1

Possible values: 0 | 1

sale_pricefloat

Sale price that can be used together with price to indicate a discounted price compared to a regular price. This field is only available for dynamic-native and dynamic-native-external-demand types of creative.

Example: 9.99

silentinteger

Serving notification without sound and vibration. Applicable only to mobile devices. This field is only available for web-push-object and web-push-external-demand types of creative.

Example: 1

Possible values: 0 | 1

sponsoredobject

Key-value pairs {key:value}. Maximum 20 key-value pairs. This field is only available for dynamic-native and dynamic-native-external-demand types of creative.

Name

Description

keystring

Key has to be a valid two letter country code supported by Ocamba.

Example: en

valuestring

Sponsored text. Maximum length of 100 characters.

Example: Sponsored by Ocamba

statusstring

Describe creative status.

Example: active

Possible values: active | inactive | verification | paused | rejected

tagstring

The tag option enables the removal of notifications with the same tag which were delivered earlier. Max 100 chars. This field is only available for web-push-object and web-push-external-demand types of creative.

Example: .

targetstring

Browser related method for ad appearance. This field is only available for dynamic-native and dynamic-native-external-demand types of creative.

Example: _top

Possible values: _blank | _self | _parent | _top

third_party_codestring

Third Party code description. Maximum length of 10000 characters. This field is only available for dynamic-native and dynamic-native-external-demand types of creative.

Example:Test

titleobject

Key-value pairs {key:value}. Maximum 20 key-value pairs.

Name

Description

keystring

Key has to be a valid two letter country code supported by Ocamba. The key en is required.

Example: en

valuestring

Creative title. Max length of 600 characters.

Example: Creative title

tracking_pixels[ string ]

Uses for pixel tracking. This field is only available for dynamic-native and dynamic-native-external-demand types of creative.

Example: https://example.com?${SESSION_ID}${DEVICE_ID}

typestring

Describes type of creative. Creative fields are dependant on type of creative.

Example: dynamic-native

Possible values: dynamic-native | dynamic-native-external-demand | web-push-object | web-push-external-demand

vibrationstring

Two vibration pulses with customizable length and pause between them, described in milliseconds (200,100,200 formats), will start when a notification is displayed. Applicable only for Android users. Max 50 chars, valid vibration pattern. This field is only available for web-push-object and web-push-external-demand types of creative.

Example: 20,600,400

Response status codes

201 - Created

note

1 This resource can only be added to the internal campaign type.

2 Path parameter campaign_id is only useable on campaigns/{cid}/creatives routes. It is represented by {cid}.

Request examples

Copied

dynamic-native

dynamic-native
dynamic-native-external-demand
web-push-object
web-push-external-demand

{
  "campaign_id": 1006454,
  "name": "Demo dynamic native",
  "type": "dynamic-native",
  "status": "inactive",
  "title": {
    "en": "en title",
    "sr": "sr title"
  },
  "image" : {
    "en": "http://example.domen/image/en.jpg",
    "sr": "http://example.domen/image/sr.jpg"
  },
  "landing_url": "http://www.delsystems.net",
  "target": "_blank",
  "advertiser_domain": "www.delsystems.net"
  
}

{
  "campaign_id": 1001114,
  "name": "Demo dynamic native external demand",
  "type": "dynamic-native-external-demand",
  "status": "active",
  "title": {
    "en": "en title",
    "sr": "sr title"
  },
  "image" : {
    "en": "http://example.domen/image/en.jpg",
    "sr": "http://example.domen/image/sr.jpg"
  },
  "landing_url": "http://www.delsystems.net",
  "target": "_blank",
  "advertiser_domain": "www.delsystems.net",
  "override": {
    "title": 0,
    "image": 0,
    "target": 0
  }
}

{
	"campaign_id" : 1010580,
	"name" : "Demo web push object",
	"type" : "web-push-object",
	"status" : "active", 
  "title" : {
    "en" : "Samsung J5"
  },
  "body" : {
    "en" : "Samsung Galaxy J5 smartphone was launched in June 2015."
  },
  "icon" : "https://example_icon.png",
  "image" : {
    "en" : "https://example_image.jpg"
  },
  "landing_url" : "https://www.ocamba.com",
  "actions" : [
    {
      "title" : {
        "en" : "Yes",
        "sr" : "Da"
      },
      "url": "https://www.delsystems.net"
    },
    {
      "title" : {
        "en" : "No",
        "sr" : "Ne"
      }
    }
  ]
}

{
  "campaign_id":1006302,
  "name":"Demo web push exchange",
  "type":"web-push-exchange",
  "status":"active",
  "title":{
      "en":"New Important Message"
  },
  "body":{
      "en":"Click Here"
  },
  "landing_url":"https://www.ocamba.com",
  "language_direction":"ltr",
  "renotify":0,
  "silent":0,
  "require_interaction":0,
  "postback":1,
  "vibration":"0,400,800",
  "override":{
    "body":1,
    "icon":0,
    "image":0,
    "landing_url":1,
    "title":0
  },
  "actions":[
    {
      "title":{
          "en":"Read Message"
      },
      "url":"https://www.delsystems.net"
    }
  ]
}

Response examples

Copied

201

{
  "id": 1000004,
  "campaign_id": 1006454,
  "name": "Demo dynamic native",
  "type": "dynamic-native",
  "status": "inactive",
  "title": {
    "en": "en title",
    "sr": "sr title"
  },
  "image" : {
    "en": "http://example.domen/image/en.jpg",
    "sr": "http://example.domen/image/sr.jpg"
  },
  "image_sizes" : {
    "en" : "500x300",
    "sr" : "640x480"
  },
  "landing_url": "http://www.delsystems.net",
  "target": "_blank",
  "advertiser_domain": "www.delsystems.net"
}

Create Campaign creative

POST /campaigns/{campaign_id}/creativesCopied https://api.ocamba.com/v2/adex/campaigns/{campaign_id}/creatives

POST /campaigns/{campaign_id}/creatives
Copied
`https://api.ocamba.com/v2/adex/campaigns/{campaign_id}/creatives`