LookSmart® API v4.0 Developer Implementation Guide
  Introduction
  Accounts Service
  Campaigns Service
  Ad Groups Service
  Ads Service
  Keywords Service
  Reports Service
  Geo Locations
Frequently Asked Questions
Implementation Guide

version 3
 

Keyword Service

Developers are encouraged to use the paginated form of reporting methods when possible, as they are more reliable for larger data sets.

WSDL

Keyword Service methods

addKeyword

Creates a new keyword target for an ad. Returns an error if there are validation errors on the KeywordStruct.

Parameters

token String API authentication token
keyword KeywordStruct The keyword target to be added

Response

KeywordStruct A data structure containing the newly created keyword

addKeywords

Creates new keyword targets for an ad. Returns errors if there are validation failures on the KeywordStructs.

Parameters

token String API authentication token
keywords KeywordStruct[] The keyword targets to be added

Response

KeywordStruct[] An array of data structures that contain the newly created keywords

findKeywordForAdGroup

Get info for a keyword target in the specified ad group.

Parameters

token String API authentication token
ad_group_id int The target ad group
keyword String The target keyword

Response

KeywordStruct A data structure containing all keyword information for specified ad group.

findKeywordsForCampaign

Get info for a keyword target across all ad groups in the specified campaign.

Parameters

token String API authentication token
campaign int The system assigned unique ID of the campaign
keyword String The target keyword

Response

KeywordStruct[] An array containing keyword data structures for the specified campaign

getBidLandscape

Get bid landscape information for a given keyword target.

Parameters

token String API authentication token
keyword_id int ID of keyword target for which bid landscape is requested

Response

BidLandscapeStruct An data structure containing bid landscape information for the specified keyword

getBidLandscapesForCampaign

Get bid landscape information for all keyword targets in a given campaign.

Parameters

token String API authentication token
campaign_id int The system assigned unique ID of the campaign

Response

BidLandscapeStruct[] An array of bid landscape data structures for all keywords in the specified campaign

getBidLandscapesForCampaignByPage

Get paginated bid landscape for all keyword targets in the given campaign.

Parameters

token String API authentication token
campaign_id int The system assigned unique ID of the campaign
page int The number of the desired page

Response

BidLandscapeStruct[] An array of bid landscape data structures for all keywords in the specified page and campaign

getKeyword

Get info for a single keyword target.

Parameters

token String API authentication token
keyword_id int The system assigned unique ID of the keyword target

Response

KeywordStruct A data structure containing all keyword information

getKeywords

Retrieve detailed information for the specified keyword targets.

Parameters

token String API authentication token
keywords int[] The IDs of the keyword

Response

KeywordStruct[] An array containing keyword data structures for the specified IDs

getKeywordsForAccount

Get info for all keyword targets in the specified account.

Parameters

token String API authentication token
account_id int The sytem assigned unique ID of the account

Response

KeywordStruct[] An array containing keyword data structures for the specified account

getKeywordsForAccountByPage

Get information for all keyword targets in a specified account broken out by page.

Parameters

token String API authentication token
account_id int The system assigned unique ID of the account
page int The page number

Response

KeywordStruct[] An array containing keyword data structures for the specified page and account

getKeywordForAdGroup

Get info for all keyword targets in the specified ad group.

Parameters

token String API authentication token
ad_group_id int The target ad group

Response

KeywordStruct[] An array containing keyword data structures for the specified ad group

getKeywordsForAdGroupByPage

Get information for all keyword targets in a specified ad group broken out by page.

Parameters

token String API authentication token
ad_group_id int The system assigned unique ID of the account
page int The page number

Response

KeywordStruct[] An array containing keyword data structures for the specified page and ad group

getKeywordsForCampaign

Get info for all keyword targets in the specified campaign.

Parameters

token String API authentication token
campaign int The system assigned unique ID of the campaign

Response

KeywordStruct[] An array containing keyword data structures for the specified campaign

getKeywordsForCampaignByPage

Get information for all keyword targets in a specified campaign broken out by page. Returns an empty set if there are no keywords found for the given campaign and page.

Parameters

token String API authentication token
account_id int The system assigned unique ID of the account
page int The page number

Response

