List Campaign creatives

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

Returns a list of Campaign creatives

path Parameters
Arrow
Name
Description
campaign_idstringrequired
Unique campaign identifier.


Example: campaign_id=1000001
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
sortstring
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /VERSION/adex/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /VERSION/adex/RESOURCE_NAME?sort=-id → sorts per id descending
GET /VERSION/adex/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.


Example: sort=-field1,field2
pagestring
The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.


Example: page=1,10
qstring
Set the q parameter value to search for a keyword or search term.

Example:
GET /VERSION/adex/RESOURCE_NAME?q=sou → returns a certain resource that contain string 'sou'

See tips for the list of searchable parameters.
q_fieldsstring
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /VERSION/adex/RESOURCE_NAME?q=sou&q_fields=lname → API retuns a certain resource whose lname contains string 'sou'.
GET /VERSION/adex/RESOURCE_NAME?q=sou&q_fields=fname,lname,email → API returns a certain resource that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.
statusstring
Describe status of the object.


Example: status=status1
typestring
Describe type of the object.


Example: type=type1

Response status codes
Arrow
200 - OK
Arrow

tip
1 Searchable field is name.
2 Sortable fields are create_time, update_time.
info
1 The response example is representing a full view.
note
1 Path parameter campaign_id is only useable on campaigns/{cid}/creatives routes. It is represented by {cid}.

Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "total": 94,
  "items": [
    {
      "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"
      },
      "landing_url": "http://www.delsystems.net",
      "target": "_blank",
      "advertiser_domain": "www.delsystems.net"
    },
    {
      "id": "1000005",
      "campaign_id": 1006454,
      "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
      }
    },
    {
      "id": "1000006",
      "campaign_id" : 1006454,
      "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"
          }
        }
      ]
    },
    {
      "id": "1000007",
      "campaign_id":1006454,
      "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"
        }
      ]
    }
  ]
}