API Queries - Add Suggest

The add_keyword function creates a new brand. This function requires additional parameters. Failing to include them will result in an error response.

Additional Parameters

• keyword - Keyword to be added. Does not accept multiple keywords. (Required, for suggest keywords should be from list_brands keywords list)
• folder - Name of the folder where the keyword is to be added. (Required)
• my_bid - Your bid for the keyword. (Required)
• traffic_type - Choose from traffic type "all", "mobile" or "desktop". Default is "all". (Optional)
• daily_limit - Daily spend limit for the keyword. (Optional)
• channel - suggest (Required)
• target_url - The Target URL, including https:// (Required) geo_target - The Geo Target, either "all", "us", "uk", "ca", "au", "nz", "in", "br", "de", "fr", "nl", "it", or "es". Default is "all". (Optional)
• active - Activate the keyword upon creation. On "1" or off "0". Default is "1" (on). (Optional) (for suggest 0 means do not turn campaign ON once admin approves)
• freq_cap - Limit on number of visits per unique user in 24 hour period. Choose from "3", "6" or "12". Default is "6". (Optional)
• include_coupon - Include Coupon traffic. "1" to include, "0" to exclude. Default is "0" (optional)

Note: Make sure to URL encode all values, most importantly the target_url value.

Example query and response:

1) List Brands Query:

To get brand list for suggest need to pass list_brands to get list of brands with keywords

https://bid.trellian.com/api.html?username=user&password=pass&api_key=key&mode=list_brands

<results>
<result brand="zZounds.com" Keyword="zzoundscom" url="zzounds.com"/>
<result brand="Zyro" Keyword="zyro" url="zyro.com"/>
<result brand="Zyppah" Keyword="zyppah" url="zyppah.com"/>
<result brand="Zygor Guides" Keyword="zygorguides" url="zygorguides.com"/>
<result brand="Zygo" Keyword="zygo" url="shopzygo.com"/>
<result brand="Zwillingsherz" Keyword="zwillingsherz" url="zwillingsherz.com"/>
<result brand="Zwilling.com" Keyword="zwillingcom" url="zwilling.com"/>
<result brand="Wlowood" Keyword="wlowood" url="wlowood.com"/>
</results>
                    

Note: This will not give result and will show 421 - Please contact your Account Manager if user does not have suggest in not enabled in their account.

2) Add Query:

Note: Keyword should be from step 1

<results>
<result Folder="test" Keyword="1001hobbies" Status="Keyword sent for approval"/>
</results>

Error Responses:

Possible error responses for this function are:

• 412 - Keyword is a required argument for this mode.
• 412 - My Bid is a required argument for this mode.
• 412 - Folder is a required argument for this mode.
• 412 - Geo Target is a required argument for this mode.
• 412 - Target URL is a required argument for this mode.
• 412 - Keyword needs to be from brand list provided.
• 420 - Folder not in account.
• 421 - Active may only be "1" or "0".
• 421 - Frequency Cap for Keywords may only be "3","6","12".
• 421 - Keyword may only contain letters, digits and spaces.
• 421 - Folder name may only contain letters, digits and spaces.
• 421 - Traffic Type may only be "all","mobile","desktop".
• 421 - Target URL entered is invalid.
• 421 - Please verify account to activate campaign.
• 421 - Please add suggest in channel parameter.
• 421 - Please contact your Account Manager.
• 423 - My Bid must contain digits and an optional decimal point only.
• 423 - Sorry, the entered bid is not valid. Bid should be entered in a valid format (2 decimal places).
• 423 - Sorry, the bid amount is outside the allowed range. My Bid should be no more than $100.
• 423 - My Bid should be in range from $0.05 to $100.
• 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.
• 421 - Active may only be "1" or "0".
• 425 - Target URL is not in valid format.
• 429 - Geo Target is invalid.
• Other general errors, such as 200 - Internal Error or 300 - Username or password invalid.

For a complete list of error responses, see the Error Codes manual page.