View Settings

GET /settings
Copied
Arrow
                https://api.ocamba.com/v2/adex/settings

Display account Settings

Response status codes
Arrow
200 - OK
Arrow
Name
Description
ad_unit_sizeobject
Ad unit size settings.
Name
Description
use_only_iabnumber (integer)
Is only iab format used. Accepted values are 0 and 1.
currencyobject
Currency settings.
Name
Description
currencies[ string ]
List of all supported currencies. Max 10 items. Must be valid 3-letter uppercase currency code supported by ocamba platform.


Example: USD
defaultstring
Currency code of a default used currency in format of valid 3-letter uppercase currency code supported by ocamba platform. Changing default currency is currently unavailable.


Example: USD

Default: USD
multipliernumber
Multiplier for used currencies. Value must be between 0.1 and 2.


Example: 1

Default: 1
domains[ domain-group ]
Domain groups. There can be maximum of 10 groups.
Domain Group
Name
Description
clickstring
Click domain. Must be a valid domain string.


Example: t.ocmant.com
conversionstring
Conversion domain. Must be a valid domain string.


Example: t.ocmant.com
feedstring
Feed domain. Must be a valid domain string.


Example: feed.ocmant.com
idstring
Unique id for a domain group in format of UUIDv4.


Example: 1d40dfc5-b301-43c2-a556-39f23d7f1a26
impressionstring
Impression domain. Must be a valid domain string.


Example: t.ocmant.com
namestring
Name given by user for easier identification of a group. Name can have minimum 2 and maximum 65 characters. If name is not set, value of feed domain name is set as name.


Example: My important group
pushstring
Push domain. Must be a valid domain string.


Example: push.ocmant.com
testobject

Name
Description
errors[ string ]

messagestring

statusstring

generalobject
General settings.
Name
Description
campaign_prioritystring
Campaign priority. Accepted values are local backfill, unfilled and compete.


Example: compete

Default: compete
campaign_search_algostring
Algorythm used for campaign search. Accepted values are round-robinn, multi-armed-bandit and internal-sort-by-bid.


Example: round-robin

Default: round-robin
exchange_numinteger
Exchange number. Accepted values are 1, 4, 8 and 12.


Example: 1

Default: 1
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
    "company_id": "6197120",
    "general": {
        "campaign_search_algo": "multi-armed-bandit",
        "campaign_priority": "compete",
        "exchange_num": 1
    },
    "ad_unit_size": {
        "use_only_iab": 1
    },
    "currency": {
        "default": "USD",
        "multiplier": 1.22,
        "currencies": [
            "CNY",
            "USD"
        ]
    },
    "domains": [
        {
            "id": "d1eca841-fdf3-4d77-9c92-12582018c78f",
            "name": "MyGroup",
            "click": "t.ocmant.com",
            "impression": "t.ocmant.com",
            "conversion": "t.ocmant.com",
            "feed": "feed.ocmxr.com",
            "push": "push.ocmxr.com"
        }
    ],
    "create_time": "2022-09-14 06:58:11",
    "update_time": "2022-09-19 11:59:30"
}

{
  "general": {
    "campaign_search_algo": "round-robin",
    "campaign_priority": "compete",
    "exchange_num": 1
  },
  "currency": {
    "default": "USD",
    "currencies": [
      "USD"
    ],
    "multiplier": 1
  },
  "ad_unit_size": {},
  "domains": [
    {
      "id": "1d40dfc5-b301-43c2-a556-39f23d7f1a26",
      "name": "My important group",
      "click": "t.ocmant.com",
      "impression": "t.ocmant.com",
      "conversion": "t.ocmant.com",
      "feed": "feed.ocmant.com",
      "push": "push.ocmant.com",
      "test": {
        "errors": [
          null
        ]
      }
    }
  ]
}