{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Campaign Definition","type":"basic","slug":"campaign-definition","excerpt":"","body":"Campaigns returned by the Tophatter Merchant API have the following fields:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Name\",\n    \"0-0\": \"`name`\",\n    \"0-1\": \"Name of the campaign\",\n    \"1-0\": \"`type`\",\n    \"1-1\": \"Type of the campaign. Lists of campaign type are listed [here](http://google.com).\",\n    \"2-0\": \"`daily_budget`\",\n    \"3-0\": \"`bid_amount`\",\n    \"5-0\": \"`daily_budget_per_product`\",\n    \"6-0\": \"`lifetime_budget`\",\n    \"7-0\": \"`lifetime_budget_per_product`\",\n    \"8-0\": \"`amount_cashback_percent`\",\n    \"2-1\": \"The daily budget of a campaign\",\n    \"5-1\": \"Daily budget of a campaign per product\",\n    \"3-1\": \"The SFB fee of a campaign\",\n    \"6-1\": \"Lifetime budget of a campaign\",\n    \"7-1\": \"Lifetime budget of a campaign per product\",\n    \"8-1\": \"Offer rebate credits when buyers purchase your product. Bonus credits can be: [2, 4, 6, 8, 10]\",\n    \"4-0\": \"`status`\",\n    \"4-1\": \"Status of a campaign. List of campaign status are listed [here](http://google.com).\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Examples\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[\\n    {\\n        \\\"name\\\": \\\"$0.1\\\",\\n        \\\"type\\\": \\\"AuctionCampaign\\\",\\n        \\\"daily_budget\\\": 500.0,\\n        \\\"bid_amount\\\": 0.1,\\n        \\\"status\\\": \\\"Active\\\",\\n        \\\"daily_budget_per_product\\\": null,\\n        \\\"lifetime_budget\\\": null,\\n        \\\"lifetime_budget_per_product\\\": null\\n    },\\n    {\\n        \\\"name\\\": \\\"$0.2\\\",\\n        \\\"type\\\": \\\"AuctionCampaign\\\",\\n        \\\"daily_budget\\\": 100000000.0,\\n        \\\"bid_amount\\\": 0.2,\\n        \\\"status\\\": \\\"Active\\\",\\n        \\\"daily_budget_per_product\\\": null,\\n        \\\"lifetime_budget\\\": 100000000.0,\\n        \\\"lifetime_budget_per_product\\\": null\\n    },\\n    {\\n        \\\"name\\\": \\\"New Product Extended Promotional Campaign\\\",\\n        \\\"type\\\": \\\"AuctionCampaign\\\",\\n        \\\"daily_budget\\\": 5000.0,\\n        \\\"bid_amount\\\": 1.7,\\n        \\\"status\\\": \\\"Expired\\\",\\n        \\\"daily_budget_per_product\\\": null,\\n        \\\"lifetime_budget\\\": null,\\n        \\\"lifetime_budget_per_product\\\": null\\n    },\\n    {\\n        \\\"name\\\": \\\"Pre-Buy\\\",\\n        \\\"type\\\": \\\"AuctionCampaign\\\",\\n        \\\"daily_budget\\\": 100.0,\\n        \\\"bid_amount\\\": 0.01,\\n        \\\"status\\\": \\\"Active\\\",\\n        \\\"daily_budget_per_product\\\": null,\\n        \\\"lifetime_budget\\\": 100.0,\\n        \\\"lifetime_budget_per_product\\\": null\\n    },\\n    {\\n        \\\"name\\\": \\\"test1.0\\\",\\n        \\\"type\\\": \\\"AuctionCampaign\\\",\\n        \\\"daily_budget\\\": 2.0,\\n        \\\"bid_amount\\\": 0.01,\\n        \\\"status\\\": \\\"Paused\\\",\\n        \\\"daily_budget_per_product\\\": 1.0,\\n        \\\"lifetime_budget\\\": 12.0,\\n        \\\"lifetime_budget_per_product\\\": 12.0\\n    }\\n]\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Campaign Status\"\n}\n[/block]\nList of campaign status\n- `active`: The campaign is currently enabled and available to be scheduled\n- `paused`: The campaign is paused\n- `expired`: The campaign is expired\n\n[block:api-header]\n{\n  \"title\": \"Campaign Type\"\n}\n[/block]\nCampaigns will have one of the following types\n- `AuctionCampaign`: Sets the campaign in Auction lots\n- `ReminderCampaign`: Sets the campaign in Reminder\n- `BuyNowCampaign`: Sets the campaign in Buy Now","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e7c710da371220048e2d909","createdAt":"2020-03-26T09:08:29.005Z","user":"567f0baca74a1c0d003e1fba","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Campaigns","slug":"account","order":4,"from_sync":false,"reference":false,"_id":"5c64c200244bda003204b97f","project":"567f0c06143cc60d00c1fdbe","version":"567f0c06143cc60d00c1fdc1","createdAt":"2019-02-14T01:18:56.582Z","__v":1},"version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["567f0c07143cc60d00c1fdc2","56a9783109cb9c0d00f0c7d3","56a97837f834950d0037b363","56a9783b2d8fd90d0036eed6","56a979912d8fd90d0036eed8","5834b5691a80690f00d31faf","5834b5e4f775120f00c45f9d","5bf1a1473031e4005075ae14","5c64c200244bda003204b97f"],"_id":"567f0c06143cc60d00c1fdc1","__v":9,"createdAt":"2015-12-26T21:52:06.734Z","releaseDate":"2015-12-26T21:52:06.734Z","project":"567f0c06143cc60d00c1fdbe"},"project":"567f0c06143cc60d00c1fdbe","__v":0,"parentDoc":null}

