Targets
This SOAP service provides operations for managing your targets.
Service endpoint URL (WSDL definition) is https://api.oddbytes.com/?v3=targets.wsdl .
Service Operation | ||
Operation | Result Type | Descrition |
Returns the list of compound ID values for your targets belonging to your selected campaigns and/or creatives. Please note that it is not allowed to specify both campaigns and creatives filters as Null, at least one of them is required. | ||
Returns the parameters stored for your already existing targets, please see type Target for more details. | ||
Adds new targets into your already existing creative. Please note that stored targets and max. bids can be different than the specified values, due to transformations performed before adding targets and bids rounding or your minimal and maximal allowed bids; see types Target , TargetAdd and TargetAdded and/or operation getRegions() for more details. | ||
Performs changes to your already existing targets, by changing the max. bids. Please note that stored max. bids can be different than the specified values, due to rounding or your minimal and maximal allowed bids; see type Target and operation getRegions() for more details. | ||
Resumes your already existing and currently paused or rejected targets. | ||
Pauses your already existing and currently non–paused targets. | ||
Deletes already existing targets from your account. Please note that once deleted, targets can not be accessed any longer or undeleted later. | ||
Returns suggested targets that can be used within your creatives. Please note that for each request at most 1,000 suggested targets currently having highest activity are returned, see type TargetSuggested for more details. |
getTargetIds
Returns the list of compound ID values for your targets belonging to your selected campaigns and/or creatives. Please note that it is not allowed to specify both campaigns and creatives filters as Null, at least one of them is required.
Property | Type | Null Allowed | Description |
campaignIds | unsignedInt[] (1:50) | ✔ | Optional filter specification for campaign ID values |
creativeIds | unsignedInt[] (1:100) | ✔ | Optional filter specification for creative ID values |
filterNames | string[] (1:100) | ✔ | Optional filter specification for targets (keywords or URLs) |
TargetIdsResult
Property | Type | Null Allowed | Description |
ids | TargetId[] (0:unbound) | List of compound ID values for your targets |
getTargets
Returns the parameters stored for your already existing targets, please see type Target for more details.
Property | Type | Null Allowed | Description |
targetIds | TargetId[] (1:1000) | List of targets compound ID values | |
fetchStats | bool | ✔ | Option for also fetching activity, ranks and brief stats data for the returned targets |
TargetsResult
Property | Type | Null Allowed | Description |
targets | Target[] (0:unbound) | Targets data stored for your already existing targets |
getCategories
Returns all currently available NLP topics. Please note that if you want to use NLP topic add id value to target value in TargetAdd see type Category for more details.
Property | Type | Null Allowed | Description |
CategoriesResult
Property | Type | Null Allowed | Description |
categories | Category[] (1:unbound) | Available creatives categories |
addTargets
Adds new targets into your already existing creative. Please note that stored targets and max. bids can be different than the specified values, due to transformations performed before adding targets and bids rounding or your minimal and maximal allowed bids; see types Target , TargetAdd and TargetAdded and/or operation getRegions() for more details.
Property | Type | Null Allowed | Description |
creativeId | unsignedInt | Creative ID value for the destination creative | |
targets | TargetAdd[] (1:1000) | Targets definition data |
TargetsAddResult
Property | Type | Null Allowed | Description |
added | TargetAdded[] (0:unbound) | List of the successfully added targets | |
ignored | TargetIgnored[] (0:unbound) | List of targets that were ignored during the addition |
updateTargets
Performs changes to your already existing targets, by changing the max. bids. Please note that stored max. bids can be different than the specified values, due to rounding or your minimal and maximal allowed bids; see type Target and operation getRegions() for more details.
Property | Type | Null Allowed | Description |
targets | TargetUpdate[] (1:100000) | Targets parameters to be updated |
TargetsUpdateResult
Property | Type | Null Allowed | Description |
updated | TargetUpdated[] (0:unbound) | List of the successfully updated targets | |
unchangedIds | TargetId[] (0:unbound) | List of compound ID values for unchanged targets |
resumeTargets
Resumes your already existing and currently paused or rejected targets.
Property | Type | Null Allowed | Description |
targetIds | TargetId[] (1:1000) | List of targets compound ID values |
TargetsStatusResult
Property | Type | Null Allowed | Description |
changedIds | TargetId[] (0:unbound) | List of compound ID values for successfully changed targets | |
unchangedIds | TargetId[] (0:unbound) | List of compound ID values for unchanged targets |
pauseTargets
Pauses your already existing and currently non–paused targets.
Property | Type | Null Allowed | Description |
targetIds | TargetId[] (1:1000) | List of targets compound ID values |
TargetsStatusResult
Property | Type | Null Allowed | Description |
changedIds | TargetId[] (0:unbound) | List of compound ID values for successfully changed targets | |
unchangedIds | TargetId[] (0:unbound) | List of compound ID values for unchanged targets |
deleteTargets
Deletes already existing targets from your account. Please note that once deleted, targets can not be accessed any longer or undeleted later.
Property | Type | Null Allowed | Description |
targetIds | TargetId[] (1:1000) | List of targets compound ID values |
TargetsDeleteResult
Property | Type | Null Allowed | Description |
deletedIds | TargetId[] (0:unbound) | List of compound ID values for successfully deleted targets |
getSuggested
Returns suggested targets that can be used within your creatives. Please note that for each request at most 1,000 suggested targets currently having highest activity are returned, see type TargetSuggested for more details.
Property | Type | Null Allowed | Description |
pattern | string | Search pattern for targets suggestion — asterisk (*) can be used as a wildcard character | |
regionCode | string | Targeted region code; please see operation getRegions() for more details | |
creativeType | CreativeType | Creative type; please note that suggestions are different for each type |
TargetsSuggestResult
Property | Type | Null Allowed | Description |
targets | TargetSuggested[] (0:1000) | Suggested targets that can be used within your creatives |
TargetIdsResult
Return value type used while fetching compound ID values of your targets.
Property | Type | Null Allowed | Description |
ids | TargetId[] (0:unbound) | List of compound ID values for your targets |
TargetId
Value type representing the compound ID value of a target.
Property | Type | Null Allowed | Description |
creativeId | unsignedInt | Creative ID value, as the target's parent element | |
targetId | unsignedInt | Target ID value |
TargetsResult
Return value type used while fetching stored data for your already existing targets.
Property | Type | Null Allowed | Description |
targets | Target[] (0:unbound) | Targets data stored for your already existing targets |
Target
Return value type used while fetching stored data for your already existing target.
Property | Type | Null Allowed | Description |
id | Compound ID value of the target | ||
target | string | Target value (keyword or URL) | |
status | TargetStatus | Target status | |
creativeType | CreativeType | Type of the creative targets belongs to | |
regionCode | string | Targeted region; please see operation getRegions() for more details and the list of available regions codes | |
maxBid | float | Max. bid value for the target; please note that max. bid values are stored as rounded to three decimal places for DISPLAY creatives, and rounded to two decimal places for other creatives types | |
created | dateTime | Date and time of target creation | |
modified | dateTime | Date and time of last target modification | |
stats | ✔ | Activity, opening bid, average rank and estimated rank stats data for the target, returned only if requested; please see operation getTargets() for more details |
TargetStats
Return value type used while fetching activity, ranks and brief stats data for your already existing target.
Please note that at most one of the properties averageRank and estimatedRank can be received as a non–Null value, meaning that values for average rank and rank estimate are never available both at the same time. However, they can be both received as Null in case the target has not had any clicks or impressions recently.
Property | Type | Null Allowed | Description |
activity | unsignedInt | Region–level activity for the target, represented by integer value between 0 and 5; receiving 0 means that target currently has no activity, while receiving 5 means the target is highly active | |
openingBid | float | ✔ | Opening bid for the target; receiving Null means that target has not had any clicks or impressions recently and no value is available |
averageRank | float | ✔ | Average rank for the target, calculated for the current hour; receiving Null means that you received no clicks or impressions in the current hour for the target, and no average rank is available |
estimatedRank | TargetEstimatedRank | ✔ | Estimated rank for the target, based on your current max. bid; receiving Null means that target has not had any clicks or impressions recently and no rank estimate is available |
lastServed | dateTime | ✔ | Date and time of last received impression (for Display creatives) or click (for Textlink creatives); receiving Null means having no impressions or clicks received yet |
CategoriesResult
Return value type used while fetching available creatives categories.
Property | Type | Null Allowed | Description |
categories | Category[] (1:unbound) | Available creatives categories |
Category
Return value type used while fetching available IABEX categories.
Property | Type | Null Allowed | Description |
id | string | NLP topic ID value that can be used instead of target value in TargetAdd value type | |
name | string | NLP topic name |
TargetsAddResult
Return value type used while adding new targets into your creatives.
Property | Type | Null Allowed | Description |
added | TargetAdded[] (0:unbound) | List of the successfully added targets | |
ignored | TargetIgnored[] (0:unbound) | List of targets that were ignored during the addition |
TargetAdded
Return value type used for the targets added while adding new targets into your creative.
Property | Type | Null Allowed | Description |
id | Compound ID value of the target | ||
target | string | Target value (keyword or URL); please note that it can be different than the specified value due to transformations performed before adding targets, see type TargetAdd and operation addTargets() for more details | |
maxBid | float | Stored max. bid value; please note that it can be different than the specified value due to rounding or your minimal and maximal allowed bids, see type Target and operation getRegions() for more details |
TargetIgnored
Return value type used for the targets ignored while adding new targets into your creative.
Property | Type | Null Allowed | Description |
target | string | Target value (keyword or URL) | |
description | string | Explanation of why the specified target was actually ignored |
TargetAdd
Value type used for specifying target definition data while adding new targets into your creatives.
Please note that targeted region is inherited by the targets from the creative into which new targets are actually added.
UTF-8 characters allowed within targets are including the following: 0–9 a–z A–Z . / - _ ~ ' + & ? = ¡ ¨ ¿–Ö Ø–ö ø–ÿ
Before adding targets, specified values are transformed so all whitespace (multiple spaces, tabs, new lines etc.) is replaced with single spaces, all remaining leading or trailing whitespace is trimmed, strings like www.  and http://  are removed from the beginning of targets, any leading or trailing characters + - .  are trimmed, and any trailing character / is trimmed.
Minimum length for a target is two characters. Maximum length for a target is 100 characters for URL and 244 characters for other keyword. Target is allowed to have at most eight subwords.
Property | Type | Null Allowed | Description |
target | string | Target to be added | |
maxBid | float | Max. bid value for the target; please note that no trailing zeroes are allowed to be specified after the decimal point |
TargetsUpdateResult
Return value type used while updating your already existing targets.
Property | Type | Null Allowed | Description |
updated | TargetUpdated[] (0:unbound) | List of the successfully updated targets | |
unchangedIds | TargetId[] (0:unbound) | List of compound ID values for unchanged targets |
TargetUpdated
Return value type used for the targets having their max. bids updated while updating your already existing targets.
Property | Type | Null Allowed | Description |
id | Compound ID value of the target | ||
maxBid | float | Stored max. bid value; can be different than the specified max. bid due to your minimal and maximal allowed bids; please see operation getRegions() for more details |
TargetUpdate
Value type used for specifying target parameters while updating already existing targets.
Property | Type | Null Allowed | Description |
id | Compound ID value of the target | ||
maxBid | float | Max. bid value for the target; please note that no trailing zeroes are allowed to be specified after the decimal point |
TargetsStatusResult
Return value type used while changing statuses for your already existing targets.
Property | Type | Null Allowed | Description |
changedIds | TargetId[] (0:unbound) | List of compound ID values for successfully changed targets | |
unchangedIds | TargetId[] (0:unbound) | List of compound ID values for unchanged targets |
TargetsDeleteResult
Return value type used while deleting your already existing targets.
Property | Type | Null Allowed | Description |
deletedIds | TargetId[] (0:unbound) | List of compound ID values for successfully deleted targets |
TargetsSuggestResult
Return value type used while fetching suggested targets that can be used within your creatives.
Property | Type | Null Allowed | Description |
targets | TargetSuggested[] (0:1000) | Suggested targets that can be used within your creatives |
TargetSuggested
Return value type used while fetching suggested target that can be used within your creatives.
Property | Type | Null Allowed | Description |
target | string | Target value (keyword or URL) | |
activity | unsignedInt | Region–level activity for the target, represented by integer value between 0 and 5; receiving 0 means that target currently has no activity, while receiving 5 means the target is highly active | |
openingBid | float | ✔ | Opening bid for the target; receiving Null means that target has not had any clicks or impressions recently and no value is available |