Add a new geo for offer

HTTP method

Endpoint

POST

/v1/offers/{offer_id}/geo

Path parameters

Parameter

Description

offer_id

The unique id for the offer.

Request body parameters

Field

Type

Description

Nullable

target

To push the identification of the target, you must write the following field.

No

country

string

Country to be targeted. When the country is identified as the exclusion (type=2), the city is not optional

No

city

array

This parameter has been deprecated. [Deprecated]

type

integer

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

region

Regions selection in targeted country

type

integer

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

region_ids

array

the unique id for the region

cities

City selection in targeted country

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

Response body parameters

Field

Type

Description

id

integer

offer_id

integer

This parameter has been deprecated. [Deprecated]

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

region_include

integer

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

region_id

integer

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_id

integer

the unique id for the city

city_name

string

the name of the

Example request

Request POST https://{networkname}.api.offerslook.com/v1/offers/3147/geo

Request POST http://{networkname}.api.offerslook.com/v1/offers/3147/geo

{
    "type": 1,
    "target": {

            "country": "CN",
            "region": {
                "type": 1,
                "region_ids": ["633", "635", "641"]
            },
            "cities": [{
                    "type": 1,
                    "region_id": 633,
                    "city_ids": ["97648","97649", "97651","97658"]
                },
                {
                    "type": 2,
                    "region_id": "635",
                    "city_ids": ["97739"]
                }
            ]

        }


}

Example response

{
    "code": 0,
    "message": "Success",
    "data": {
        "offer_geo": {
            "type": 1,
            "target": [
                {
                    "country": "United Kingdom",
                    "country_code": "UK",
                    "id": 515054,
                    "city": null,
                    "type": null,
                    "offer_id": null,
                    "regions": [],
                    "cities": []
                },
                {
                    "country": "China",
                    "country_code": "CN",
                    "id": 541594,
                    "city": null,
                    "type": null,
                    "offer_id": null,
                    "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