Mediago API
zh
  • en
  • zh
  1. 广告计划管理
Mediago API
zh
  • en
  • zh
  • 身份认证
    • 获取访问令牌
      POST
  • 账户管理
    • 获取授权账户列表
      GET
  • 广告计划管理
    • 获取授权广告计划列表
      GET
    • 获取广告计划详情
      GET
    • 创建广告计划
      POST
    • 更新广告计划
      POST
    • 批量更新广告计划
      POST
    • 批量开启/关闭广告计划
      POST
    • 批量归档广告计划
      POST
  • 广告管理
    • 获取授权广告列表
      GET
    • 批量开启/关闭广告
      POST
  • Sites屏蔽管理
    • 获取账户层级Site屏蔽列表
      GET
    • 账户层级Site屏蔽/解除屏蔽
      POST
    • 获取广告计划层级Site屏蔽列表
      GET
    • 广告计划层级Site屏蔽/解除屏蔽
      POST
  • API 报表
    • 获取账户层级天级报表
      GET
    • 获取广告计划天级报表
      GET
    • 获取广告天级报表
      GET
    • 获取广告计划或广告小时级报表
      GET
    • 获取账户层级Site天级报表
      GET
    • 获取广告计划层级Site天级报表
      GET
  1. 广告计划管理

创建广告计划

POST
https://api.mediago.io/manage/v1/campaign/create
Last modified:2025-12-24 11:09:28
在请求体中提交一个代表新活动的JSON对象。（参见下面的示例。）每天限制50个新活动。
每个账户每天最多可以创建200个素材，每个活动最多可以有100个素材，每个账户每天最多可以创建50个活动。
QPS限制：60，IP 限制：15
请求参数：
字段名类型描述必填
account_idstring新创建广告计划所属的账户否
campaign_namestring新创建广告计划的名称是
charge_typestring出价方式，默认为历史值。允许的值包括：cpc, smart_bid, max_cv否
statusint新创建广告计划的开启/关闭状态，0代表关闭，1代表开启是
day_parting[][]int一个7*24的数组，表示您开启活动的一天中的特定时间或一周中的特定日期，其中第一维度的0-6索引表示周一到周日，第二维度的0-23索引表示一天中的小时，值1表示选中，0表示未选中
例如：
[[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]]
表示活动将在每个周五的凌晨3点到下午2点运行		是
dp_timezonestring默认选择您的账户时区。我们将根据所选时区进行广告计划投放。

允许的值包括：
EST
UTC-12
UTC-11
UTC-10
UTC-9
UTC-8
UTC-7
UTC-6
UTC-5
UTC-4
UTC-3
UTC-2
UTC-1
UTC
UTC+1
UTC+2
UTC+3
UTC+4
UTC+5
UTC+6
UTC+7
UTC+8
UTC+9
UTC+10
UTC+11
UTC+12
UTC+13
UTC+14		否
start_timestring广告计划的开始时间，格式为yyyy-mm-dd hh:mm:ss，不能早于API调用当天是
end_timestring广告计划的结束时间，格式为yyyy-mm-dd hh:mm:ss，不能早于开始时间，也不能晚于2030年是
daily_capdouble天预算：CPC*点击的每天最大限制值，最低天预算为$20/天，daily_cap/cpc不能小于30是
spend_limitdouble广告计划的最大消耗限制是
spend_modeint每日预算的消耗速度：1表示均匀消耗预算；0表示尽快消耗预算是
cpcdouble单次点击花费（单位：美元），cpc不能高于$5，daily_cap/cpc不能小于30当charge_type设置为cpc或smart_bid时，cpc为必填项。当charge_type设置为maxcv时，cpc不是必填项。
audienceobject您想要定位的受众：type="ALL", value=[]表示无限制；type="INCLUDE"表示包含value集合中的受众；type="EXCLUDE"表示排除value集合中的受众。允许的值包括：News, Weather, Election, Entertainment, Sports, Finance, Health, Foodanddrink, Travel, Autos, Video, Money, TV, Movies, Music, Homepage是
languagestringlanguage = "en"表示您的活动目标语言，允许的语言值包括：en, es, de, fr, it, pt, nl, pl, sv, cs, nb, da, hu, ga 默认语言 = "en"
以下是每个国家支持的语言：
US:en;es
CA:en,fr
AU:en
GB:en
DE:de
FR:fr
IT:it, de, fr
ES:es
AT:de
BR:pt
MX:es
BE:fr,nl,de
PT:pt
CH:de,fr,it
NL:nl
PL:pl
SE:sv
CZ:cs
NO:nb
DK:da
HU:hu
IE:en,ga
NZ: en		否
locationarray对象数组；
注意：您可以在此部分选择目标国家。
在美国，您可以选择特定的邮政编码或州。

Region表示区域定位
允许的区域值包括：US, CA, AU, GB, DE, FR, IT, ES, AT, BR, MX, BE, PT, CH, NL, PL, SE, CZ, NO, DK, HU
请注意：GB代表英国
默认区域 = "US"
DE, FR, IT, ES, AT, BR, MX, BE, PT, CH仅支持type="ALL"

