Create Campaign Ab test

Copied

                https://api.ocamba.com/v2/adex/campaign-ab-tests

Creates a new Campaign Ab test object

Request Body Schema

Name

Description

campaign_idstringrequired

Campaign id.

Example: 1011120

creative_idstringrequired

Creative id.

Example: 1322610

end_timedateTimerequired

Timezone: GMT. Ending date and time for AB test.

Example: 2021-10-29 15:40:10

namestringrequired

AB test name.

Example: First AB Test

start_timedateTimerequired

Timezone: GMT. Starting date and time for AB test.

Example: 2021-09-29 15:40:10

statusstringrequired

AB test activity status. On test creation, status is set to 'inactive'.

Example: active

Possible values: inactive | active

stickinessnumber (int)required

Test stickiness.

Possible values: 0 | 1

targetingab-test-targeting

AB test targeting.

AB Test Targeting

Name

Description

browsersobject

Name

Description

items[ object ]

Array of browser items, maximum length limited by subscription plan.

categoriesobject

Name

Description

itemsarray

Array of strings containing category ids, maximum number of items limited by subscription plan.

Example: IAB1,IAB2

opstring

String describing operation.

Example: eq

Possible values: in | nin | eq | neq

containersobject

Name

Description

items[ string ]

Array of strings containing containers ids. Maximum length limited by subscription plan.

opstring

String describing operation.

Example: in

Possible values: in

countriesobject

Name

Description

itemsarray

Array of strings containing country ids.

Example: RS,DE,CA,US

opstring

String describing operation.

Example: eq

Possible values: in | nin | eq | neq

device_manufacturersobject

Name

Description

itemsarray

Array of strings containing device manufacturer ids, maximum number of items limited by subscription plan.

Example: 14,6

opstring

String describing operation.

Example: eq

Possible values: in | nin | eq | neq

device_trackingnumber (integer)

Is device tracking enabled.

Possible values: 0 | 1

device_typesobject

Name

Description

itemsarray

Array of strings containing device types, maximum number of items limited by subscription plan.

Example: mobile,console

Possible values: mobile | desktop | console | tablet

opstring

String describing operation.

Example: eq

Possible values: in | nin | eq | neq

has_user_datanumber (integer)

Is user data enabled.

Possible values: 0 | 1

ipobject

Name

Description

itemsarray

Array of strings containing ips, each element must be a valid ipv4, ipv6 or cidr format for both v4 and v6. Maximum number of items limited by subscription plan.

Example: 123.523.123.4,123.523.123.4/12,2001:0db8:85a3:33a1:ff12:8a2e:0370:7334/23,2301:01b8:f5a3:43a1:afc2:8c2e:0370:7334

opstring

String describing operation.

Example: eq

Possible values: in | nin | eq | neq

keywordsobject

Name

Description

itemsarray

Array of unique strings containing keywords. One item can be a string with minimum length of 3 and maximum of 150, containing max 20 groups separated by \|. Each group can be made up of these characters: a-zA-Z0-9_%!

Example: keyword01!\|keyword02_%

languagesobject

Name

Description

items[ string ]

Array of unique strings. Each element must be a valid 2-letter language code supported by Ocamba platform, maximum number of items limited by subscription plan.

opstring

String describing operation.

Example: eq

Possible values: in | nin | eq | neq

osobject

Name

Description

items[ object ]

Array of os items, maximum length limited by subscription plan.

pagesobject

Name

Description

itemsarray

Array of strings containing page ids, maximum number of items limited by subscription plan.

Example: b92.net,google.com

opstring

String describing operation.

Example: eq

Possible values: in | nin | eq | neq

regionsobject

Name

Description

itemsarray

Array of strings containing region ids.

Example: 2661876,2565340

opstring

String describing operation.

Example: eq

Possible values: in | nin | eq | neq

subidsobject

Name

Description

itemsarray

Array of strings containing subids. Subid must not contain whitespace (space, tab, newline, etc.), maximum number of items limited by subscription plan.

Example: ref_subid,subid_2

opstring

String describing operation.

Example: eq

Possible values: in | nin | eq | neq

tagsobject

Name

Description

itemsarray

Array of strings containing tag ids, maximum number of items limited by subscription plan. This field is deprecated and will be removed in future. Please use container as a replacement.

Example: 1441,1623

opstring

String describing operation.

Example: eq

Possible values: in | nin | eq | neq

timeobject

Name

Description

itemsarray

Array of strings containing time in format of cron expression, maximum number of items limited by subscription plan.

Example: * * 1 * *,* 12,13,14,19,23 * 4,5,6 * 6,0

opstring

String describing operation.

Example: in

Possible values: in | eq

zonesobject

Name

Description

itemsarray

Array of strings containing zone ids, maximum number of items limited by subscription plan.

Example: 1334141,1773238

opstring

String describing operation.

Example: eq

Possible values: in | nin | eq | neq

variations[ campaign-ab-test-variation ]

List of variations in this AB test.

Campaign AB Test Variation

Name

Description

ab_test_idstring

AB test id.

Example: 10000

