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/update
Last modified:2025-10-13 07:21:55
在请求体中提交一个代表要更新属性的JSON对象。（参见下面的演示。）
如果成功，返回HTTP状态码200。
QPS限制：60，IP 限制：15
请求参数：
字段名类型描述必填
campaign_idstring要更新的广告计划ID是
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天预算，最低天预算为$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不是必填项。
audience_v1object您想要定向的受众：type="ALL", value=[] 表示无限制；type="INCLUDE" 表示定向值集合中的受众；type="EXCLUDE" 表示排除集合中的受众。允许的值包含：News, Weather, Election, Entertainment, Sports, Finance, Health, Foodanddrink, Travel, Autos, Video, Money, TV, Movies, Music, Homepage否
language_v1stringlanguage = "en" 表示您的广告计划所定向的语言，允许的语言值包含：en, es, de, fr, it, pt, nl, pl, sv, cs, nb, da, hu, ga。默认语言 = "en"

以下是每个国家支持的语言：
美国：en, es
加拿大：en, fr
澳大利亚：en
英国：en
德国：de
法国：fr
意大利：it, de, fr
西班牙：es
奥地利：de
巴西：pt
墨西哥：es
比利时：fr, nl, de
葡萄牙：pt
瑞士：de, fr, it
荷兰：nl
波兰：pl
瑞典：sv
捷克：cs
挪威：nb
丹麦：da
匈牙利：hu
爱尔兰：en, ga
新西兰：en		否
location_v1array对象数组；注意：您可以在此部分选择目标国家。在美国，您可以选择特定的邮政编码或州。

地区表示地区定位。允许的地区值包含：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" 表示定向值集合中的州/邮政编码
type="EXCLUDE" 表示排除集合中的州/邮政编码
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_targeting_v1object您想要定向的平台：type="ALL", value=[] 表示无限制；type="INCLUDE" 表示定向值集合中的平台；type="EXCLUDE" 表示排除值集合中的平台。允许的值包含：Desktop, Mobile, Tablet, Xbox否
os_targeting_v1object您想要定向的操作系统：type="ALL", value=[] 表示无限制；type="INCLUDE" 表示定向值集合中的操作系统；type="EXCLUDE" 表示排除值集合中的操作系统。允许的值包含：Mac OS, Windows, Android, IOS否
browser_targeting_v1object您想要定向的浏览器：type="ALL", value=[] 表示无限制；type="INCLUDE" 表示定向值集合中的浏览器；type="EXCLUDE" 表示排除值集合中的浏览器。允许的值包含：Chrome, Safari, Internet Explorer, Edge, Firefox否
utm_trackingstring广告素材级别跟踪的跟踪代码是
site_bid_modiefierarray对象数组；注意：您可以在这里更新站点CPC（每次最多100个）。site_id="1" 表示站点ID；cpc_modification=0.1 表示站点CPC的浮动范围。最小值为-0.99，最大值不超过$5。否
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（单位：美元）当营销目标选择潜在客户生成或在线购买时，需要提供目标CPA；当选择网站参与时，不需要目标CPA。
optimization_typestring您活动的转化目标。注意：请填写一个转化目标。转化目标是账户中嵌入的Pixel重要转化类型。如果Pixel重要转化尚未安装，请选择'-1'作为值。允许的值包括："1" 表示查看内容，"2" 表示应用安装，"3" 表示完成注册，"4" 表示添加到购物车，"5" 表示添加支付信息，"6" 表示搜索，"7" 表示开始结账，"8" 表示购买，"9" 表示添加到心愿单，"10" 表示潜在客户，"-1" 表示默认优化当营销目标选择潜在客户生成或在线购买时，optimization_type为必填项；当选择网站参与时，optimization_type不是必填项。
optimization_type是账户中嵌入的Pixel重要转化类型。如果Pixel重要转化尚未安装，您可以选择默认优化，这将优化默认传回的重要转化。

Request

Header Params

Body Params application/json

Example
{
  "campaign_id": "1",
  "campaign_name": "test-demo",
  "status": 1,
  "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-01-01 06:30:19",
  "end_time": "2022-05-01 06:30:19",
  "daily_cap": 20,
  "spend_limit": 100,
  "spend_mode": 1,
  "cpc": 1.1,
  "utm_tracking": "utm_source=mediago&utm_medium=referral&utm_campaign=${CAMPAIGN_NAME}&utm_content=${AD_TITLE}&utm_term=${CONTENT_NAME}",
  "site_bid_modiefier": [
    {
      "site_id": "1",
      "cpc_modification": 0.2
    },
    {
      "site_id": "2",
      "cpc_modification": -0.2
    }
  ],
  "product_type": "Auto",
  "objective": "lead",
  "target_cpa": 1.2,
  "optimization_type": "1",
  "audience_v1": {
    "type": "INCLUDE",
    "value": [
      "News",
      "Weather"
    ]
  },
  "language_v1": "en",
  "location_v1": [
    {
      "type": "EXCLUDE",
      "option": "state",
      "value": [
        "NY"
      ],
      "region": "US"
    },
    {
      "type": "INCLUDE",
      "option": "state",
      "value": [
        "AB"
      ],
      "region": "CA"
    },
    {
      "type": "INCLUDE",
      "option": "state",
      "value": [
        "NIR"
      ],
      "region": "GB"
    }
  ],
  "platform_targeting_v1": {
    "type": "ALL",
    "value": []
  },
  "os_targeting_v1": {
    "type": "ALL",
    "value": []
  },
  "browser_targeting_v1": {
    "type": "ALL",
    "value": []
  }
}

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/update' \
--header 'Authorization: Bearer your_access_token_here' \
--header 'Content-Type: application/json' \
--data-raw '{
  "campaign_id": "1",
  "campaign_name": "test-demo",
  "status": 1,
  "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-01-01 06:30:19",
  "end_time": "2022-05-01 06:30:19",
  "daily_cap": 20,
  "spend_limit": 100,
  "spend_mode": 1,
  "cpc": 1.1,
  "utm_tracking": "utm_source=mediago&utm_medium=referral&utm_campaign=${CAMPAIGN_NAME}&utm_content=${AD_TITLE}&utm_term=${CONTENT_NAME}",
  "site_bid_modiefier": [
    {
      "site_id": "1",
      "cpc_modification": 0.2
    },
    {
      "site_id": "2",
      "cpc_modification": -0.2
    }
  ],
  "product_type": "Auto",
  "objective": "lead",
  "target_cpa": 1.2,
  "optimization_type": "1",
  "audience_v1": {
    "type": "INCLUDE",
    "value": [
      "News",
      "Weather"
    ]
  },
  "language_v1": "en",
  "location_v1": [
    {
      "type": "EXCLUDE",
      "option": "state",
      "value": [
        "NY"
      ],
      "region": "US"
    },
    {
      "type": "INCLUDE",
      "option": "state",
      "value": [
        "AB"
      ],
      "region": "CA"
    },
    {
      "type": "INCLUDE",
      "option": "state",
      "value": [
        "NIR"
      ],
      "region": "GB"
    }
  ],
  "platform_targeting_v1": {
    "type": "ALL",
    "value": []
  },
  "os_targeting_v1": {
    "type": "ALL",
    "value": []
  },
  "browser_targeting_v1": {
    "type": "ALL",
    "value": []
  }
}'

Responses

🟢200成功
application/json
Body

Example
{
  "msg": "success"
}
🟠400错误请求 - 无效参数
Modified at 2025-10-13 07:21:55
Previous
创建广告计划
Next
批量更新广告计划
Built with