type="ALL", value=[]表示无限制；
type="INCLUDE"表示定向value集合中的州/邮政编码
type="EXCLUDE"表示排除value集合中的州/邮政编码
option="state"表示使用州定向，option="zipcode"表示使用邮政编码定向。

更多详情，请参见上面的请求示例。

美国支持的州：
AL, AK, AZ, AR, CA, CO, CT, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY

加拿大支持的州包括：
AB, BC, MB, NB, NL, NS, ON, PE, QC, SK, NT, NU, YT

澳大利亚支持的州包括：
NSW, QLD, SA, TAS, VIC, WA, ACT, NT
新南威尔士 = NSW
昆士兰 = QLD
南澳大利亚 = SA
塔斯马尼亚 = TAS
维多利亚 = VIC
西澳大利亚 = WA
澳大利亚首都领地 = ACT
北领地 = NT

英国支持的州包括：
ENG, NIR, SCT, WLS
英格兰 = ENG
北爱尔兰 = NIR
苏格兰 = SCT
威尔士 = WLS		是
platform_targetingobject您想要定向的平台：type="ALL", value=[]表示无限制；type="INCLUDE"表示定向value集合中的平台；type="EXCLUDE"表示排除value集合中的平台。允许的值包括：Desktop, Mobile, Tablet, Xbox是
os_targetingobject您想要定向的操作系统：type="ALL", value=[]表示无限制；type="INCLUDE"表示定向value集合中的操作系统；type="EXCLUDE"表示排除value集合中的操作系统。允许的值包括：Mac OS, Windows, Android, IOS是
browser_targetingobject您想要定向的浏览器：type="ALL", value=[]表示无限制；type="INCLUDE"表示定向value集合中的浏览器；type="EXCLUDE"表示排除value集合中的浏览器。允许的值包括：Chrome, Safari, Internet Explorer, Edge, Firefox是
product_typestring您活动的产品类型。注意：请选择一个产品类型。允许的值包括：E-commerce, Lead Gen, Health & Fitness, Finance & Insurance, Real Estate, Auto, Careers, Technology & Computing, Education, Arts & Entertainment, Style & Fashion, Family & Parenting, Food, Hobbies & Interests, Home & Garden, Law Gov't & Politics, News, Pets, Religion & Spirituality, Science, Sports, Travel, Society, Others是
objectivestring您活动的目标。注意：请选择一个目标。允许的值包括："lead" 表示 潜在客户生成，"conversions" 表示在线购买，"awareness" 表示 网站参与是
target_cpadouble您活动的目标CPA。（单位：美元）daily_cap < tcpa*30（当出价方式为maxcv时）当营销目标选择潜在客户生成或在线购买时，target CPA为必填项；当选择网站参与时，target CPA不是必填项。
optimization_typestring您活动的转化目标。注意：请填写一个转化目标。转化目标是账户中嵌入的Pixel重要转化类型。如果Pixel重要转化尚未安装，请选择'-1'作为值。允许的值包括："1" means 查看内容，"2" means 应用安装，"3" means 完成注册，"4" means 添加到购物车，"5" means 添加支付信息，"6" means 搜索，"7" means 开始结账，"8" means 购买，"9" means 加入愿望清单，"10" means 潜在客户，"-1" means 默认优化当营销目标选择潜在客户生成或在线购买时，optimization_type为必填项；当选择网站参与时，optimization_type不是必填项。
optimization_type是账户中嵌入的Pixel重要转化类型。如果Pixel重要转化尚未安装，您可以选择默认优化，这将优化默认传回的重要转化。
landing_pagestring着陆页是
utm_trackingstring广告素材级别跟踪的跟踪代码。
参考帮助文档查看详情。		是
brand_namestring品牌名称，最多30个字符是
adobject array包含最多10个素材对象是
asset_namestring素材名称是
imgstring图片链接，且图片大小必须大于600*400是
headlinestring您素材的标题，最多80个字符。您可以在标题中设置动态宏：${LOCATION_STATE} ${TIME_MON} ${LOCATION_CITY}是

Request

Header Params

Body Params application/json

