API Queries - Add Keyword

The add_keyword function creates a new Keyword. 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)
• 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)
• negative - Any negative keywords, comma separated. (Optional)
• target_url - The Target URL, including http:// (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)
• freq_cap - Limit on number of visits per unique user in 24 hour period. Choose from "3", "6" or "12".
  Default is "6". (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)

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

Example query and response:

In this example, we will be adding the keyword "credit cards" to the folder "Student Loans" with a bid of $5, daily spend of $200, negative keyword "interest free", target URL http://www.trellian.com and geo target of "US".

Example query:

Note the URL encoding on the values.

Response:

<results>
<result Folder="student loans" Keyword="credit card" Status="Added"/>
</results>

The above response means that the Keyword was successfully created and will be in the "Paused" status. It will be automatically activated once approved by our system.

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.
• 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 - Remarketing Multiple must be integer which is equal to or greater than 2.
• 422 - Negative keyword list must be comma separated, and keywords may only contain letters, digits and spaces.
• 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.
• 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 API Key invalid.

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