POST api/Feed?systemName={systemName}&username={username}&password={password}
Creates a new feed
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
systemName | string |
Required |
|
username | string |
Required |
|
password | string |
Required |
Body Parameters
APIFeedName | Description | Type | Additional information |
---|---|---|---|
Id |
Unique identifier |
integer |
None. |
ProviderId |
Unique identifier of provider to which this feed belongs |
integer |
None. |
State |
Status: Active, Closed or Suspended |
string |
None. |
Description |
Textual description |
string |
None. |
MatchBasis |
Basis used for matching keyword bids: Exact, Phrase or Broad |
string |
None. |
RedirectorId |
Unique identifier of redirector to use or zero to use default |
integer |
None. |
CreationTimestamp |
Timestamp when this was created |
string |
None. |
StartTimestamp |
Timestamp from whence this becomes active |
string |
None. |
EndTimestamp |
Timestamp until which this remains active |
string |
None. |
FeedDiscountPercentage |
Discount percentage to be applied to prices |
decimal number |
None. |
IgnoreContraRevenuePercentage |
Ignore percentage adjustment for charges and refunds |
boolean |
None. |
PostImpressionFrequencyDuration |
Frequency capping duration applied after an impression |
integer |
None. |
PostImpressionFrequencyCap |
Frequency capping limit applied after an impression |
integer |
None. |
PostImpressionInterval |
Frequency capping interval applied after an impression |
integer |
None. |
PostClickFrequencyDuration |
Frequency capping duration applied after a click |
integer |
None. |
PostClickFrequencyCap |
Frequency capping limit applied after a click |
integer |
None. |
PostClickInterval |
Frequency capping interval applied after a click |
integer |
None. |
ManuallyHalted |
Denotes that this has been manually paused |
boolean |
None. |
MinimumImpressionPrice |
Minimum impression price for adverts |
decimal number |
None. |
MinimumClickPrice |
Minimum click price for adverts |
decimal number |
None. |
ImpressionPrice |
Default impression price |
decimal number |
None. |
ClickPrice |
Default click price |
decimal number |
None. |
DailyExpenditureLimit |
Maximum spend amount per day |
decimal number |
None. |
DailyExpenditureDisableRollover |
Denotes that any unspent funds from daily limit should not be carried forward |
boolean |
None. |
DailySearchLimit |
Maximum number of searches per day |
integer |
None. |
DailySearchDisableRollover |
Denotes that any unused searches from daily limit should not be carried forward |
boolean |
None. |
DailyImpressionLimit |
Maximum number of impressions per day |
integer |
None. |
DailyImpressionDisableRollover |
Denotes that any unused impressions from daily limit should not be carried forward |
boolean |
None. |
DailyClickLimit |
Maximum number of clicks per day |
integer |
None. |
DailyClickDisableRollover |
Denotes that any unused clicks from daily limit should not be carried forward |
boolean |
None. |
MonthlyExpenditureLimit |
Maximum spend per month |
decimal number |
None. |
MonthlySearchLimit |
Maximum number of searches per month |
integer |
None. |
MonthlyImpressionLimit |
Maximum number of impressions per month |
integer |
None. |
MonthlyClickLimit |
Maximum number of clicks per month |
integer |
None. |
FirstSecondOfDay |
First second of day from whence this becomes active |
integer |
None. |
LastSecondOfDay |
Last second of day until which this remains active |
integer |
None. |
FirstDayOfWeek |
First day of week from whence this becomes active |
integer |
None. |
LastDayOfWeek |
Last day of week until which this remains active |
integer |
None. |
FirstDayOfMonth |
First day of month from whence this becomes active |
integer |
None. |
LastDayOfMonth |
Last day of month until which this remains active |
integer |
None. |
FirstSecondOfDay2 |
First second of day from whence this becomes active |
integer |
None. |
LastSecondOfDay2 |
Last second of day until which this remains active |
integer |
None. |
FirstDayOfWeek2 |
First day of week from whence this becomes active |
integer |
None. |
LastDayOfWeek2 |
Last day of week until which this remains active |
integer |
None. |
FirstDayOfMonth2 |
First day of month from whence this becomes active |
integer |
None. |
LastDayOfMonth2 |
Last day of month until which this remains active |
integer |
None. |
ClickFraudAlgorithm |
Disabled, Guid, IpAddress, GuidAndIpAddress |
string |
None. |
RefererMissingSearchFilter |
Enabled, Disabled or Inherit |
string |
None. |
UseragentMissingSearchFilter |
Enabled, Disabled or Inherit |
string |
None. |
IPIntelligenceSearchFilter |
Enabled, Disabled or Inherit |
string |
None. |
RefererMissingClickFilter |
Enabled, Disabled or Inherit |
string |
None. |
UseragentMissingClickFilter |
Enabled, Disabled or Inherit |
string |
None. |
RefererMismatchClickFilter |
Enabled, Disabled or Inherit |
string |
None. |
UseragentMismatchClickFilter |
Enabled, Disabled or Inherit |
string |
None. |
IPAddressMismatchClickFilter |
Enabled, Disabled or Inherit |
string |
None. |
PartialIPAddressMismatchClickFilter |
Enabled, Disabled or Inherit |
string |
None. |
CookiesNotEnabledClickFilter |
Enabled, Disabled or Inherit |
string |
None. |
ClickPositionMissingClickFilter |
Enabled, Disabled or Inherit |
string |
None. |
ClickPositionOffScreenClickFilter |
Enabled, Disabled or Inherit |
string |
None. |
AutomatedCrawlerClickFilter |
Enabled, Disabled or Inherit |
string |
None. |
WindowTooSmallClickFilter |
Enabled, Disabled or Inherit |
string |
None. |
MinimumWindowPercentage |
Minimum window percentage for clicks |
integer |
None. |
ConfidenceClickFilter |
Enabled, Disabled or Inherit |
string |
None. |
ConfidenceThreshold |
Minimum confidence threshold for clicks |
integer |
None. |
MaximumSearchToImpressionFilter |
Enabled, Disabled or Inherit |
string |
None. |
MaximumSearchToImpressionInterval |
Maximum time in seconds between search and impression |
integer |
None. |
MinimumSearchToClickFilter |
Enabled, Disabled or Inherit |
string |
None. |
MinimumSearchToClickInterval |
Minimum time in seconds between search and click |
integer |
None. |
MaximumSearchToClickFilter |
Enabled, Disabled or Inherit |
string |
None. |
MaximumSearchToClickInterval |
Maximum time in seconds between search and click |
integer |
None. |
MinimumClickToClickFilter |
Enabled, Disabled or Inherit |
string |
None. |
MinimumClickToClickInterval |
Minimum time in seconds between clicks |
integer |
None. |
MaximumSearchClicksFilter |
Enabled, Disabled or Inherit |
string |
None. |
MaximumSearchClicks |
Maximum number of clicks per search |
integer |
None. |
MaximumResultClicksFilter |
Enabled, Disabled or Inherit |
string |
None. |
MaximumResultClicks |
Maximum number of clicks per result |
integer |
None. |
MaximumAdvertClicksFilter |
Enabled, Disabled or Inherit |
string |
None. |
MaximumAdvertClicks |
Maximum number of clicks per advert |
integer |
None. |
MaximumOverallClicksFilter |
Enabled, Disabled or Inherit |
string |
None. |
MaximumOverallClicks |
Maximum number of clicks overall |
integer |
None. |
Request Formats
application/json, text/json
{ "id": 1, "providerId": 2, "state": "sample string 3", "description": "sample string 4", "matchBasis": "sample string 5", "redirectorId": 1, "creationTimestamp": "sample string 6", "startTimestamp": "sample string 7", "endTimestamp": "sample string 8", "feedDiscountPercentage": 1.1, "ignoreContraRevenuePercentage": true, "postImpressionFrequencyDuration": 1, "postImpressionFrequencyCap": 1, "postImpressionInterval": 1, "postClickFrequencyDuration": 1, "postClickFrequencyCap": 1, "postClickInterval": 1, "manuallyHalted": true, "minimumImpressionPrice": 1.1, "minimumClickPrice": 1.1, "impressionPrice": 1.1, "clickPrice": 1.1, "dailyExpenditureLimit": 1.1, "dailyExpenditureDisableRollover": true, "dailySearchLimit": 1, "dailySearchDisableRollover": true, "dailyImpressionLimit": 1, "dailyImpressionDisableRollover": true, "dailyClickLimit": 1, "dailyClickDisableRollover": true, "monthlyExpenditureLimit": 1.1, "monthlySearchLimit": 1, "monthlyImpressionLimit": 1, "monthlyClickLimit": 1, "firstSecondOfDay": 1, "lastSecondOfDay": 1, "firstDayOfWeek": 1, "lastDayOfWeek": 1, "firstDayOfMonth": 1, "lastDayOfMonth": 1, "firstSecondOfDay2": 1, "lastSecondOfDay2": 1, "firstDayOfWeek2": 1, "lastDayOfWeek2": 1, "firstDayOfMonth2": 1, "lastDayOfMonth2": 1, "clickFraudAlgorithm": "sample string 9", "refererMissingSearchFilter": "sample string 10", "useragentMissingSearchFilter": "sample string 11", "ipIntelligenceSearchFilter": "sample string 12", "refererMissingClickFilter": "sample string 13", "useragentMissingClickFilter": "sample string 14", "refererMismatchClickFilter": "sample string 15", "useragentMismatchClickFilter": "sample string 16", "ipAddressMismatchClickFilter": "sample string 17", "partialIPAddressMismatchClickFilter": "sample string 18", "cookiesNotEnabledClickFilter": "sample string 19", "clickPositionMissingClickFilter": "sample string 20", "clickPositionOffScreenClickFilter": "sample string 21", "automatedCrawlerClickFilter": "sample string 22", "windowTooSmallClickFilter": "sample string 23", "minimumWindowPercentage": 1, "confidenceClickFilter": "sample string 24", "confidenceThreshold": 1, "maximumSearchToImpressionFilter": "sample string 25", "maximumSearchToImpressionInterval": 1, "minimumSearchToClickFilter": "sample string 26", "minimumSearchToClickInterval": 1, "maximumSearchToClickFilter": "sample string 27", "maximumSearchToClickInterval": 1, "minimumClickToClickFilter": "sample string 28", "minimumClickToClickInterval": 1, "maximumSearchClicksFilter": "sample string 29", "maximumSearchClicks": 1, "maximumResultClicksFilter": "sample string 30", "maximumResultClicks": 1, "maximumAdvertClicksFilter": "sample string 31", "maximumAdvertClicks": 1, "maximumOverallClicksFilter": "sample string 32", "maximumOverallClicks": 1 }
application/xml, text/xml
<APIFeed xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models"> <AutomatedCrawlerClickFilter>sample string 22</AutomatedCrawlerClickFilter> <ClickFraudAlgorithm>sample string 9</ClickFraudAlgorithm> <ClickPositionMissingClickFilter>sample string 20</ClickPositionMissingClickFilter> <ClickPositionOffScreenClickFilter>sample string 21</ClickPositionOffScreenClickFilter> <ClickPrice>1.1</ClickPrice> <ConfidenceClickFilter>sample string 24</ConfidenceClickFilter> <ConfidenceThreshold>1</ConfidenceThreshold> <CookiesNotEnabledClickFilter>sample string 19</CookiesNotEnabledClickFilter> <CreationTimestamp>sample string 6</CreationTimestamp> <DailyClickDisableRollover>true</DailyClickDisableRollover> <DailyClickLimit>1</DailyClickLimit> <DailyExpenditureDisableRollover>true</DailyExpenditureDisableRollover> <DailyExpenditureLimit>1.1</DailyExpenditureLimit> <DailyImpressionDisableRollover>true</DailyImpressionDisableRollover> <DailyImpressionLimit>1</DailyImpressionLimit> <DailySearchDisableRollover>true</DailySearchDisableRollover> <DailySearchLimit>1</DailySearchLimit> <Description>sample string 4</Description> <EndTimestamp>sample string 8</EndTimestamp> <FeedDiscountPercentage>1.1</FeedDiscountPercentage> <FirstDayOfMonth>1</FirstDayOfMonth> <FirstDayOfMonth2>1</FirstDayOfMonth2> <FirstDayOfWeek>1</FirstDayOfWeek> <FirstDayOfWeek2>1</FirstDayOfWeek2> <FirstSecondOfDay>1</FirstSecondOfDay> <FirstSecondOfDay2>1</FirstSecondOfDay2> <IPAddressMismatchClickFilter>sample string 17</IPAddressMismatchClickFilter> <IPIntelligenceSearchFilter>sample string 12</IPIntelligenceSearchFilter> <Id>1</Id> <IgnoreContraRevenuePercentage>true</IgnoreContraRevenuePercentage> <ImpressionPrice>1.1</ImpressionPrice> <LastDayOfMonth>1</LastDayOfMonth> <LastDayOfMonth2>1</LastDayOfMonth2> <LastDayOfWeek>1</LastDayOfWeek> <LastDayOfWeek2>1</LastDayOfWeek2> <LastSecondOfDay>1</LastSecondOfDay> <LastSecondOfDay2>1</LastSecondOfDay2> <ManuallyHalted>true</ManuallyHalted> <MatchBasis>sample string 5</MatchBasis> <MaximumAdvertClicks>1</MaximumAdvertClicks> <MaximumAdvertClicksFilter>sample string 31</MaximumAdvertClicksFilter> <MaximumOverallClicks>1</MaximumOverallClicks> <MaximumOverallClicksFilter>sample string 32</MaximumOverallClicksFilter> <MaximumResultClicks>1</MaximumResultClicks> <MaximumResultClicksFilter>sample string 30</MaximumResultClicksFilter> <MaximumSearchClicks>1</MaximumSearchClicks> <MaximumSearchClicksFilter>sample string 29</MaximumSearchClicksFilter> <MaximumSearchToClickFilter>sample string 27</MaximumSearchToClickFilter> <MaximumSearchToClickInterval>1</MaximumSearchToClickInterval> <MaximumSearchToImpressionFilter>sample string 25</MaximumSearchToImpressionFilter> <MaximumSearchToImpressionInterval>1</MaximumSearchToImpressionInterval> <MinimumClickPrice>1.1</MinimumClickPrice> <MinimumClickToClickFilter>sample string 28</MinimumClickToClickFilter> <MinimumClickToClickInterval>1</MinimumClickToClickInterval> <MinimumImpressionPrice>1.1</MinimumImpressionPrice> <MinimumSearchToClickFilter>sample string 26</MinimumSearchToClickFilter> <MinimumSearchToClickInterval>1</MinimumSearchToClickInterval> <MinimumWindowPercentage>1</MinimumWindowPercentage> <MonthlyClickLimit>1</MonthlyClickLimit> <MonthlyExpenditureLimit>1.1</MonthlyExpenditureLimit> <MonthlyImpressionLimit>1</MonthlyImpressionLimit> <MonthlySearchLimit>1</MonthlySearchLimit> <PartialIPAddressMismatchClickFilter>sample string 18</PartialIPAddressMismatchClickFilter> <PostClickFrequencyCap>1</PostClickFrequencyCap> <PostClickFrequencyDuration>1</PostClickFrequencyDuration> <PostClickInterval>1</PostClickInterval> <PostImpressionFrequencyCap>1</PostImpressionFrequencyCap> <PostImpressionFrequencyDuration>1</PostImpressionFrequencyDuration> <PostImpressionInterval>1</PostImpressionInterval> <ProviderId>2</ProviderId> <RedirectorId>1</RedirectorId> <RefererMismatchClickFilter>sample string 15</RefererMismatchClickFilter> <RefererMissingClickFilter>sample string 13</RefererMissingClickFilter> <RefererMissingSearchFilter>sample string 10</RefererMissingSearchFilter> <StartTimestamp>sample string 7</StartTimestamp> <State>sample string 3</State> <UseragentMismatchClickFilter>sample string 16</UseragentMismatchClickFilter> <UseragentMissingClickFilter>sample string 14</UseragentMissingClickFilter> <UseragentMissingSearchFilter>sample string 11</UseragentMissingSearchFilter> <WindowTooSmallClickFilter>sample string 23</WindowTooSmallClickFilter> </APIFeed>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
integerResponse Formats
application/json, text/json
1
application/xml, text/xml
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>