1.1.1 Summary
Set offer GEO targeting information.
 
1.1.2 Request
Request Method: POST
Parameters:
 
Parameter
Description
Type
Data Range
key
Network API Key;
*Required
string
 

POST Parameters:
Parameter
Description
Type
Data Range
id
Offer ID
*Required
Int
 
geo_targeting
Enable/Disable GEO Targeting for the Offer。
*Required
The subsequent param is not required if disable it
int
1: enable
0: disable
type
Include Country or Exclude Country
Int
1: include
0: exclude
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.
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
redirect_type
Redirect to GEO group or offer:
1: to GEO Group
0: to Offer
Int
1
0
redirect_target_id
GEO Group ID  or Offer ID  redirecting to
Int
 
 
1.1.3 Response
Header:
 
HTTP Status
Object
Description
Error Code
202
 
Success
0
400
Parameter
Invalid Parameter
63XX
 
Content Format: JSON
Response sample:  Same as “getOfferById” API.
 
 
1.1.4 Example
Sample Request URL:
http://{your_network_domain}/api/v1/setOfferGeoInfo?key=603E3F0E3266
 
POST DATA
 
{
"id": 12,
  "geo_targeting": 1,
  " type": 1,
  "countries[0]": "US:1:TX;CA",
"countries[1]": "CA:0:BS;SK",
"enforce": 1,
"redirect_type": 0,
"redirect_target_id": ""
}
 
Response sample: Same as “getOfferById” API.