View Creative

GET /creatives/{id}
Copied
Arrow
                https://api.ocamba.com/api/v1/adex/creatives/{id}

Retrieves the details of a Creative that has previously been created if a valid identifier was provided

path Parameters
Arrow
Name
Description
idstringrequired
Unique identifier for the object defined as a path parameter.


Example: 12345
query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /VERSION/adex/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3
viewstring
Adex API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.


Example: view=full/default

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ dynamic-native-creative ]
An array of all created items.
Creative - Dynamic Native
Name
Description
addressstring
Address


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


Example: https://example.com
bannerobject
A rectangular graphic display ad that stretches across the top, bottom, or sides of a website or online media property.
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
Descriptive text associated with the text product or service being advertised. Key-value pairs {key : value}
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
Additional descriptive text associated text with the product or service being advertised. Key-value pairs {key : value}
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
Image address which will be the main visual attribute presented to the user. Key-value pairs {key : value}
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
Sizes of images in 'image' field. This object is created automatically based on image files downloaded from urls given in 'image' field.
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
Sponsored By message where text response should contain the brand name of the sponsor. Key-value pairs {key : value}
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
The Title object is to be used for title element of the Native ad. Key-value pairs {key : value}
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
totalinteger
A total number of items.


Example: 1
tip
1 If you don't know the creative id, list the creatives to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
    "total": 1,
    "items": [
        {
            "id": "1319667",
            "name": "demo_dynamic_native",
            "type": "dynamic-native",
            "status": "active",
            "distribution_rate": "0",
            "settings": {
                "size": "0x0",
                "title": {
                    "en": "http://example.domen/image/en.jpg",
                    "de": "http://example.domen/image/de.jpg",
                },
                "image": {
                    "en": "http://example.domen/image/en.jpg",
                },
                "landing_url": "http://example.domen/campaigns/view/?id=${CONVERSION_ID}",
                "target": null,
                "tracking_pixels": [
                    "http://example.domen/campaigns/view/?id=${CLICK_ID}",
                    "http://example.domen/campaigns/view/?id=${SESSION_ID}",
                ],
                "advertiser_domain": "http://example.domen/",
                "sponsored": {
                    "en": "demo-sponsor",
                    "ar": "arabic-sponsor"
                },
                "description": null,
                "rating": null,
                "likes": null,
                "downloads": null,
                "price": null,
                "sale_price": null,
                "phone": null,
                "address": null,
                "description_2": {
                    "en": "test_desc",
                    "a0": "test_desc"
                },
                "display_url": null,
                "ctatext": null,
                "postback": 1,
                "bundle_id": null
            },
            "create_time": "2020-10-26 18:33:39"
        }
    ]
}

{
  "total": 1,
  "items": [
    {
      "id": "1319617",
      "name": "Demo_dynamic_native",
      "status": "active",
      "title": {
        "key": "en",
        "value": "en_demo_title"
      },
      "image": {
        "key": "en",
        "value": "http://example.domen/image/en.jpg"
      },
      "image_size": {
        "key": "en",
        "value": "600x400"
      },
      "sponsored": {
        "key": "en",
        "value": "en sponsor"
      },
      "description": {
        "key": "en",
        "value": "en description"
      },
      "description_2": {
        "key": "en",
        "value": "en description2"
      },
      "type": "dynamic-native",
      "campaign_id": 1111456,
      "landing_url": "https://example.com",
      "target": "_top",
      "tracking_pixels": [
        null
      ],
      "advertiser_domain": "https://example.com",
      "likes": 10,
      "downloads": 5,
      "price": 12.99,
      "sale_price": 9.99,
      "phone": "032456312",
      "address": "Dragise Misovica 163B",
      "banner": {
        "key": "en",
        "value": "http://example.domen/image/en.jpg"
      },
      "html5": "<div>Test</div>",
      "third_party_code": "<html><body>Test</body></html>",
      "ctatext": "1",
      "display_url": "https://example.com",
      "postback": 1,
      "bundle_id": "1017",
      "create_time": "2021-09-29 15:40:10"
    }
  ]
}