cms_others

Miaozhen CMS/Misc API v1

Campaign Management System (CMS) is the product to manage Miaozhen’s meta data such as campaigns, panels and regions. For example, providing campaign id, you can query campaign name and campaign spot list from CMS APIs.

Panels

Show Panel

Endpoint
```
GET /cms/v1/panels/show
```

Parameters

Name Format Example Description

panel_id required ID “china-123”

lang optional LANG cn Show type_name and tag_name in language LANG. en (default): English, cn: Chinese

access_token required

Name		Format	Example	Description
panel_id	required	ID	“china-123”
lang	optional	LANG	cn	Show `type_name` and `tag_name` in language LANG. `en` (default): English, `cn`: Chinese

access_token	required

Example Response

{
    "panel_id": "china-123",
    "type_list": 
    [
        {
            "type_id": "gender",
            "type_name": "性别"
        },
        {
            "type_id": "age",
            "type_name": "年龄"
        },
        ...
    ],
    "tag_list":
    [
        {
            "type_id": "gender",
            "tag_id": "male",
            "tag_name": "男"
        },
        {
            "type_id": "gender",
            "tag_id": "female",
            "tag_name": "女"
        },
        {
            "type_id": "age",
            "tag_id": "20-24Y",
            "tag_name": "20-24岁"
        }
        ...
    ]
}

List Panels

List all panels.

Endpoint
```
GET /cms/v1/panels/list
```

Parameters

Name Format Example Description

panel_id optional ID1,ID2,… china-123,test Search: panel_id must be within the ID list (comma separated).

platform optional PTDIM pc Set panel platform dimension. PTDIM could be pc(default) or pm.

lang optional LANG cn Show type_name and tag_name in language LANG. en (default): English, cn: Chinese

access_token required

limit optional M, N 0,2 Return the M'th item to the M+N'th item. Default 0,500. M:return items from item M, N:return N number of items.

order_asc optional NAME panel_id It can only be: panel_id.

order_desc optional NAME panel_id See order_asc.

Name		Format	Example	Description
panel_id	optional	ID1,ID2,…	china-123,test	Search: panel_id must be within the ID list (comma separated).
platform	optional	PTDIM	pc	Set panel platform dimension. PTDIM could be `pc`(default) or `pm`.
lang	optional	LANG	cn	Show `type_name` and `tag_name` in language LANG. `en` (default): English, `cn`: Chinese

access_token	required
limit	optional	M, N	0,2	Return the M'th item to the M+N'th item. Default 0,500. `M`:return items from item M, `N`:return N number of items.
order_asc	optional	NAME	panel_id	It can only be: `panel_id`.
order_desc	optional	NAME	panel_id	See order_asc.

Example Response

[
    {
        "panel_id": "china-123",
        "platform": "pc",
        "type_list": 
        [
            {
                "type_id": "gender",
                "type_name": "性别"
            },
            {
                "type_id": "age",
                "type_name": "年龄"
            },
            ...
        ],
        "tag_list":
        [
            {
                "type_id": "gender",
                "tag_id": "male",
                "tag_name": "男"
            },
            {
                "type_id": "gender",
                "tag_id": "female",
                "tag_name": "女"
            },
            {
                "type_id": "age",
                "tag_id": "20-24Y",
                "tag_name": "20-24岁"
            },
            ...
        ]
    },
    ...
]

Regions

Show Region

Endpoint
```
GET /cms/v1/regions/show
```

Parameters

Name Format Example Description

region_id required ID 00001234

lang optional LANG cn Show region_name in language LANG. en (default): English, cn: Chinese

access_token required

Name		Format	Example	Description
region_id	required	ID	00001234
lang	optional	LANG	cn	Show region_name in language LANG. `en` (default): English, `cn`: Chinese

access_token	required

Example Response

{
    "region_id": "00001234",
    "region_name": "SevenKingdom",
    "parent_id": "00001200",
    "level": 1
}
Name Type Description

region_id string Region id

region_name string Region name

parent_id string The parent region id of the region

level int Region level, top level is 0 (global and countries)

Name	Type	Description
region_id	string	Region id
region_name	string	Region name
parent_id	string	The parent region id of the region
level	int	Region level, top level is 0 (global and countries)

List Regions

Endpoint
```
GET /cms/v1/regions/list
```

Parameters

Name Format Example Description

region_id optional ID1,ID2,… 2,3,4 Search: region_id must be within the ID list (comma separated).

parent_id optional ID1,ID2,… 2,3,4 Search: parent_id must be within the ID list (comma separated).

level optional LV1,LV2,… 0,1 Search: level must be within the level list (comma separated).

region_name optional PATTERN beij Search: region_name must contain PATTERN.

lang optional LANG cn Show region_name in language LANG. en (default): English, cn: Chinese

access_token required

