Customer Support
Trillion Direct Search Network
API Manual
API Queries - Update RON
The update_ron function allows you to change settings or the status of an existing Keyword. This function requires additional parameters. Although optional parameters are not all required, at least one must be included. Failing to include required parameters or at least one optional will result in an error response.
Additional Parameters
- ron - Name of the RON campaign. (Required)
- daily_limit - Daily spend limit for the RON. (Optional)
- my_bid - Bid price for the RON. (Optional)
- target_url - The Target URL, including http:// (Optional)
- freq_cap - Limit on number of visits per unique user in 24 hour period. Choose from "3", "6" or "12". (Optional)
- bl_subid - Adds subid to blacklist. (Optional)
- del_bl_subid - Removes subid from blacklist. (Optional)
- wl_subid - Adds subid to whitelist. (Optional)
- premium_bid - Premium bid amount for whitelisted subid. (Required)
- other_subid_traffic - Allow traffic from whitelisted subids plus all other subids associated with this campaign.
On is 1 and off is 0. Default is 1 (on). (Optional) - del_wl_subid - Removes subid from whitelist. (Optional)
- remarketing_multiple - Set your max bid for the remarketed visit at multiple times the original cpc price. Minimum is "2". "0" means to turn remarketing off. (Optional)
- active - To Stop or Activate the RON, use values 0 or 1, respectively. (Optional)
Notes: Make sure to URL encode all values.
Example query and response:
In this example, we will be update the RON ".us.subp.desktop.windows.chrome" to use the target URL "http://www.trellian.com?subid=$SUBID".
Example query:
http://bid.trellian.com/api.html?username=user&api_key=key&mode=update_ron
&ron=.us.subp.desktop.windows.chrome&target_url=http%3A%2F%2Fwww.trellian.com%3Fsubid%3D%24SUBID
Note the URL encoding on the values.
Response:
<results> <result Setting="TargetUrl" Success="1" Value="http://www.trellian.com?subid=$SUBID"/> </results>
The above response means that the URL in the RON campaign was successfully updated.
Error Responses:
Possible error responses for this function are:
- 401 - Multiple Sub ID actions not supported.
- 423 - This is not a valid RON name.
- 421 - RON may only contain letters, digits and periods.
- 412 - RON is a required argument for this mode.
- 412 - Premium Bid is a required argument for parameter Whitelist Subid.
- 413 - No changes were requested.
- 420 - RON not found.
- 420 - Subid ###### not in blacklist.
- 420 - Subid ###### not in whitelist.
- 420 - Subid ###### does not exist.
- 420 - Subid ###### is whitelisted. Please delete first before blacklisting.
- 420 - Subid ###### is blacklisted. Please delete first before whitelisting.
- 421 - Target URL entered is invalid.
- 421 - Frequency Cap for RON campaigns may only be "3", "6" or "12".
- 421 - Remarketing Multiple must be integer which is equal to or greater than 2.
- 423 - My Bid must contain digits and an optional decimal point only.
- 423 - Premium Bid must be numeric.
- 423 - Your Premium Bid must be less than or equal to $100.
- 423 - Other Subid traffic can not be disabled for REM2 campaigns.
- 424 - Subid blacklisting not available for REM2 campaigns.
- 424 - Daily Limit must contain digits and an optional decimal point only, or be left blank to have no limit set.
- 424 - Sorry, the Daily Limit amount is outside the allowed range.
Limit must be no less than $10.00 and no greater than $10000.00. - 424 - Subid must be numeric.
- 424 - Subid not blacklisted as it exceeds limit on campaign.
- 424 - Subid invalid.
- 425 - Target URL is not in valid format.
- 429 - Other Subid Traffic may only be "1" or "0".
- 429 - Your Premium Bid does not meet the required bid for this Subid. Please increase your bid to at least $##.##.
- Other general errors, such as 200 - Internal Error or 300 - Username or API Key invalid.
For a complete list of error responses, see the Error Codes manual page.