Miaozhen CMS/Campaigns API v1

CMS是管理秒针的元数据（如广告活动，panel和地域）的产品。可通过活动ID从CMS API查询广告活动名称和广告活动点位列表等信息。

广告活动——显示相关信息

显示广告活动信息

• 请求地址

GET /cms/v1/campaigns/show

• 参数

名称	必选	示例	描述
campaign_id	true	123	广告活动ID
access_token	true	1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串
pmo_info	false	1	0：（默认）不返回pmo相关的信息； 1：返回pmo相关的信息（返回参数"panel_type","linked_tvcaids"）
dm_info	false	1	0：默认，不反回dm需要的相关信息; 1：返回dm需要的相关信息(返回参数“order_id”,"scheduling_code","extensiontype","play_detect","ear“,"total_net“,"freq_capping","frequency_limit")

• 响应示例

{
"campaign_id": "123",
"campaign_type": "admonitor",
"campaign_name": "test campaign 1",
"start_date": "2012-12-20",
"end_date": "2013-01-05",
"description": "This is a test campaign.",
"agency_name": "Test Agency",
"advertiser_name": "Test Advertiser",
"brand_name": "Test Brand",
"creator_name": "jetlee",
"slot_type": "display",
"panel_type":0,
"calculation_type": "2.1",
"linked_panels": ["china-123","test"],
"linked_siteids": "123;456",
"linked_iplib": "IPlib-Region-0000-top100-20120428105600",
"linked_tvcaids":[123,345],
"order_id":"C240807020"，
" scheduling_code ":"C240807020P0004"，
"extensiontype":"品牌形象活动-品牌形象"，
"play_detect":"true"，
"ear":"无"，
" total_net ":"是"，
"freq_capping":"50"
}

显示广告活动点位信息

• 请求地址

GET /cms/v1/campaigns/show_spot

• 参数

名称	必选	示例	描述
campaign_id	true	123	广告活动ID
spot_id_str	true	abc0	字符串表示的点位
keyword	false	on	是否显示关键词，on为显示
show_filtration_status	false	1	是否显示点位的高危来源过滤开启状态，1为显示
access_token	true	1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串
show_extInfo	false	1	显示广告点位信息字段：预算录入

• 响应示例

xxxxxxxxxx
{
"spot_id": "40",
"spot_id_str": "e",
"publisher_name": "test site",
"channel_name": "news",
"placement_name": "top banner",
"budgetInput": "10000",
"report_metrics":"impression+click",
"linked_siteid":345,
"market":"北京市",
"adposition_type":"常规Banner",
"vending_model":"程序化购买-PDB",
"keyword":[
{
"keyword_id": 4018469,
"keyword_name": "白醋洗衣服"
"landing page": https://www.baidu.com/
},
{
"keyword_id": 4018470,
"keyword_name": "abctestword"
"landing page": https://www.baidu.com/
},
...
]
"GUID": "RTX123456",
"CAGUID": "XDF234",
"customize": "66666",
"description":"PC/A素材"
}

列出广告活动

获取指定活动条件下的活动基本信息列表

• 请求地址

GET /cms/v1/campaigns/list

• 参数

