Update Ab test variation

PATCH /campaign-ab-tests/{id}/variations/{variation_id}
Copied
Arrow
                https://api.ocamba.com/v2/adex/campaign-ab-tests/{id}/variations/{variation_id}

Updates the specific Ab test variation by setting the values of the parameters passed. Any parameters not provided will be left unchanged

path Parameters
Arrow
Name
Description
idstringrequired
Unique ab test id.


Example: 1411
Request Body Schema
Arrow
Name
Description
namestringrequired
Name of AB test variation.


Example: My Variation
settingsdynamic-native-creative

web-push-object-creative

web-push-external-demand-creative

dynamic-native-external-demand-creativerequired
Values to override in control variation (original creative). Settings type can be one of: Web Push Object Creative, Dynamic Native Creative, Web Push External Demand Creative and Dynamic Native External Demant Creative.
Creative - Dynamic Native
Name
Description
addressstring
Address


Example: Dragise Misovica 163B
advertiser_domainstring (url)
Valid URL.


Example: https://example.com
bannerobject

Name
Description
keystring
Language code supported by the Ocamba platform (ISO 639-2, 2 letter language codes).


Example: en
valuestring
URL, max 400 characters.


Example: http://example.domen/image/en.jpg
bundle_idstring
Maximum 100 characters.


Example: 1017
ctatextstring
Descriptive text describing a ‘call to action’ button for the destination URL.


Example: 1
descriptionobject

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


Example: en
valuestring
URL, max 400 characters.


Example: en description
description_2object

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


Example: en
valuestring
URL, max 400 characters.


Example: en description2
display_urlstring (url)
Valid URL.


Example: https://example.com
downloadsinteger
Number downloads/installs of this number product.


Example: 5
html5string
HTML5 desc.


Example:
Test

imageobject

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


Example: en
valuestring
URL, max 400 characters.


Example: http://example.domen/image/en.jpg
landing_urlstring (url)
Valid URL, max 2048 chars.


Example: https://example.com
likesinteger
Number of social ratings or “likes” of the product being offered to the user.


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_dynamic_native
phonestring
Phone number.


Example: 032456312
postbackinteger
Describes status of postback.


Example: 1

Possible values: 0 | 1

Default: 1
pricefloat
Price for product / app / in-app purchase.


Example: 12.99
ratinginteger
Rating of the product being offered to the user.
sale_pricefloat
Sale price that can be used together with price to indicate a discounted price compared to a regular price.


Example: 9.99
sponsoredobject

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


Example: en
valuestring
URL, max 100 characters.


Example: en sponsor
statusstring
Describe dynamic native status.


Example: active

Possible values: active | inactive

Default: active
targetstring
Browser related method for ad appearance.


Example: _top

Possible values: _blank | _self | _parent | _top
third_party_codestring
3rd Party code desc.


Example:Test
titleobject

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


Example: en
valuestring
URL, max 600 characters.


Example: en_demo_title
tracking_pixels[ string ]
Uses for pixel tracking.


Example: https://example.com?${SESSION_ID}${DEVICE_ID}
typestring
Describes type of the dynamic native.


Example: dynamic-native

Default: dynamic-native
Creative - Web Push Object
Name
Description
actions[ action ]
An array of max 3 items, every item in the array must be an object described in the ACTIONS OBJECT section.
Action
Name
Description
actionstring
DEPRECATED. Lowercase, max 30 chars, submit or cancel for example
iconstring
Valid URL, max 200 chars, must start with https://


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

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


Example: en
valuestring
URL, max 200 characters.


