KeywordService provides operations for creating and managing keywords.
A keyword is a search term that you bid on that is related to the products or services you want to advertise. Keywords, together with related ads, are grouped under ad groups. When a user enters a query that matches one of the keywords in the ad group, your ad is displayed. Values set at the keyword level override corresponding values set at, and inherited from, the ad group level.
KeywordService provides several operations for managing keywords and checking the status of keywords.
To create a new keyword, use the addKeyword and addKeywords operations. The first operation creates one keyword; the second operation creates one or more keywords. All new keywords are subject to editorial review.
To update a keyword, use the updateKeyword and updateKeywords operations.
If an updated element requires editorial review (for example, the keyword's alternate text), the original keyword remains online during the review process.
To determine the updates for a keyword that have been submitted for editorial review, use the getUpdateForKeyword operation.
To create a copy of a keyword for another ad group, use the copyKeyword operation. To move a keyword from the current ad group to another ad group, use the moveKeyword operation.
For both operations, you may optionally update the Sponsored Search maximum bid for the keyword.
To set the URL of a keyword, use the setKeywordURL operation. This operation provides an easy way to update the URL.
To delete a keyword, use the deleteKeyword and deleteKeywords operations. Once you delete a keyword, you cannot un-delete it (see Deleting Objects).
To get information about a keyword or a list of keywords use the getKeyword and getKeywords operations. To get a list of the keywords in a specific account or ad group, use the getKeywordsByAccountID and getKeywordsByAdGroupID operations.
To determine the status of a keyword, use the getStatusForKeyword operation. To retrieve all of the keywords with a specific status in a specific ad group, use the getKeywordsByAdGroupIDByStatus operation.
To change the status of a keyword, use the updateStatusForKeyword and updateStatusForKeywords operations. You can set the status to On or Off, but not Deleted. To delete a keyword, use the delete keyword operations.
To determine if a keyword is participating in the marketplace (that is, if the keyword is active) use the getKeywordsByAdGroupByParticipatesInMarketplace and getReasonsForKeywordNotParticipatingInMarketplace operations.
To review the Sponsored Search bid status, use the getKeywordsByAdGroupBySponsoredSearchBidStatus.
To determine the Sponsored Search minimum bid, use the getSponsoredSearchMinBidForKeywordString, getSponsoredSearchMinBidForKeywordStrings, and getSponsoredSearchMinBidUpdatesByAdGroupId operations.
Newly created and/or updated keywords are subject to editorial review and are evaluated against Yahoo!'s editorial guidelines. Most keywords are approved within minutes of submission, assuming the keyword does not contain sensitive content. A small number of keywords, however, are submitted for editorial review. This review process can take up to 48 hours to complete. Updates to keywords are subject to the same review process.
To determine the editorial status of a keyword, use the getKeyword and getKeywords operations to retrieve the keyword and then check the value of the editorialStatus element in the Keyword data object (see the Keyword and EditorialStatus data objects).
To retrieve all of the keywords with a specific editorial status in a specific ad group, use the getKeywordsByAdGroupIDByEditorialStatus operation.
If your keyword is not approved, you can update and resubmit it. Use the editorial reason text and, when available, the editorial suggestion text, returned by editorial review as a guide when you make your modifications.
To get the editorial reason codes, use the getEditorialReasonsForKeyword operation. To get the corresponding text, use the getEditorialReasonText operation. Note that there is no operation to return the editorial suggestion text (see Editorial Reason Text and Editorial Suggestion Text ).
When you create a keyword using the addKeyword or addKeywords operations, you have the option to enable the advanced match type for the Sponsored Search (see Setting Tactics).
When you create a keyword, you also have the option to specify a corresponding bid for Sponsored Search (see Setting Bids). If you specify the bid, it will override the Sponsored Search bid set at the ad group level. If you do not specify the bid, the keyword will inherit the Sponsored Search bid set at the ad group level.
To update the bids for existing keywords, use the updateSponsoredSearchMaxBidforKeyword and updateSponsoredSearchMaxBidforKeywords operations. You can also update the bids when you copy or move keywords. To review your bids, use the getKeywordSponsoredSearchMaxBid operation.
Campaign optimization allows you to optimize the spend of a campaign's monthly budget based on the guidelines you set at the campaign, ad group, and keyword levels (see Campaign Optimization).
To set or review optimization guidelines at the keyword level, including the maximum bid limit for Sponsored Search, use the setOptimizationGuidelinesForKeyword and getOptimizationGuidelinesForKeywords operations. Once campagin optimization is enabled, you will not be able to perform cetain keyword operations (see Restricted Actions).
To review the minimum bid for Sponsored Search, use the getSponsoredSearchMinBidForKeywordOptimizationGuidelines operation.