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
 

CampaignStruct

NOTE: The Campaign Service will reject any add or update method call where one or more validations fail.

Name Type Description
ad_rotation_type_id int The ID of the desired ad rotation type. Values are restricted to
  • 0 - CTR Optimized. Displays the best performing ads on a CTR basis more frequently.
  • 1 - Equally Rotated. Display ad variations on an even basis.
  • 2 - SmartRotation. Displays the best performing ad on a CPA basis more frequently.
account_id int The ID of the account to which this campaign belongs. When used to create or update a campaign, account_id has the following validations:
  • account_id must exist and be authorized for write access by the user associated with token
  • account_id cannot be changed in a campaign.
budget double Maximum daily budget to be spent on all ads in this campaign. When used to create or update a campaign, budget has the following validations:
  • budget cannot be greater than $40,000.00.
  • budget cannot be greater than the credit limit set for the account (if invoice).
  • budget must be greater than max_cpc.
  • budget must be greater than or equal to $0.05.
campaign_id int Assigned by the system when campaign is created. The campaign_id must exist for record updates.
campaign_state String The state of the specified campaign.

Available states: on or off

description String Campaign description. When used to create or update a campaign, description may have no more than 500 characters but may be null.
end_date Date Campaign end date. Use January 1, 1970 for null. When used to create or update a campaign, end_date has the following validations:
  • end_date must be greater than or equal to start_date if start_date is not null.
  • end_date must be greater than or equal to today's date.
  • end_date must be a valid date (January 1, 1970 can be substituted for null).
max_cpc double Campaign level max cpc. Keyword targets with no max cpc inherit this value. When used to create or update a campaign, max_cpc has the following validations:
  • max_cpc cannot be less than $0.01.
  • max_cpc cannot be greater than $20.00.
  • max_cpc must not be null.
name String The name of the campaign. When used to create or update a campaign, name must be between 1 and 100 characters.
reference_number String Campaign reference number from client’s order management system. Not required.
start_date Date Campaign start date. If start_date is greater than today's date, campaign_state is set to off until start_date. Use January 1, 1970 for null, if necessary. When used to create or update a campaign, start_date has the following validations:
  • start_date must be a valid date (January 1, 1970 can be substituted for null).
  • start_date must be greater than or equal to today's date. If set to Today's date, the system will change start_date to null automatically.