Miaozhen CMS / Misc API v1

活动管理系统（CMS）是一款用于管理秒针系统元数据的产品，如活动、Panel和地域。例如，提供广告活动ID，可通过CMS API查询广告活动名称和广告活动点位列表。

Panels

显示panel

• 请求地址

GET /cms/v1/panels/show

• 参数

名称	必选	格式	示例	描述
panel_id	true	ID	“china-123”	活动所关联的人群样本库ID
lang	false	LANG	cn	显示LANG语言的type_name和tag_name。en（默认）：英文，cn：中文。
access_token	true		1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串

• 响应示例

{
"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岁"
  }
  ...
]
}

列出panel

列出所有panel。

• 请求地址

GET /cms/v1/panels/list

• 参数

名称	必选	格式	示例	描述
panel_id	false	ID1，ID2，...	china-123,test	活动所关联的人群样本库ID，用于搜索，支持批量输入（英文半角逗号分隔）。
platform	false	PTDIM	pc	设定panel平台维度。PTDIM可以是pc（默认）或pm。
lang	false	LANG	cn	显示LANG语言的type_name和tag_name。en（默认）：英文，cn：中文。
access_token	true		1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串
limit	false	M，N	0,2	用于限制返回结果条数。格式：M,N，默认为0,500,M为起始行数，N为结果条数
order_asc	false	NAME	panel_id	只能为：panel_id。
order_desc	false	NAME	panel_id	参考 order_asc。

• 响应示例

xxxxxxxxxx
[
{
  "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岁"
      },
      ...
  ]
},
...
]

地域

显示地域

• 请求地址

GET /cms/v1/regions/show

• 参数

名称	必选	格式	示例	描述
region_id	true	ID	00001234	地域ID
lang	false	LANG	cn	显示LANG语言的region_name 。en（默认）：英文，cn：中文。
access_token	true		1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串

• 响应示例

xxxxxxxxxx
{
"region_id": "00001234",
"region_name": "SevenKingdom",
"parent_id": "00001200",
"level": 1
}

名称	类型	描述
region_id	string	地域ID
region_name	string	地域名称
parent_id	string	该地域的父地域ID
level	int	地域等级，顶级是0（全球和国家）

列出地域

• 请求地址

GET /cms/v1/regions/list

• 参数

名称	必选	格式	示例	描述
region_id	false	ID1，ID2，...	2,3,4	地域ID，用于搜索，支持批量输入（英文半角逗号分隔）。
parent_id	false	ID1，ID2，...	2,3,4	该地域的父地域ID，用于搜索，支持批量输入（英文半角逗号分隔）。
level	false	LV1，LV2，...	0,1	地域等级，用于搜索，支持批量输入（英文半角逗号分隔）。
region_name	false	PATTERN	beij	地域名称，用于搜索，支持批量输入
lang	false	LANG	cn	显示LANG语言的region_name。en（默认）：英文，cn：中文。
access_token	true		1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串
limit	false	M，N	0,2	用于限制返回结果条数。格式：M,N，默认为0,500，M为起始行数，N为结果条数
order_asc	false	NAME	region_id	只可能是其中之一：region_id，parent_id，level。
order_desc	false	NAME	parent_id	参考order_desc。

注意：如果指定了多个搜索条件参数，则仅返回满足所有条件的项（AND逻辑）。

• 响应示例

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

广告主

显示广告主

• 请求地址

GET /cms/v1/advertisers/show

• 参数

名称	必选	格式	示例	描述
advertiser_id	true	ID	1	广告主ID
access_token	true		1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串

• 响应示例

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

列出广告主

• 请求地址

GET /cms/v1/advertisers/list

• 参数

