System
This SOAP service provides general operations required for managing your account.
Service endpoint URL (WSDL definition) is https://api.oddbytes.com/?v3=system.wsdl .
Service Operation | ||
Operation | Result Type | Descrition |
Returns date and time on the API server. This allows your API client to introduce correction offset for any existing time differences, either because of different time zones or because of any other reason. | ||
Returns current API version, as spoken by the server. | ||
Returns username of your account accessed through the API. | ||
Returns the set of lockdown IP addresses from which access to your account is limited through the API, for improved security. | ||
Returns regions codes and descriptions, together with minimal and maximal bids allowed for each of them, as allowed for your account, please see type Region for more details. | ||
Returns current account–level serving status. Having your account disabled results in no more traffic received until it is enabled again. | ||
Resumes serving for your whole account, if it was paused. Upon completion, you will begin receiving traffic again. | ||
Pauses serving for your whole account, if it was active. Upon completion, you will receive no traffic until account is resumed. Please note that account can not be paused if it contains no online campaigns. |
getServerTime
Returns date and time on the API server. This allows your API client to introduce correction offset for any existing time differences, either because of different time zones or because of any other reason.
Property | Type | Null Allowed | Description |
ServerTimeResult
Property | Type | Null Allowed | Description |
dateTime | dateTime | Current date and time on the API server (format: yyyy-mm-ddTHH:mm:sszzzzzz, difference between server time and the Greenwich time (GMT) is returned as zzzzzz part of the date / time string) |
getApiVersion
Returns current API version, as spoken by the server.
Property | Type | Null Allowed | Description |
ApiVersionResult
Property | Type | Null Allowed | Description |
version | string | Version of the Advertiser API, as spoken by the server (format: x.y.z) |
getUsername
Returns username of your account accessed through the API.
Property | Type | Null Allowed | Description |
UsernameResult
Property | Type | Null Allowed | Description |
username | string | Username of your account accessed through the API |
getLockdown
Returns the set of lockdown IP addresses from which access to your account is limited through the API, for improved security.
Property | Type | Null Allowed | Description |
LockdownResult
Property | Type | Null Allowed | Description |
ipAddresses | string[] (0:20) | List of lockdown IP addresses |
getRegions
Returns regions codes and descriptions, together with minimal and maximal bids allowed for each of them, as allowed for your account, please see type Region for more details.
Property | Type | Null Allowed | Description |
RegionsResult
Property | Type | Null Allowed | Description |
regions | Region[] (0:unbound) | List of regions, together with your minimal and maximal allowed bids |
getAccountStatus
Returns current account–level serving status. Having your account disabled results in no more traffic received until it is enabled again.
Property | Type | Null Allowed | Description |
AccountStatusResult
Property | Type | Null Allowed | Description |
status | AccountStatus | Current account–level serving status |
resumeAccount
Resumes serving for your whole account, if it was paused. Upon completion, you will begin receiving traffic again.
Property | Type | Null Allowed | Description |
ToggleResult
Property | Type | Null Allowed | Description |
changed | bool | Status of the performed toggling operation |
pauseAccount
Pauses serving for your whole account, if it was active. Upon completion, you will receive no traffic until account is resumed. Please note that account can not be paused if it contains no online campaigns.
Property | Type | Null Allowed | Description |
ToggleResult
Property | Type | Null Allowed | Description |
changed | bool | Status of the performed toggling operation |
ServerTimeResult
Return value type used while fetching current server time.
Property | Type | Null Allowed | Description |
dateTime | dateTime | Current date and time on the API server (format: yyyy-mm-ddTHH:mm:sszzzzzz, difference between server time and the Greenwich time (GMT) is returned as zzzzzz part of the date / time string) |
ApiVersionResult
Return value type used while fetching current API version.
Property | Type | Null Allowed | Description |
version | string | Version of the Advertiser API, as spoken by the server (format: x.y.z) |
UsernameResult
Return value type used while fetching username of your account.
Property | Type | Null Allowed | Description |
username | string | Username of your account accessed through the API |
LockdownResult
Return value type used while fetching IP address lockdown settings.
Property | Type | Null Allowed | Description |
ipAddresses | string[] (0:20) | List of lockdown IP addresses |
RegionsResult
Return value type used while fetching regions data.
Property | Type | Null Allowed | Description |
regions | Region[] (0:unbound) | List of regions, together with your minimal and maximal allowed bids |
Region
Return value type used while fetching region data.
Property | Type | Null Allowed | Description |
regionCode | string | Region code represented by a two-character acronym (US, CA, UK etc.) | |
regionName | string | Region description (Country name) | |
displayMinBid | float | Your minimal allowed bid for Display creatives | |
displayMaxBid | float | Your maximal allowed bid for Display creatives | |
textlinkMinBid | float | Your minimal allowed bid for Textlink creatives | |
textlinkMaxBid | float | Your maximal allowed bid for Textlink creatives | |
lightboxMinBid | float | Your minimal allowed bid for Lightbox creatives | |
lightboxMaxBid | float | Your maximal allowed bid for Lightbox creatives | |
pushMinBid | float | Your minimal allowed bid for Push creatives | |
pushMaxBid | float | Your maximal allowed bid for Push creatives | |
postcheckoutMinBid | float | Your minimal allowed bid for Postcheckout creatives | |
postcheckoutMaxBid | float | Your maximal allowed bid for Postcheckout creatives |
AccountStatusResult
Return value type used while fetching account–level serving status.
Property | Type | Null Allowed | Description |
status | AccountStatus | Current account–level serving status |
ToggleResult
Return value type used while toggling status for one or more already existing items.
Property | Type | Null Allowed | Description |
changed | bool | Status of the performed toggling operation |