limit optional M, N 0,2 Return the M'th item to the M+N'th item. Default 0,500. M:return items from item M, N:return N number of items.

order_asc optional NAME region_id It can only be one of the follows: region_id, parent_id, level.

order_desc optional NAME parent_id See order_desc.

If more than one search condition parameters specified, only items that fulfill all conditions will be returned (AND logic).

Name		Format	Example	Description
region_id	optional	ID1,ID2,…	2,3,4	Search: region_id must be within the ID list (comma separated).
parent_id	optional	ID1,ID2,…	2,3,4	Search: parent_id must be within the ID list (comma separated).
level	optional	LV1,LV2,…	0,1	Search: level must be within the level list (comma separated).
region_name	optional	PATTERN	beij	Search: region_name must contain PATTERN.
lang	optional	LANG	cn	Show region_name in language LANG. `en` (default): English, `cn`: Chinese

access_token	required
limit	optional	M, N	0,2	Return the M'th item to the M+N'th item. Default 0,500. `M`:return items from item M, `N`:return N number of items.
order_asc	optional	NAME	region_id	It can only be one of the follows: `region_id`, `parent_id`, `level`.
order_desc	optional	NAME	parent_id	See order_desc.

Example Response

[
    {
        "region_id": "00001234",
        "region_name": "SevenKingdom",
        "parent_id": "00001200",
        "level": 1
    },
    ...
]

Advertisers

Show Advertiser

Endpoint
```
GET /cms/v1/advertisers/show
```
Parameters

Name Format Example Description

advertiser_id required ID 1

access_token required

Name		Format	Example	Description
advertiser_id	required	ID	1
access_token	required

Example Response

{
    "advertiser_id": "1",
    "advertiser_name": "NASA"
}

List Advertisers

Endpoint
```
GET /cms/v1/advertisers/list
```

Parameters

Name Format Example Description

advertiser_id optional ID1,ID2,… 2,3,4 Search: advertiser_id must be within the ID list (comma separated).

advertiser_name optional PATTERN beij Search: advertiser_name must contain PATTERN.

access_token required

limit optional M, N 0,2 Return the M'th item to the M+N'th item. Default 0,500. M:return items from item M, N:return N number of items.

order_asc optional NAME advertiser_id It can only be one of the follows: advertiser_id, advertiser_name.

order_desc optional NAME advertiser_id See order_desc.

If more than one search condition parameters specified, only items that fulfill all conditions will be returned (AND logic).

Name		Format	Example	Description
advertiser_id	optional	ID1,ID2,…	2,3,4	Search: advertiser_id must be within the ID list (comma separated).
advertiser_name	optional	PATTERN	beij	Search: advertiser_name must contain PATTERN.

access_token	required
limit	optional	M, N	0,2	Return the M'th item to the M+N'th item. Default 0,500. `M`:return items from item M, `N`:return N number of items.
order_asc	optional	NAME	advertiser_id	It can only be one of the follows: `advertiser_id`, `advertiser_name`.
order_desc	optional	NAME	advertiser_id	See order_desc.

Example Response

[
    {
        "advertiser_id": "1",
        "advertiser_name": "NASA"
    },
    ...
]

Agencies

Show Agency

Endpoint
```
GET /cms/v1/agencies/show
```
Parameters

Name Format Example Description

agency_id required ID 1

access_token required

Name		Format	Example	Description
agency_id	required	ID	1
access_token	required

Example Response

{
    "agency_id": "1",
    "agency_name": "AgencyX"
}

List Agencies

Endpoint
```
GET /cms/v1/agencies/list
```

Parameters

Name Format Example Description

agency_id optional ID1,ID2,… 2,3,4 Search: agency_id must be within the ID list (comma separated).

agency_name optional PATTERN beij Search: agency_name must contain PATTERN.

access_token required

limit optional M, N 0,2 Return the M'th item to the M+N'th item. Default 0,500. M:return items from item M, N:return N number of items.

order_asc optional NAME agency_id It can only be one of the follows: agency_id, agency_name.

order_desc optional NAME agency_id See order_desc.

If more than one search condition parameters specified, only items that fulfill all conditions will be returned (AND logic).

Name		Format	Example	Description
agency_id	optional	ID1,ID2,…	2,3,4	Search: agency_id must be within the ID list (comma separated).
agency_name	optional	PATTERN	beij	Search: agency_name must contain PATTERN.

access_token	required
limit	optional	M, N	0,2	Return the M'th item to the M+N'th item. Default 0,500. `M`:return items from item M, `N`:return N number of items.
order_asc	optional	NAME	agency_id	It can only be one of the follows: `agency_id`, `agency_name`.
order_desc	optional	NAME	agency_id	See order_desc.

Example Response

[
    {
        "agency_id": "1",
        "agency_name": "AgencyX"
    },
    ...
]