名称	必选	格式	示例	描述
campaign_id	false	ID1,ID2...	12,13,14	广告活动ID，用于搜索，支持批量输入（英文半角逗号分隔）
campaign_type	false	TP1，TP2，...	admonitor	系统默认，无需输入
campaign_name	false	PATTERN	food	活动名称，用于搜索
advertiser_name	false	PATTERN	Yum	广告主，用于搜索
agency_name	false	PATTERN		代理名称，用于搜索
brand_name	false	PATTERN	KFC	品牌名称，用于搜索
creator_name	false	PATTERN	lee	创建者，用于搜索
status	false	INT（1..3）	1	搜索：广告活动状态为 1：未启动;2正在进行中；3：已结束。
calculation_type	false		1.0	必须是以下之一：1.0(默认）2.0，2.1
pmo_info	false	INT	1	0：（默认）不返回pmo相关的信息； 1：返回pmo相关的信息（返回参数"panel_type","linked_tvcaids"）
dm_info	false	INT	1	0：默认，不反回dm需要的相关信息; 1：返回dm需要的相关信息(返回参数“order_id”,"scheduling_code","extensiontype","play_detect","ear“,"total_net“,"freq_capping","frequency_limit")
access_token	true		1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串
limit	false	M，N	0,2	用于限制返回结果条数。格式：M,N，默认为0,500;M为起始行数，N为结果条数。
order_asc	false	NAME	campaign_id	升序排序依据字段,order_asc取值: campaign_id, campaign_name, advertiser_name, agency_name, brand_name, creator_name, status
order_desc	false	NAME	campaign_id	降序排序依据字段,order_desc取值：同 order_asc

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

• 响应示例

xxxxxxxxxx
[
{
"campaign_id": "123",
"campaign_type": "admonitor",
"campaign_name": "test campaign 1",
"start_date": "2012-12-20",
"end_date": "2013-01-05",
"description": "This is a test campaign.",
"agency_name": "Test Agency",
"advertiser_name": "Test Advertiser",
"brand_name": "Test Brand",
"creator_name": "jetlee",
"slot_type": "display",
"panel_type":0,
"calculation_type": "2.1",
"linked_panels": ["china-123","test"],
"linked_siteids": "123;456",
"linked_iplib": "IPlib-Region-0000-top100-20120428105600",
"linked_tvcaids":[123,345],
"order_id":"C240807020"，
" scheduling_code ":"C240807020P0004"，
"extensiontype":"品牌形象活动-品牌形象"，
"play_detect":"true"，
"ear":"无"，
" total_net ":"是"，
"freq_capping":"50"
},
...
]

列出活动的目标人群

• 请求地址

xxxxxxxxxx
GET /cms/v1/campaigns/list_targets

• 参数

名称	必选	格式	示例	描述
campaign_id	true	ID	12	广告活动ID
panel_id	false	ID1，ID2，...	china-123，test	活动所关联的人群样本库ID，用于搜索，支持批量输入（英文半角逗号分隔）。
target_id	false	ID1，ID2，...	2,3	目标人群ID，用于搜索，支持批量输入（英文半角逗号分隔）。
show_tag	false	ID	0	是否返回该目标人群的tag_id组成。0：默认，不返回；1：返回。
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, target_id.
order_desc	false	NAME	panel_id	降序排序依据字段,取值：同order_asc.

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

• 响应示例

xxxxxxxxxx
[
{
"target_id": "2",
"target_name": "F20-29",
"panel_id": "china-123",
"tag_id":"001,002&003"
},
{
"target_id": "3",
"target_name": "M20-29",
"panel_id": "china-123",
"tag_id":"001,002&004"
},
...
]

列出活动的所有媒体

• 请求地址

xxxxxxxxxx
GET /cms/v1/campaigns/list_publishers

• 参数

名称	必选	格式	示例	描述
campaign_id	true	ID	12	广告活动ID
publisher_id	false	ID1，ID2，...	2,3,4	媒体ID，用于搜索，支持批量输入（英文半角逗号分隔）
access_token	true		1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串
limit	false	M，N	0,2	用于限制返回结果条数。格式：M,N，默认为0,500.M为起始行数，N为结果条数
order_asc	false	NAME	publisher_id	升序排序依据字段。取值: publisher_id.
order_desc	false	NAME	publisher_id	降序排序依据字段。取值：同 order_asc.

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

• 响应示例

xxxxxxxxxx
[
{
  "publisher_id": "2",
  "publisher_name": "Google"
},
{
"publisher_id": "3",
  "publisher_name": "Twitter"
},
...
]

列出活动的所有点位

获取指定活动的广告位（spot）信息列表（含监测代码）

• 请求地址

xxxxxxxxxx
GET /cms/v1/campaigns/list_spots

• 参数

名称	必选	格式	示例	描述
campaign_id	true	ID	12	广告活动ID
publisher_id	false	ID1，ID2，...	2,3,4	媒体ID，用于搜索，支持批量输入（英文半角逗号分隔）
spot_id	false	ID1，ID2，...	40,41,42	定位ID，用于搜索，支持批量输入（英文半角逗号分隔）。
show_plan	false	INT（0..1）	1	是否显示排期计划，0（默认）：不显示；1：显示
show_filtration_status	false	INT（0..1）	1	是否显示点位的高危来源过滤开启状态，0（默认）：不显示；1：显示
from_date	false	YYYY-MM-DD	2013-01-01	所展示排期开始的日期，格式：YYYY-MM-DD。默认为排期起始时间
to_date	false	YYYY-MM-DD	2013-01-07	所展示排期结束的日期，格式：YYYY-MM-DD。默认为排期结束时间
code_type	false	NAME	HTTP	选择监测代码的附加选项，以英文逗号分隔:mma（MMA标准的设备ID宏参数）, https（https监测代码）, na（微博专用用户唯一标识宏参数）, snr（新浪门户专用用户唯一标识宏参数）, ls（经纬度宏参数）, viewable（可见曝光监测宏参数）, tr（额外自定义信息）,nw（微博回传曝光ID）,contr(剧目监测代码，包括：nd、nd、ng、nn、nvn字段), closedurl（导出封闭式落地页）, utm（选择则此次导出点击监测代码的落地页后拼接umt参数）, utm_auto（ro=sm,落地页跳转时自动拼接utm参数，此项与utm二选一即可）, ks（快手活动信息字段，包括：ka、kb、kc、kd、ke、kf、kg字段），hmi（优酷家庭标识）yahoo（yahoo必要参数），groupm（群邑cookiemapping参数），txreferer（腾讯referer信息），xt（星图必要参数），jd（京东id)，douyin（P&G DOU+活动专用 创意ID），creativeid（P&G程序化活动专用 创意ID），？（添加“?”）
landingpage	false	NAME	utm	取值：utm；输出带utm参数的点击落地页（点位信息-目标链接地址需要有值）
access_token	true		1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串
limit	false	M，N	0,2	用于限制返回结果条数。格式：M,N，默认为0,500。格式：M为起始行数，N为结果条数
order_asc	false	NAME	publisher_id	升序排序依据字段。取值: spot_id, publisher_id.
order_desc	false	NAME	spot_id	降序排序依据字段。取值：同order_asc.
show_extInfo	false	INT（0..1）	1	显示广告点位信息字段：预算录入

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