Example
{
  "account_id": "1",
  "campaign_name": "demo-campaign",
  "status": 0,
  "day_parting": [
    [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
    [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
    [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
    [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
    [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1],
    [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
    [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1]
  ],
  "dp_timezone": "UTC-7",
  "start_time": "2021-04-27 12:30:18",
  "end_time": "2030-04-30 06:30:19",
  "daily_cap": 50,
  "spend_limit": 200,
  "spend_mode": 0,
  "cpc": 1,
  "product_type": "Auto",
  "objective": "lead",
  "target_cpa": 1.2,
  "optimization_type": "1",
  "audience": {
    "type": "INCLUDE",
    "value": [
      "News",
      "Weather"
    ]
  },
  "language": "en",
  "location": [
    {
      "type": "EXCLUDE",
      "option": "state",
      "value": [
        "NY"
      ],
      "region": "US"
    },
    {
      "type": "INCLUDE",
      "option": "state",
      "value": [
        "AB"
      ],
      "region": "CA"
    },
    {
      "type": "INCLUDE",
      "option": "state",
      "value": [
        "NSW"
      ],
      "region": "AU"
    },
    {
      "type": "INCLUDE",
      "option": "state",
      "value": [
        "NIR"
      ],
      "region": "GB"
    }
  ],
  "platform_targeting": {
    "type": "ALL",
    "value": []
  },
  "os_targeting": {
    "type": "ALL",
    "value": []
  },
  "browser_targeting": {
    "type": "ALL",
    "value": []
  },
  "landing_page": "https://www.demo.com",
  "utm_tracking": "utm_source=mediago&utm_medium=referral&utm_campaign=${CAMPAIGN_NAME}&utm_content=${AD_TITLE}&utm_term=${CONTENT_NAME}",
  "brand_name": "demo-brand",
  "ad": [
    {
      "asset_name": "demo-asset-1",
      "img": "https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1587908803684&di=708b357ac67c164adfa14ad3fe269ced&imgtype=0&src=http%3A%2F%2Ft8.baidu.com%2Fit%2Fu%3D3571592872%2C3353494284%26fm%3D79%26app%3D86%26f%3DJPEG%3Fw%3D1200%26h%3D1290",
      "headline": "demo-headline-1"
    },
    {
      "asset_name": "demo-asset-2",
      "img": "https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1587908803684&di=bd6c2a974d397b3c4e6ff3e0d7fcdad0&imgtype=0&src=http%3A%2F%2Ft7.baidu.com%2Fit%2Fu%3D3616242789%2C1098670747%26fm%3D79%26app%3D86%26f%3DJPEG%3Fw%3D900%26h%3D1350",
      "headline": "demo-headline-2"
    }
  ]
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.mediago.io/manage/v1/campaign/create' \
--header 'Authorization: Bearer your_access_token_here' \
--header 'Content-Type: application/json' \
--data-raw '{
  "account_id": "1",
  "campaign_name": "demo-campaign",
  "status": 0,
  "day_parting": [
    [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
    [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
    [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
    [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
    [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1],
    [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
    [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1]
  ],
  "dp_timezone": "UTC-7",
  "start_time": "2021-04-27 12:30:18",
  "end_time": "2030-04-30 06:30:19",
  "daily_cap": 50,
  "spend_limit": 200,
  "spend_mode": 0,
  "cpc": 1,
  "product_type": "Auto",
  "objective": "lead",
  "target_cpa": 1.2,
  "optimization_type": "1",
  "audience": {
    "type": "INCLUDE",
    "value": [
      "News",
      "Weather"
    ]
  },
  "language": "en",
  "location": [
    {
      "type": "EXCLUDE",
      "option": "state",
      "value": [
        "NY"
      ],
      "region": "US"
    },
    {
      "type": "INCLUDE",
      "option": "state",
      "value": [
        "AB"
      ],
      "region": "CA"
    },
    {
      "type": "INCLUDE",
      "option": "state",
      "value": [
        "NSW"
      ],
      "region": "AU"
    },
    {
      "type": "INCLUDE",
      "option": "state",
      "value": [
        "NIR"
      ],
      "region": "GB"
    }
  ],
  "platform_targeting": {
    "type": "ALL",
    "value": []
  },
  "os_targeting": {
    "type": "ALL",
    "value": []
  },
  "browser_targeting": {
    "type": "ALL",
    "value": []
  },
  "landing_page": "https://www.demo.com",
  "utm_tracking": "utm_source=mediago&utm_medium=referral&utm_campaign=${CAMPAIGN_NAME}&utm_content=${AD_TITLE}&utm_term=${CONTENT_NAME}",
  "brand_name": "demo-brand",
  "ad": [
    {
      "asset_name": "demo-asset-1",
      "img": "https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1587908803684&di=708b357ac67c164adfa14ad3fe269ced&imgtype=0&src=http%3A%2F%2Ft8.baidu.com%2Fit%2Fu%3D3571592872%2C3353494284%26fm%3D79%26app%3D86%26f%3DJPEG%3Fw%3D1200%26h%3D1290",
      "headline": "demo-headline-1"
    },
    {
      "asset_name": "demo-asset-2",
      "img": "https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1587908803684&di=bd6c2a974d397b3c4e6ff3e0d7fcdad0&imgtype=0&src=http%3A%2F%2Ft7.baidu.com%2Fit%2Fu%3D3616242789%2C1098670747%26fm%3D79%26app%3D86%26f%3DJPEG%3Fw%3D900%26h%3D1350",
      "headline": "demo-headline-2"
    }
  ]
}'

Responses

🟢200成功响应
application/json
Body

Example
{
    "campaign_id": "1234556",
    "msg": "success"
}
🟠400错误请求 - 无效参数
🟠401未授权 - 无效访问令牌
🟠403禁止访问 - 令牌已过期
Modified at 2025-12-24 11:09:28
Previous
获取广告计划详情
Next
更新广告计划
Built with