Affiliate API

1. Returns the geo information structure change.

IMPORTANT NOTICE: If you have used Offerslook API before this update, you must aware of this data change. In previous API, city will be deprecated and add two array regions and cities.When you set up offers or when the affiliates use API to pull out offers, in the case that the Offer Geo Targeting has been limited to state/province or to city, then you should update the API setting accordingly.

Field

Type

Description

id

integer

offer_id

integer

A string that uniquely identifies this offer.

country

string

Country to be targeted

country_code

string

Country code.

city

array

This parameter has been deprecated. [Deprecated]

type

integer

An identifier included or excluded.

regions

Regions in targeted country

type

integer

An identifier included or excluded. Type: 1 include ; 2 exclude

region_ids

array

the unique id for the region

region_name

string

the name of the region

cities

City in targeted Region

type

integer

An identifier included or excluded. Type: 1 include ; 2 exclude

region_id

integer

the unique id for the region

city_ids

array

the unique id for the city

city_name

string

the name of the

Example response

{
        "offer_geo": {
            "type": 1,
            "target": [
                {
                    "country": "China",
                    "country_code": "CN",
                    "id": 541611,
                    "city": null,            //Deprecated
                    "type": null,           //Deprecated
                    "offer_id": null,       //Deprecated
                    "regions": [
                        {
                            "type": 1,
                            "region_id": 633,
                            "region_name": "Anhui Sheng"
                        },
                        {
                            "type": 1,
                            "region_id": 635,
                            "region_name": "Beijing Shi"
                        },
                        {
                            "type": 1,
                            "region_id": 641,
                            "region_name": "Guangxi Zhuangzu Zizhiqu"
                        }
                    ],
                    "cities": [
                        {
                            "type": 1,
                            "region_id": 633,
                            "city_id": 97648,
                            "city_name": "Anqing"
                        },
                        {
                            "type": 1,
                            "region_id": 633,
                            "city_id": 97649,
                            "city_name": "Baiyin"
                        },
                        {
                            "type": 1,
                            "region_id": 633,
                            "city_id": 97651,
                            "city_name": "Bozhou"
                        },
                        {
                            "type": 1,
                            "region_id": 633,
                            "city_id": 97658,
                            "city_name": "Diaoshi Township"
                        },
                        {
                            "type": 2,
                            "region_id": 635,
                            "city_id": 97739,
                            "city_name": "Beijing"
                        }
                    ]
                }
            ]
        }
    }

Last updated