Example: en_demo_title
urlstring
Valid URL, max 500 chars, must start with http:// or https://
badgestring
Monochromatic mini-icon which portrays to user source where he subscribed in the first place (https:// allowed). Valid URL, max 500 chars.


Example: https://example.com
bodyobject

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


Example: en
valuestring
URL, max 200 characters.


Example: Samsung Galaxy J5 smartphone was launched in June 2015
iconstring (url)
Icon address that will be a secondary visual attribute presented to the user (https:// allowed). Valid URL, max 500 chars.


Example: https://example_icon.com
imageobject

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


Example: en
valuestring
URL, max 200 characters.


Example: http://example.domen/image/en.jpg
landing_urlstring (url)
Page address where the user will land after clicking on it (http:// allowed). Valid URL, max 2048 chars.


Example: https://example.com
namestring
Creative Name is a user-provided keyword that will be your main keyword in search and tracking. Maximum 100 chars.


Example: Demo_web_push_object
postbackinteger
Describes status of postback.


Example: 1

Possible values: 0 | 1

Default: 1
renotifyinteger
Replacing old notification with the new one using the silent method. Applicable only with tag option.


Example: 1

Possible values: 0 | 1
require_interactioninteger
Demand action execution from the user. Applicable only for desktop users.


Example: 1

Possible values: 0 | 1
silentinteger
Serving notification without sound and vibration. Applicable only to mobile devices.


Example: 1

Possible values: 0 | 1
statusstring
Describe dynamic native status.


Example: active

Possible values: active | inactive

Default: active
tagstring
The tag option enables the removal of notifications with the same tag which were delivered earlier. Max 100 chars. Required if renotify is set to 1 (true)


Example: .
titleobject

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


Example: en
valuestring
URL, max 200 characters.


Example: en_demo_title
typestring
Describes type of the web push object.


Example: web-push-object

Default: web-push-object
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.


Example: 20,600,400
Creative - Web Push External Demand
Name
Description
actions[ action ]
An array of max 3 items, every item in the array must be an object described in the ACTIONS OBJECT section.
badgestring
Monochromatic mini-icon which portrays to user source where he subscribed in the first place (https:// allowed). Valid URL, max 500 chars.


Example: https://example.com
bodyobject

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


Example: en
valuestring
URL, max 200 characters.


Example: Samsung Galaxy J5 smartphone was launched in June 2015
iconstring (url)
Icon address that will be a secondary visual attribute presented to the user (https:// allowed). Valid URL, max 500 chars.


Example: https://example_icon.com
imageobject

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


Example: en
valuestring
URL, max 200 characters.


Example: http://example.domen/image/en.jpg
landing_urlstring (url)
Page address where the user will land after clicking on it (http:// allowed). Valid URL, max 2048 chars.


Example: https://example.com
namestring
Creative Name is a user-provided keyword that will be your main keyword in search and tracking. Maximum 100 chars.


Example: Demo_web_push_object
overrideoverride-v2
Overide object.
Override
Name
Description
bodyinteger
Describes status of body.


Example: 1

Possible values: 0 | 1
iconinteger
Describes status of icon.


Example: 1

Possible values: 0 | 1
imageinteger
Describes status of image.


Example: 1

Possible values: 0 | 1
landing_urlinteger
Describes status of landing_url.


Example: 1

Possible values: 0 | 1
titleinteger
Describes status of title.


Example: 1

Possible values: 0 | 1
postbackinteger
Describes status of postback.


Example: 1

Possible values: 0 | 1

Default: 1
renotifyinteger
Replacing old notification with the new one using the silent method. Applicable only with tag option.


Example: 1

Possible values: 0 | 1
require_interactioninteger
Demand action execution from the user. Applicable only for desktop users.


Example: 1

Possible values: 0 | 1
silentinteger
Serving notification without sound and vibration. Applicable only to mobile devices.


Example: 1

Possible values: 0 | 1
statusstring
Describe dynamic native status.


Example: active

Possible values: active | inactive

Default: active
tagstring
The tag option enables the removal of notifications with the same tag which were delivered earlier. Max 100 chars. Required if renotify is set to 1 (true)


Example: .
titleobject

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


Example: en
valuestring
URL, max 200 characters.


Example: en_demo_title
typestring
Describes type of the web push object.


Example: web-push-object

Default: web-push-object
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.


Example: 20,600,400
Creative - Dynamic Native External Demand
Name
Description
addressstring
Address


Example: Dragise Misovica 163B
advertiser_domainstring (url)
Valid URL.


Example: https://example.com
bannerobject

Name
Description
keystring
Language code supported by the Ocamba platform (ISO 639-2, 2 letter language codes).


Example: en
valuestring
URL, max 400 characters.


Example: http://example.domen/image/en.jpg
bundle_idstring
Maximum 100 characters.
ctatextstring
descriptive text describing a ‘call to action’ button for the destination URL.


Example: 1
descriptionobject

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


Example: en
valuestring
URL, max 400 characters.


Example: en description
description_2object

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


Example: en
valuestring
URL, max 400 characters.


Example: en description2
display_urlstring (url)
Valid URL.


Example: https://example.com
downloadsinteger
Number downloads/installs of this number product.


Example: 9
html5string
HTML5 desc.


Example: example
imageobject

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


Example: en
valuestring
URL, max 400 characters.


Example: http://example.domen/image/en.jpg
landing_urlstring (url)
Valid URL, max 2048 chars.


Example: https://example.com
likesinteger
Number of social ratings or “likes” of the product being offered to the user.


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


Example: Demo_dynamic_native
overrideoverride-v2
Overide object.
phonestring
Phone number.


Example: 032456312
postbackinteger
Describes status of postback.


Example: 1

Possible values: 0 | 1

Default: 1
pricefloat
Price for product / app / in-app purchase.


Example: 12.99
ratinginteger
Rating of the product being offered to the user.


Example: 1
sale_pricefloat
Sale price that can be used together with price to indicate a discounted price compared to a regular price.


Example: 9.99
sponsoredobject

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


Example: en
valuestring
URL, max 100 characters.


Example: en sponsor
statusstring
Describe dynamic native status.


Example: active

Possible values: active | inactive

Default: active
targetstring
Browser related method for ad appearance.


Example: _top

Possible values: _blank | _self | _parent | _top
third_party_codestring
3rd Party code desc.


Example: example
titleobject

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


Example: en
valuestring
URL, max 600 characters.


Example: en_demo_title
tracking_pixels[ string ]
Uses for pixel tracking.


Example: https://example.com?${SESSION_ID}${DEVICE_ID}
typestring
Describes type of the dynamic native.


Example: dynamic-native

Default: dynamic-native
Response status codes
Arrow
204 - No Content
Arrow

note
1 At least one of the updatable fields should be sent via HTTP body in order to change the current state of the campaign ab test variation.
tip
1 If you don't know the campaign ab test variation id, read the campaign ab tests to find it.

Request examples
Copied
Arrow
200 Arrow
  • 200
{
    "name": "updated variation",
    "settings": {
        "image": {
            "sr": "https://freeiconshop.com/wp-content/uploads/edd/image-outline-filled.png"
        },
        "override": {
            "text": 1
        }
    }
}