• 响应示例

xxxxxxxxxx
[
{
"spot_id": "40",
"spot_id_str": "e",
"publisher_id": "3",
"budgetInput": "10000",
"channel_name": "news",
"placement_name": "top banner",
"report_metrics":"impression+click"
"GUID": "RTX123456",
"CAGUID": "XDF234",
"adposition_type": "其它",
"vending_model": "程序化购买-程序化购买其他类型",
"market": "",
"customize": "66666",
"description":"PC/A版素材",
"keyword": [
{
"deletedTime": "",
"isDeleted": "",
"keyword": "牛奶",
"keywordId": 22050057,
"landingPage": "https://www.baidu.com",
"spid": 0,
"tracking_tags": [
{
    "impression_url": "http://g.cn.miaozhen.com/x/k=215&p=123&dx=__IPDX__&rt=2&ns=__IP__&ni=__IESID__&v=__LOC__&xa=__ADPLATFORM__&tr=__REQUESTID__&o="
},
{
    "click_url": "http://e.cn.miaozhen.com/r/k=215&p=123&af=22050057&dx=__IPDX__&rt=2&ns=__IP__&ni=__IESID__&v=__LOC__&xa=__ADPLATFORM__&tr=__REQUESTID__&vo=34449fe&vr=2&o=https%3A%2F%2Fwww.baidu.com"
}
]
}
],
"landing_page": "http://www.facebook.com",
"tracking_tags":
[
"impression_url": "http://g.cn.miaozhen.com/x.gif?k=123&p=456&o=",
"click_url": "http://e.cn.miaozhen.com/r.gif?k=123&p=456&o=http://www.facebook.com"
],
"spot_plan":
[
{
"date": "2013-01-01",
"est_impression": 2000,
"est_click": 10,
},
...
]
},
...
]