company_idstring

Company id.

Example: 6197120

create_timedateTime

Timezone: GMT.

Example: 2021-10-29 15:40:10

idstring

AB test id.

Example: 10000

namestring

Name of AB test variation.

Example: My Variation

settingsdynamic-native-creative

web-push-object-creative

web-push-external-demand-creative

dynamic-native-external-demand-creative

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

campaign_idinteger

Campaign id created on the Ocamba platform.

Example: 1111456

create_timedateTime

Timezone: GMT.

Example: 2021-09-29 15:40:10

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

idstring

A unique identifier generated by the Ocamba platform.

Example: 1319617

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

image_sizeobject

Name

Description

keystring

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

Example: en

valuestring

Size of a corresponding image in format WIDTHxHEIGHT.

Example: 600x400

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

campaign_idinteger

Campaign id created on the Ocamba platform.

Example: 1111456

create_timedateTime

Timezone: GMT.

Example: 2021-09-29 15:40:10

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

idstring

A unique identifier generated by the Ocamba platform.

Example: 1319617

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

image_sizeobject

Name

Description

keystring

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

Example: en

valuestring

Size of a corresponding image in format WIDTHxHEIGHT.

Example: 600x400

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

campaign_idinteger

Campaign id created on the Ocamba platform.

Example: 1111456

create_timedateTime

Timezone: GMT.

Example: 2021-09-29 15:40:10

exchange_idinteger

Exchange id created on the Ocamba platform and attached to the campaign which creative belongs to.

Example: 1341456

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

idstring

A unique identifier generated by the Ocamba platform.

Example: 1319617

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

image_sizeobject

Name

Description

keystring

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

Example: en

valuestring

Size of a corresponding image in format WIDTHxHEIGHT.

Example: 600x400

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

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.

campaign_idinteger

Campaign id created on the Ocamba platform.

Example: 1111456

create_timedateTime

Timezone: GMT.

Example: 2021-09-29 15:40:10

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

idstring

A unique identifier generated by the Ocamba platform.

Example: 1319617

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

image_sizeobject

Name

Description

keystring

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

Example: en

valuestring

Size of a corresponding image in format WIDTHxHEIGHT.

Example: 600x400

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

update_timedateTime

Timezone: GMT.

Example: 2021-10-29 15:40:10

Response status codes

201 - Created

note

1 We recommend using containers instead of tags, as tags are deprecated. If both parameters are sent, containers will take priority.

Request examples

Copied

200

{
    "campaign_id": "1010797",
    "creative_id": "1321448",
    "name": "TestNo3",
    "stickiness": 1,
    "status": "inactive",
    "start_time": "2024-11-05 11:28:59",
    "end_time": "2024-12-04 00:00:00",
    "targeting": {
        "keywords": {
            "items": [
                "all|any",
                "current"
            ],
            "op": "eq"
        },
        "subids": {
            "items": [
                "14326"
            ],
            "op": "eq"
        }
    },
    "variations": [
        {
            "name": "TestNo3",
            "settings": {
                "landing_url": "https://google.com",
                "image": {
                    "en": "https://freeiconshop.com/wp-content/uploads/edd/image-outline-filled.png",
                    "de": "https://freeiconshop.com/wp-content/uploads/edd/image-outline-filled.png"
                },
                "title": {
                    "en": "english",
                    "de": "deutsch"
                }
            }
        }
    ]
}

Response examples

Copied

201

{
    "id": "12845",
    "company_id": "6197120",
    "campaign_id": "1010797",
    "creative_id": "1321448",
    "name": "TestNo3",
    "status": "inactive",
    "start_time": "2024-11-05 11:28:59",
    "end_time": "2024-12-04 00:00:00",
    "stickiness": 1,
    "targeting": {
        "subids": {
            "items": [
                "14326"
            ],
            "op": "eq"
        },
        "keywords": {
            "items": [
                "all|any",
                "current"
            ]
        }
    },
    "variation_count": 2,
    "variations": [
        {
            "id": "12683",
            "name": "Creative 3(Control)",
            "is_control": true,
            "create_time": "2023-01-16 07:53:36",
            "update_time": "2023-01-16 07:53:36"
        },
        {
            "id": "12684",
            "name": "TestNo3",
            "settings": {
                "title": {
                    "de": "deutsch",
                    "en": "english"
                },
                "image": {
                    "de": "https://sm.ocmcore.com/share/6197120/adex/media/708766246-1673855617059-image",
                    "en": "https://sm.ocmcore.com/share/6197120/adex/media/708766246-1673855616275-image"
                },
                "image_size": {
                    "de": "256x256",
                    "en": "256x256"
                },
                "landing_url": "https://google.com"
            },
            "create_time": "2023-01-16 07:53:36",
            "update_time": "2023-01-16 07:53:36"
        }
    ]
}

Create Campaign Ab test

POST /campaign-ab-testsCopied https://api.ocamba.com/v2/adex/campaign-ab-tests

POST /campaign-ab-tests
Copied
`https://api.ocamba.com/v2/adex/campaign-ab-tests`