名称	必选	格式	示例	描述
advertiser_id	false	ID1，ID2，...	2,3,4	广告主ID，用于搜索，支持批量输入（英文半角逗号分隔）。
advertiser_name	false	PATTERN	beij	广告主名称，用于搜索，
access_token	true		1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串
limit	false	M，N	0,2	用于限制返回结果条数。格式：M,N，默认为0,500,M为起始行数，N为结果条数
order_asc	false	NAME	advertiser_id	只可能是以下其中之一：advertiser_id，advertiser_name。
order_desc	false	NAME	advertiser_id	参考order_desc。

注意：如果指定了多个搜索条件参数，则仅返回满足所有条件的项（AND逻辑）。

• 响应示例

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

品牌

显示品牌

• 请求地址

GET /cms/v1/brands/show

• 参数

名称	必选	格式	示例	描述
brand_id	true	ID	1	品牌ID
access_token	true		1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串

• 响应示例

xxxxxxxxxx
{
"brand_id": "1",
"brand_name": "xxxx"
}

列出品牌

• 请求地址

GET /cms/v1/brands/list

• 参数

名称	必选	格式	示例	描述
advertiser_id	true	ID	2	广告主ID（需使用父级广告主ID），用于限定查询广告主ID
brand_id	false	ID	1	品牌ID，用于搜索
brand_name	false	name	aaaa	品牌名称，用于搜索
access_token	true		1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串

注意：如果指定了多个搜索条件参数，则仅返回满足所有条件的项（AND逻辑）。

• 响应示例

xxxxxxxxxx
[
{
"brand_id": "1",
"brand_name": "xxxx"
},
...
]

商品

列出商品信息

• 请求地址

GET /cms/v1/product/list

• 参数

名称	必选	格式	示例	描述
product_name	false	PATTERN	aaaa	商品名称,用于搜素
access_token	true		1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串
limit	false	M，N	0,2	用于限制返回结果条数。格式：M,N，默认为0,500，M为页数，N为结果条数。2,100 表示每页100条，查第二页。

• 响应示例

xxxxxxxxxx
{
"name": "xxxx"
}

代理商

显示代理商

• 请求地址

GET /cms/v1/agencies/show

• 参数

名称	必选	格式	示例	描述
agency_id	true	ID	1	代理商ID
access_token	true		1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串

• 响应示例

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

列出代理商

• 请求地址

GET /cms/v1/agencies/list

• 参数

名称	必选	格式	示例	描述
agency_id	false	ID1，ID2，...	2,3,4	代理商ID，用于搜索，支持批量输入（英文半角逗号分隔）
agency_name	false	PATTERN	beij	代理商名称，用于搜索，
access_token	true		1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串
limit	false	M，N	0,2	用于限制返回结果条数。格式：M,N，默认为0,500,M为起始行数，N为结果条数
order_asc	false	NAME	agency_id	只可能是其中之一：agency_id，agency_name。
order_desc	false	NAME	agency_id	参考order_desc。

注意：如果指定了多个搜索条件参数，则仅返回满足所有条件的项（AND逻辑）。

• 响应示例

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

剧目

列出剧目名称

• 请求地址

GET /cms/v1/programs/list

• 参数

名称	必选	格式	示例	描述
program_name	false	PATTERN	aaaa	剧目名称,用于搜素
access_token	true		1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串
limit	false	M，N	0,2	用于限制返回结果条数。格式：M,N，默认为0,500，M为页数，N为结果条数。2,100 表示每页100条，查第二页。

• 响应示例

xxxxxxxxxx
{
"name": "xxxx"
}

广告位类型

列出广告位类型

• 请求地址

GET /cms/v1/plmttype/list

• 参数

名称	必选	格式	示例	描述
plmt_type_name	false	PATTERN	富媒体Banner	广告位类型名称,用于搜素
access_token	true		1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串
limit	false	M，N	0,2	用于限制返回结果条数。格式：M,N，默认为0,500，M为页数，N为结果条数。2,100 表示每页100条，查第二页。

• 响应示例

xxxxxxxxxx
{
"name": "xxxx"
}