setOffer
1.1.1 Summary
Create offer information.1.1.2 Request
Request Method: POSTQuery String Parameters:
Parameter | Description | Type | Data Range |
key |
Network API Key; *Required |
string |
POST Parameters:
Parameter | Description | Type | Data Range | System Version | ||
id | *Required for Updating | Int | Single Value | 1.0+ | ||
advertiser_id |
Advertiser ID *Required for Creating |
int | Single Value | 1.0+ | ||
name |
Offer Name *Required for Creating |
String | 1.0+ | |||
status |
Offer Status *Required for Creating |
String |
Archived, Active, Pending, Paused, Expired |
1.0+ | ||
expire_date |
Offer Expire Date YYYY/MM/DD HH *Required for Creating |
String | 1.0+ | |||
type |
Offer Type *Required for Creating |
String |
Desktop, Mobile, Tablet |
1.0+ | ||
conversion_point |
Offer Conversion Action Description |
String |
Email Submit, DOI, SOI, Download and Install, Sale Offer/Credit Required, SMS Confirmation, PIN-Submit |
|||
preview_url |
Offer Page Preview URL | String | 1.0+ | |||
url |
Offer URL Must Contains “{TID}” *Required for Creating |
String | 1.0+ | |||
access_type |
Offer Access Type *Required for Creating |
String |
Private, Public, Need Approval |
1.0+ | ||
ssl |
Need SSL Certification to Receive Conversion *Required for Creating |
Int |
0, 1 |
1.0+ | ||
tracking_protocol |
Conversion Method *Required for Creating |
String |
Server Postback URL, iFrame Pixel, Image Pixel |
1.0+ | ||
currency |
Offer Currency See Fuseclick On-line Documentaion *Required for Creating |
Int | 1~68 | 1.0+ | ||
price_model |
Deprecated since 1.3. Payout Price Model. Use payout_type |
String |
CPA, CPC, CPS, CPI, CPA+CPS |
1.0-1.3 | ||
payout_type |
Payout Price Model *Required for Creating |
String |
CPA, CPC, CPS, CPI, CPA+CPS |
1.4+ | ||
payout |
Payout | Float | 1.0+ | |||
payout_percent |
Payout Percent of Sale Amount | Float | 0~100 | 1.0+ | ||
revenue_type |
Revenue Price Model |
String |
RPA, RPC, RPS, RPI, RPA+RPS |
1.0+ | ||
revenue |
Revenue | Float | 1.0+ | |||
revenue_percent |
Revenue Percent of Sale Amount | Float | 0~100 | 1.0+ | ||
need_security_token |
Need Security Token to Receive Conversion | Int |
0, 1 |
1.0+ | ||
force_unique |
Need Unique Click to Limit Conversion | Int |
0, 1 |
1.0+ | ||
session_lifespan |
Click Session Lifespan *Required for Creating |
String |
1 Day, 1 Week, 2 Weeks, 1 Month |
1.0+ | ||
hide_referrer | Need Hide Referrer | Int |
0, 1 |
1.0+ | ||
secondary_offer |
Secondary Offer ID | Int | ||||
description |
Offer Description | String | 1.0+ | |||
restriction |
Offer Restriction | String | 1.0+ | |||
has_cap_limit |
Enable/Disable CAP for the Offer CAP is not required when the value is ‘0’ *Required |
int |
1: enable 0: disable |
1.0+ | ||
cap_type |
Budget or Conversion |
String |
Budget Conversion |
1.0+ | ||
cap_overall_limit | Offer Overall CAP | Number |
> 0 -1: unlimited |
1.0+ | ||
cap_interval | The cap interval of Offer | String |
Daily Weekly Monthly |
1.0+ | ||
cap_interval_limit | Limit value of cap interval of Offer | Number |
> 0 -1: unlimited |
1.0+ | ||
cap_affiliate_overall_limit | Offer’s total cap for a single Affiliate | Number |
> 0 -1: unlimited |
1.0+ | ||
cap_affiliate_interval | Offer’s cap interval for a single Affiliate | String |
Daily Weekly Monthly |
1.0+ | ||
cap_affiliate_interval_limit | limit value of cap interval of Offer for a single Affiliate | Number |
> 0 -1: unlimited |
1.0+ | ||
device_targeting |
Enable/Disable Device Targeting for the Offer。 The subsequent param is not required if it is disable *Required |
int |
1: enable 0: disable |
1.0+ | ||
device_rules[] |
Device rule string array: Each Device rule string has three parts to make up a string, which includes enable/disable, param name and parameter list. Each string uses colons as delimiter. If the param list contains multiple params, use semicolon to separate them. Example: “1:OS:iOS;Windows phone” means allowed Device OS types are iOS and windows phone. |
Array of String | 1.0+ | |||
device_redirect_offer_id | Redirect Offer ID . | Int | 1.0+ | |||
geo_targeting |
Enable/Disable GEO Targeting for the Offer。 *Required The subsequent param is not required if disable it |
int |
1: enable 0: disable |
1.0+ | ||
geo_type | Include Country or Exclude Country | Int |
1: include 0: exclude |
1.0+ | ||
geo_countries[?] |
Country-Region string array: Each Country-Region string has three parts to make up a string, which includes country, including/excluding and region list and seperates with a colon. If the region list contains multiple regions, use semicolon to separate them. Example: “US:1:TX;CA” means allowing the traffic from region Texas, California in Unitied States; “CA:0:BS;SK” means excluding the traffic from region BS, SK in Canada. |
Array | Please refer to Dictionary for country and region codes. | 1.0+ | ||
geo_enforce |
Enforce to Enable/Disable GEO Rule: Set 1, out of GEO traffic will be directed to redirect target(redirected offer or redirected offer group); Set 0, out of GEO traffic can still reach this Offer |
Int |
1: ON 0: OFF |
1.0+ | ||
geo_redirect_type |
Redirect to GEO group or offer: 1: to GEO Group 0: to Offer |
Int |
1 0 |
1.0+ | ||
geo_redirect_target_id | GEO Group ID or Offer ID redirecting to | Int | 1.0+ |
1.1.3 Response
Header:HTTP Status | Object | Description | Error Code |
201 | Created Successfully | 0 | |
202 | Updated Successfully | 0 | |
400 | Parameter | Invalid Parameters | 63XX |
Content Format: JSON
1.1.4 Example
Sample Request URL:http://{your_network_domain}/api/v1/setOffer?key=603E3F0E3266E
(POST Data)
Response sample:
{ "httpStatus": 200, "data": [ { "id": "12", "name": "testoffer12", "create_date": "2015/02/13", "expire_date": "2015/02/26", "status": "Active", "type": "Tablet", "url": "http://6.cn?tid={TID}", "preview_url": "http://6.cn", "tracking_protocol": "Image Pixel", "ssl": "No", "conversion_point": "", "currency": " United States, Dollars", "price_model": "CPA", "payout_type": "CPA", "revenue_type": "RPC", "logo": "", "screenshot": "", "description": "", "restriction": "", "access_type": "Public", "session_lifespan": null, "hide_referrer": "Yes", "enable_geo_targeting": "Yes", "geo_type": "Include", "geo_countries": "CN;NP", "enable_device_targeting": "Yes", "categories": [ { "category_id": "1", "category_name": "Game" } ], "allow_traffics": [ { "traffic_id": 1, "traffic_name": "Banner" }, { "traffic_id": 2, "traffic_name": "Email" }, { "traffic_id": 3, "traffic_name": "Facebook" }, { "traffic_id": 4, "traffic_name": "Google" } ], "geo_redirect_type": "Offer", "geo_states": [ "CN:1:53;54", "NP:0:3;1" ], "device_rules": [ "1:OS:iOS;Windows phone" ], "advertiser_id": "4", "payout": "8", "revenue": "9", "secondary_offer": "", "force_unique": "No", "need_security_token": "No", "enable_payout_tier": "Yes", "has_cap_limit": "Yes", "cap_type": "conversion", "cap_overall_limit": "100", "cap_interval": "Daily", "cap_interval_limit": "50", "cap_affiliate_overall_limit": "40", "cap_affiliate_interval": "Daily", "cap_affiliate_interval_limit": "20", "geo_enforce": "Enable", "geo_redirect_offer": "11", "geo_redirect_group": "", "device_redirect_offer": "11", "click_count": 0, "last_click_time": "", "conversion_count": 0, "last_conversion_time": "", "test_click_count": 0, "last_test_click_time": "", "test_conversion_count": 0, "last_test_conversion_time": 0, "tier_payout": [ { "tier_id": 1, "payout": "100" }, { "tier_id": 2, "payout": "200" }, { "tier_id": 3, "payout": "300" } ], "events": [ { "id": "294", "e_id": "1", "event_name": "InitialEvent", "e_tkn": "", "pre_event_id": "-1", "description": "", "status": "Active", "tracking_method": "iFrame Pixel", "is_end_point": "False", "revenue_type": "RPA", "payout_type": "CPA", "is_private": "False", "revenue": "7.000", "payout": "2.000", "can_multiply_conversion": "False", "need_approval": "No", "conversion_point": "PIN-Submit" } ] } ], "errorCode": 0, "message": "" } |
Close All
API V3
API V2
-
User - Network
-
User - Affiliate
-
Offer
-
Report
-
-
User - Advertiser
-
offer
-
Dictionary
API V1 (DEPRECATED)