广告活动 - 创建广告相关信息

创建广告活动

• 请求地址

POST /cms/v1/campaigns/create

• 参数

名称	必选	示例	描述
campaign_type	false	admonitor	系统默认，无需输入
platform	false	pm	设定panel平台维度。必须是pc（默认）或pm
campaign_name	true	test	广告活动名称，不能为空，不得与已有活动名称重复
calculation_type	false	1.0	必须是以下之一：1.0(默认）3.0，3.1
start_date	true	2012-12-20	YYYY-MM-DD，不得早于当天
end_date	true	2013-01-05	YYYY-MM-DD，不得早于start_date
orderid	false	C240807020	服务单ID
schedulingCode	false	C240807020P0004	排期编码
frequency_limit	false	20	活动最大到达，默认10。范围：1-80
advertiser_id	false	1	广告主ID。可使用List Advertisers列出所有可用的广告主ID
brand_id	false	1	品牌ID。可使用查询List Brands 广告主ID下的所有品牌ID。如传品牌ID则广告主ID必填，且保证品牌ID与广告主ID的关联关系准确
agency_id	false	2	代理商ID。可使用List Agencies列出所有可用的代理机构ID
panel_id	false	china-123	活动所关联的人群样本库ID。可使用List Panels列出所有可用的人群样本库ID强烈建议使用默认值(默认为最新的panel_id)
ear	false	EAR阿里妈妈	是否为ear类型活动。枚举值：无（默认），EAR阿里妈妈。该字段一旦创建不可修改
wares	false	china -123	商品信息，格式：广告主|品牌名称|商品名称
linked_siteids	false	china -123	关联的秒针分析站点ID，多个用";"隔开
ad_campaign_type	false	china -123	广告活动类型，必须是以下之一：imedia，ivideo，ivideo+imedia，other,cross
slot_type	false	dispaly	排期类型，必须是以下之一：display(默认)，search，display+search
freq_capping	false	china -123	活动频次，范围1-50
description	false	CampaignDesc	描述信息
panel_type	false	pmo	Panel类型，枚举值：pm（默认），pmo。活动创建完成后不可修改
linked_tvcaids	false	[123,456]	关联的TVMonitor活动ID
extensiontype	false	一级-二级	推广类型，可使用List extensiontype查询
play_detect	false	1	内容监测，默认0，如需监测填写1
access_token	true	1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串

• 响应示例

如果创建活动成功，将返回新创建的campaign_id。

xxxxxxxxxx
{
"campaign_id": "123"
}

如果失败，将返回error。有关细节请参阅错误响应格式

xxxxxxxxxx
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
{
"error": "invalid_campaign_name",
"error_description": "The 'campaign_name' should not be empty."
}

创建广告活动点位

• 请求地址

POST /cms/v1/campaigns/create_spot

• 参数

名称	必选	示例	描述
campaign_id	true	123	广告活动ID
publisher_name	true	Yahoo	媒体名称
channel_name	true	News	频道
placement_name	true	123	广告位名称
placement_type	false	display	广告素材类型，必须是以下之一：display（默认）video，text，others，QR-Code，search
program_purchasing_type	false	通投	通投/按频道采买/按剧目采买
program	false	aaaaa	剧目名称，可使用List Program列出所有可用的剧目名称，可填写多个，以“,”分割。
keyword	false	牛奶^https://www.baidu.com>母乳^https://www.baidu.com	关键词，keyword字段为数组形式，包含keyword_name和landingpage，如landingpage不填，形式为牛奶^>母乳^。不同数组以>分隔。
freq_capping	false	S0+	广告位频次控制，区分大小写格式：由频控类型（S、M）、频控目标（n+、n-）和频控周期（D、W、M）组成，频控类型和频控目标必填；若无频控需求，请输入S0+
tracking_timing	false	0	Video广告位置，用于发送监测请求的预期时间，Video类型广告位的默认值：1s，非video类型广告位无默认值。
linked_siteid	false	345	关联的秒针分析站点ID，如果需要秒针分析的归因，请务必填写
market	false	北京市	地域定向
vending_model	false	程序化购买-PDB	广告投放方式，一级投放方式与二级投放方式间用"-"分隔
adposition_type	false	常规Banner	广告位类型，可使用List plmttpe列出所有可用的广告位类型。
referrer_url	false	http://www.ads.com	广告所在页面网址
landing_page	false	http://www.wtf.com	目标链接地址，点击广告跳转的落地页
dangerous_source_filtration	false	1	必须是1或0，表示是否过滤可疑高危来源的流量，keywords点位默认值为0，其余点位默认值为1。 若无特殊监测需求（如S2S），请输入1。
report_metrics	false	impression	必须是以下之一：impression，click，impression+click
caguid	false	SP-CH1900861	客户活动ID
guid	false	13027990	客户点位ID
customize	false	公关_母品牌	自定义列
description	false	PC/A版素材	描述信息
access_token	true	1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串
other_impr_tracking_tag	false	http://www.xxxxx.com	其他公司曝光代码，必须以http://或https://开头
shop_id	false	123456	ShopID
category	false		客户自定义字段
brand	false		客户自定义字段
product	false		客户自定义字段
copy_name	false		客户自定义字段
buying_model	false		客户自定义字段
buying_model_subtype	false		客户自定义字段
media_subtype	false		客户自定义字段
general_buyingtype	false		客户自定义字段
spot_type	false		客户自定义字段
spot_plan	false		客户自定义字段
spot_plan_record_id	false		客户自定义字段
buying_platform	false		客户自定义字段
campaign_group	false		客户自定义字段
campaign	false		客户自定义字段
kpi	false		客户自定义字段
site_type	false		客户自定义字段
site_name	false		客户自定义字段
buying_basis	false		客户自定义字段
paid_or_bonus	false		客户自定义字段
ext_info_md5_format_type	false		客户自定义字段
budgetInput	false	100000	预算录入

• 响应示例

如果创建点位成功，将返回新创建 spot_id 。

如同时创建了关键词 ，将返回关键词的keyword_id、keyword_name、landing_page。

xxxxxxxxxx
{
 "campaign_id": "123",
 "spot_id": "40",
 "spot_id_str": "e",
 "publisher_id": "1"
 "keyword": [
     {
         "keyword_id": 22050057,
         "landing_page": "https://www.baidu.com",
         "keyword_name": "牛奶"
     },
     {
         "keyword_id": 22050058,
         "landing_page": "https://www.baidu.com",
         "keyword_name": "母乳"
     }
 ]
}

如果失败，将返回error。有关细节请参阅错误响应格式

xxxxxxxxxx
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
{
 "error": "invalid_placement_name",
 "error_description": "The 'placement_name' should not be empty."
}

创建和发布目标人群

• 请求地址

POST /cms/v1/campaigns/publish_target

• 参数

名称	必选	示例	描述
campaign_id	true	12	广告活动ID
target_name	true	F24〜29Y	目标人群名称，不能为空。建议在一个广告活动中使用唯一的名称。
tag_id	true	34,56	目标人群的标签。可使用List Panels列出所有可用的标签ID。
access_token	true	1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串

• 响应示例

如果成功，将返回新发布的target_id。

xxxxxxxxxx
 {
 "target_id": "6",
"target_name": "F20-24Y",
 "panel_id": "china-123"
}

如果失败，将返回error。有关细节请参阅错误响应格式

xxxxxxxxxx
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
{
"error": "is wrong.",
 "error_description": "The 'target_name' has been existed in this campaign."
}

创建活动排期

• 请求地址

POST /cms/v1/campaigns/create_spot_with_plan

• 参数

名称	必选	示例	描述
campaign_id	true	123	广告活动ID
publisher_name	true	Yahoo	媒体名称
channel_name	true	News	关键词点位填写Bidding word（“B”必需大写）
placement_name	true	123	广告位名称
placement_type	false	display	广告素材类型，必须是以下之一：display（默认）video，text，others，QR-Code，search
program_purchasing_type	false	通投	通投/按频道采买/按剧目采买
program	false	aaaaa	剧目名称，可使用List Program列出所有可用的剧目名称，可填写多个，以“,”分割。
keyword	false	牛奶^https://www.baidu.com>母乳^https://www.baidu.com	关键词，keyword字段为数组形式，包含keyword_name和landingpage，如landingpage不填，形式为牛奶^>母乳^。不同数组以>分隔。
tracking_timing	false	0	Video广告位置，用于发送监测请求的预期时间，Video类型广告位的默认值：1s，非video类型广告位无默认值。
linked_siteid	false	345	关联的秒针分析站点ID，如果需要秒针分析的归因，请务必填写
market	false	北京市	地域定向
vending_model	false	程序化购买-PDB	广告投放方式，一级投放方式与二级投放方式间用"-"分隔
adposition_type	false	常规Banner	广告位类型，可使用List plmttpe列出所有可用的广告位类型。
referrer_url	false	http://www.ads.com	广告所在页网址
landing_page	false	http://www.wtf.com	目标链接地址，点击广告所跳转的落地页
dangerous_source_filtration	false	1	必须是1或0，表示是否过滤可疑高危来源的流量，keywords点位默认值为0，其余点位默认值为1。 若无特殊监测需求（如S2S），请输入1。
report_metrics	false	impression	必须是以下之一：impression，click，impression+click
caguid	false	SP-CH1900861	客户活动ID
guid	false	13027990	客户点位ID
customize	false	公关_母品牌	自定义列
description	false	PC/A版素材	描述信息
slot_begin	false	2013-11-11	广告位排期开始时间,格式：YYYY-MM-DD
slot_duration	false	30	广告排期持续时间（以天为单位）。
est_impression	false	100	预估总曝光
est_click	false	10000	预估总点击
access_token	true	1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串
other_impr_tracking_tag	false	http://www.xxxxx.com	其他公司曝光代码，必须以http://或https://开头
shop_id	false	123456	ShopID
category	false		客户自定义字段
brand	false		客户自定义字段
product	false		客户自定义字段
copy_name	false		客户自定义字段
buying_model	false		客户自定义字段
buying_model_subtype	false		客户自定义字段
media_subtype	false		客户自定义字段
general_buyingtype	false		客户自定义字段
spot_type	false		客户自定义字段
spot_plan	false		客户自定义字段
spot_plan_record_id	false		客户自定义字段
buying_platform	false		客户自定义字段
campaign_group	false		客户自定义字段
campaign	false		客户自定义字段
kpi	false		客户自定义字段
site_type	false		客户自定义字段
site_name	false		客户自定义字段
buying_basis	false		客户自定义字段
paid_or_bonus	false		客户自定义字段
ext_info_md5_format_type	false		客户自定义字段
budgetInput	false	10000	预算录入

• 响应示例

如果成功，将返回新创建的spot_id。

如同时创建了关键词 ，将返回关键词的keyword_id、keyword_name、landing_page。

xxxxxxxxxx
{
"campaign_id": "123",
"spot_id": "40",
"spot_id_str": "e",
"publisher_id": "1"
"keyword": [
   {
       "keyword_id": 22050057,
       "landing_page": "https://www.baidu.com",
       "keyword_name": "牛奶"
   },
   {
       "keyword_id": 22050058,
       "landing_page": "https://www.baidu.com",
       "keyword_name": "母乳"
   }
]
}

如果失败，将返回error。有关细节请参阅错误响应格式

xxxxxxxxxx
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
{
"error": "invalid_placement_name",
"error_description": "The 'placement_name' should not be empty."
}

广告活动 - 删除数据

删除广告活动

• 请求地址

POST /cms/v1/campaigns/delete

• 参数

名称	必选	示例	描述
campaign_id	true	123	广告活动ID
access_token	true	1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串

• 响应示例

如果成功，campaign_id将被删除。

xxxxxxxxxx
 {
"campaign_id": "123"
}

如果失败，将返回error。有关细节请参阅错误响应格式

xxxxxxxxxx
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
{
"error": "invalid_campaign_id",
"error_description": "The 'campaign_id' cannot be found."
}

删除广告活动点位

• 请求地址

POST /cms/v1/campaigns/delete_spot

• 参数

名称	必选	示例	描述
campaign_id	true	123	广告活动ID
spot_id	true	40	点位ID
access_token	true	1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串

• 响应示例

如果成功，spot_id将被删除。

xxxxxxxxxx
 {
"campaign_id": "123",
"spot_id": "40",
"spot_id_str": "e"
}

如果失败，将返回error。有关细节请参阅错误响应格式

xxxxxxxxxx
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
{
"error": "invalid_spot_id",
"error_description": "The 'spot_id' cannot be found."
}

广告活动 - 更新广告相关信息

更新广告活动

• 请求地址

POST /cms/v1/campaigns/update

• 参数

名称	必选	示例	描述
campaign_id	true	1	广告活动ID
campaign_type	false	admonitor	系统默认，无需输入
campaign_name	false	test	广告活动名称，不能为空。若与已有活动名称重复，将会自动添加编号
start_date	false	2012-12-20	YYYY-MM-DD，不得早于当天。需同end_date一起输入
end_date	false	2013-01-05	YYYY-MM-DD，不得早于start_date。需同start_date一起输入
advertiser_id	false	1	广告主ID。可使用List Advertisers列出所有可用的广告主ID。
agency_id	false	1	代理商ID。可使用List_Agencies列出所有可用的代理机构ID。
brand_id	false	1	品牌ID。可使用查询List Brands 广告主ID下的所有品牌ID。如传品牌ID则广告主ID必填，且保证品牌ID与广告主ID的关联关系准确
wares	false	china -123	商品信息，格式：广告主|品牌名称|商品名称。
linked_siteids	false	china -123	关联的秒针分析站点ID，多个用";"隔开
slot_type	false	search	排期类型，必须是以下之一：dispaly(默认)，search，display+search
description	false	CampaignDesc	描述信息
linked_tvcaids	false	[123,456]	关联的TVMonitor活动ID
extensiontype	false	品牌形象活动-品牌形象	推广类型
play_detect	false	1	内容监测，默认0，如需监测填写1
access_token	true	1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串

• 响应示例

如果成功，将返回更新的campaign_id。

xxxxxxxxxx
 {
"campaign_id": "123"
}

如果失败，将返回error。有关细节请参阅错误响应格式

xxxxxxxxxx
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
{
"error": "invalid_campaign_id",
"error_description": "The 'campaign_id' cannot be found."
}

更新广告活动点位

• 请求地址

xxxxxxxxxx
POST /cms/v1/campaigns/update_spot

• 参数

名称	必选	示例	描述
campaign_id	true	123	广告活动ID
spot_id	true	3	点位ID
publisher_name	false	3	媒体名称
placement_name	false	header	广告位名称
channel_name	false	news	频道
placement_type	false	display	广告素材类型，必须是以下之一：display（默认）video，text，others，QR-Code，search
program_purchasing_type	false	通投	通投/按频道采买/按剧目采买
program	false	aaaaa	剧目名称，可使用List Program列出所有可用的节目名称。
add_keyword	false	牛奶^https://www.baidu.com>母乳^https://www.baidu.com	新增关键词。keyword字段为数组形式，包含keyword_name和landingpage，如landingpage不填，形式为牛奶^>母乳^。不同数组以>分隔。
update_keyword	false	18372628^牛奶^https://www.baidu.com>18372628^母乳^https://www.baidu.com	变更关键词。keyword字段为数组形式，包含keyword_name和landingpage，如landingpage不填，形式为牛奶^>母乳^。不同数组以>分隔。
landing_page	false	http://www.wtf.com	目标链接地址，点击广告所跳转的落地页
dangerous_source_filtration	false	1	必须是1或0，表示是否过滤可疑高危来源的流量，keywords点位默认值为0，其余点位默认值为1。 若无特殊监测需求（如S2S），请输入1。
market	false	北京市	地域定向
vending_model	false	程序化购买-PDB	广告投放方式，一级投放方式与二级投放方式间用"-"分隔
adposition_type	false	常规Banner	广告位类型，可使用List plmttpe列出所有可用的广告位类型。
report_metrics	false	impression	必须是以下之一：impression，click，impression+click
caguid	false	SP-CH1900861	客户活动ID
guid	false	13027990	客户点位ID
customize	false	公关_母品牌	自定义列
description	false	PC/A版素材	描述信息
access_token	true	1.2YotnFZFEjr1zCsi	用于验证登录的访问令牌串
add_slot	false	2020-06-30,2020-07-03	增加广告位排期，格式：YYYY-MM-DD，不同日期通过","进行分割
delete_slot	false	2020-06-30,2020-07-03	删除广告位排期，格式：YYYY-MM-DD，不同日期通过","进行分割，对应日期预估曝光、预估点击同时删除
update_slot	false	2020-06-30,2020-07-03	更新广告位排期预估值，格式：YYYY-MM-DD，不同日期通过","进行分割。配合est_impression参数、est_click参数使用，修改对应日期的预估值。同一请求中不可同时存在add_slot参数和update_slot参数
est_impression	false	10000,10000	预估曝光，通过","进行分割
est_click	false	100,100	预估点击，通过","进行分割
other_impr_tracking_tag	false	http://www.xxxxx.com	其他公司曝光代码，必须以http://或https://开头
shop_id	false	123456	ShopID
category	false		客户自定义字段
brand	false		客户自定义字段
product	false		客户自定义字段
copy_name	false		客户自定义字段
buying_model	false		客户自定义字段
buying_model_subtype	false		客户自定义字段
media_subtype	false		客户自定义字段
general_buyingtype	false		客户自定义字段
spot_type	false		客户自定义字段
spot_plan	false		客户自定义字段
spot_plan_record_id	false		客户自定义字段
buying_platform	false		客户自定义字段
campaign_group	false		客户自定义字段
campaign	false		客户自定义字段
kpi	false		客户自定义字段
site_type	false		客户自定义字段
site_name	false		客户自定义字段
buying_basis	false		客户自定义字段
paid_or_bonus	false		客户自定义字段
ext_info_md5_format_type	false		客户自定义字段

• 响应示例

如果成功，将返回更新的spot_id。

如更新关键词，将返回更新关键词的keyword_id、keyword_name、landing_page。

​x
{
"campaign_id": "123",
"spot_id": "40",
"spot_id_str": "e"
"add_keyword":[
     {
       "keyword_id": 4018469,
       "keyword_name": "牛奶"
       "landing_page": https://www.baidu.com/
     }
   ]
"update_keyword":[
     {
       "keyword_id": 4018470,
       "keyword_name": "母乳"
       "landing_page": https://www.baidu.com/
     }
   ]
​
}

如果失败，将返回error。有关细节请参阅错误响应格式

xxxxxxxxxx
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
{
"error": "invalid_spot_id",
"error_description": "The 'spot_id' cannot be found."
}