KeywordStruct[] An array containing keyword data structures for the specified page and campaign

getNumBidLandscapePagesForCampaign

Returns the number of pages of bid landscape records for the given campaign.

Parameters

token String API authentication token
campaign_id int The system assigned unique ID of the campaign

Response

int The total number of bid landscape record pages in the campaign

getNumKeywordPagesForAccount

Returns the number of pages of keyword targets in the given account.

Parameters

token String API authentication token
account_id int The system assigned unique ID of the account

Response

int The total number of keyword record pages in the account

getNumKeywordPagesForAdGroup

Returns the number of pages of keyword targets in the given ad group.

Parameters

token String API authentication token
ad_group_id int The system assigned unique ID of the ad group

Response

int The total number of keyword record pages in the ad group

getNumKeywordPagesForCampaign

Returns the number of pages of keyword targets in the given campaign.

Parameters

token String API authentication token
campaign_id int The system assigned unique ID of the campaign

Response

int The total number of keyword record pages in the campaign

getPricingProposal

Get the pricing proposal for the given keyword. Similar to a bid landscape, but for keywords that are not yet targeted.

Parameters

token String API authentication token
keyword String The keyword text

Response

PricingProposalStruct A data structure containing cost and click projections for the specified keyword

getPricingProposals

Get the pricing proposal for the given keyword strings. Similar to a bid landscape, but for keywords that are not yet targeted.

Parameters

token String API authentication token
keywords String[] The list of keywords

Response

PricingProposalStruct[] An array of data structures containing cost and click projections for the specified keywords

updateKeyword

Update keyword target details.

Parameters

token String API authentication token
keyword KeywordStruct An object containing all keyword target fields

Response

KeywordStruct A data structure containing updated keyword information

updateKeywords

Update information for a list of specified keyword targets.

Parameters

token String API authentication token
keywords KeywordStruct[] An array of objects containing all keyword target fields

Response

KeywordStruct[] An array of data structures containing updated keyword information

updateKeywordDestinationUrl

Update destination_url for the given keyword target. All other attributes of the keyword parameter are ignored.

Parameters

token String API authentication token
keyword KeywordStruct An object containing all keyword target fields

Response

KeywordStruct A data structure containing updated keyword information

updateKeywordDestinationUrls

Update destination_url for a list of specified keyword targets. All other attributes of the keywords parameter will be ignored.

Parameters

token String API authentication token
keywords KeywordStruct[] An array of objects containing all keyword target fields

Response

KeywordStruct[] An array of data structures containing updated keyword information

updateKeywordMatchType

Update match_type_id for the given keyword target. All other attributes of the keyword parameter will be ignored.

Parameters

token String API authentication token
keyword KeywordStruct An object containing all keyword target fields

Response

KeywordStruct A data structure containing updated keyword information

updateKeywordMatchTypes

Update match_type_id for a list of specified keyword targets. All other attributes of the keywords parameter will be ignored.

Parameters

token String API authentication token
keywords KeywordStruct[] An array of objects containing all keyword target fields

Response

KeywordStruct[] An array of data structures containing updated keyword information

updateKeywordMaxCpc

Update max_cpc for the specified keyword target. All other attributes of the keyword parameter will be ignored.

Parameters

token String API authentication token
keyword KeywordStruct An object containing all keyword target fields

Response

KeywordStruct A data structure containing updated keyword information

updateKeywordMaxCpcs

Update max_cpc for a list of specified keyword targets. All other attributes of the keywords parameter will be ignored.

Parameters

token String API authentication token
keywords KeywordStruct[] An array of objects containing all keyword target fields

Response

KeywordStruct[] An array of data structures containing updated keyword information

updateKeywordState

Update keyword_state for the specified keyword target. All other attributes of the keyword parameter will be ignored.

Parameters

token String API authentication token
keyword KeywordStruct An object containing all keyword target fields

Response

KeywordStruct A data structure containing updated keyword information

updateKeywordStates

Update keyword_state for a list of specified keyword targets. All other attributes of the keywords parameter will be ignored.

Parameters

token String API authentication token
keywords KeywordStruct[] An array of objects containing all keyword target fields

Response

KeywordStruct[] An array of data structures containing updated keyword information