Campaign Definition


Campaigns returned by the Tophatter Merchant API have the following fields: [block:parameters] { "data": { "h-0": "Field", "h-1": "Name", "0-0": "`name`", "0-1": "Name of the campaign", "1-0": "`type`", "1-1": "Type of the campaign. Lists of campaign type are listed [here](http://google.com).", "2-0": "`daily_budget`", "3-0": "`bid_amount`", "5-0": "`daily_budget_per_product`", "6-0": "`lifetime_budget`", "7-0": "`lifetime_budget_per_product`", "8-0": "`amount_cashback_percent`", "2-1": "The daily budget of a campaign", "5-1": "Daily budget of a campaign per product", "3-1": "The SFB fee of a campaign", "6-1": "Lifetime budget of a campaign", "7-1": "Lifetime budget of a campaign per product", "8-1": "Offer rebate credits when buyers purchase your product. Bonus credits can be: [2, 4, 6, 8, 10]", "4-0": "`status`", "4-1": "Status of a campaign. List of campaign status are listed [here](http://google.com)." }, "cols": 2, "rows": 9 } [/block] [block:api-header] { "title": "Examples" } [/block] [block:code] { "codes": [ { "code": "[\n {\n \"name\": \"$0.1\",\n \"type\": \"AuctionCampaign\",\n \"daily_budget\": 500.0,\n \"bid_amount\": 0.1,\n \"status\": \"Active\",\n \"daily_budget_per_product\": null,\n \"lifetime_budget\": null,\n \"lifetime_budget_per_product\": null\n },\n {\n \"name\": \"$0.2\",\n \"type\": \"AuctionCampaign\",\n \"daily_budget\": 100000000.0,\n \"bid_amount\": 0.2,\n \"status\": \"Active\",\n \"daily_budget_per_product\": null,\n \"lifetime_budget\": 100000000.0,\n \"lifetime_budget_per_product\": null\n },\n {\n \"name\": \"New Product Extended Promotional Campaign\",\n \"type\": \"AuctionCampaign\",\n \"daily_budget\": 5000.0,\n \"bid_amount\": 1.7,\n \"status\": \"Expired\",\n \"daily_budget_per_product\": null,\n \"lifetime_budget\": null,\n \"lifetime_budget_per_product\": null\n },\n {\n \"name\": \"Pre-Buy\",\n \"type\": \"AuctionCampaign\",\n \"daily_budget\": 100.0,\n \"bid_amount\": 0.01,\n \"status\": \"Active\",\n \"daily_budget_per_product\": null,\n \"lifetime_budget\": 100.0,\n \"lifetime_budget_per_product\": null\n },\n {\n \"name\": \"test1.0\",\n \"type\": \"AuctionCampaign\",\n \"daily_budget\": 2.0,\n \"bid_amount\": 0.01,\n \"status\": \"Paused\",\n \"daily_budget_per_product\": 1.0,\n \"lifetime_budget\": 12.0,\n \"lifetime_budget_per_product\": 12.0\n }\n]", "language": "json" } ] } [/block] [block:api-header] { "title": "Campaign Status" } [/block] List of campaign status - `active`: The campaign is currently enabled and available to be scheduled - `paused`: The campaign is paused - `expired`: The campaign is expired [block:api-header] { "title": "Campaign Type" } [/block] Campaigns will have one of the following types - `AuctionCampaign`: Sets the campaign in Auction lots - `ReminderCampaign`: Sets the campaign in Reminder - `BuyNowCampaign`: Sets the campaign in Buy Now