创建营销拓展活动

需要 write_marketing_event 权限点。

更多权限点使用信息，请参考：

POST https://{handle}.myshopline.com/admin/openapi/v20261201/sales/marketing_activity_extension.json

handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。

创建营销拓展活动

请求头

Content-Type string required

字段值固定为 application/json; charset=utf-8。
Authorization string required

资源的访问令牌。参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。
例子:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA

请求体

marketing_activityobject

营销拓展活动
status string required

营销活动当前的状态，draft：草稿，failed：失败，active：生效，inactive：已完成，scheduled：已安排，paused：已暂停，deleted_externally：已在外部删除
例子: draft
utm_medium string

标识来源类型（电子邮件，文章）
例子: email
marketing_activity_extension_id string required

营销扩展id
例子: b1ee529b-d71d-41d6-93ba-ee46986d3a4b
marketing_activity_id string

营销拓展活动id
例子: MA_6019932248291157288?
utm_term string

标识搜索关键字
例子: this is utm term name
marketing_activity_title string

营销拓展活动标题
例子: This is marketing activity title
started_at string

开始时间
例子: 2022-12-15T09:00:00+08:00
utm_content string

区分同一广告内的不同链接
例子: googleAds
utm_campaign string

标识具体广告标识
例子: google
utm_source string

标识广告客户、广告网站
例子: www.shopline.com
ended_at string

结束时间
例子: 2022-12-15T09:00:00+08:00
form_data string

JSON的表单数据序列化为字符串
例子: {\"budget\":{\"frequency\":\"DAILY\",\"currency\":\"TWD\"},\"time\":{\"startTime\":1671275280000,\"endTime\":1671361680000}}
remote_id string required

【App】里面数据的唯一id
例子: 53e7f97e-8df5-4a6b-b672-5cda96b90821

状态码

更多状态码信息，参考 HTTP 状态码。

响应头

traceId

请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。

响应体

marketing_activityobject

营销拓展活动
remote_id string

【App】数据的唯一id
例子: 53e7f97e-8df5-4a6b-b672-5cda96b90821
status string

营销活动当前的状态，draft：草稿，failed：失败，active：生效，inactive：已完成，scheduled：已安排，paused：已暂停，deleted_externally：已在外部删除
例子: draft
utm_term string

标识搜索关键字
例子: this is utm term name
marketing_activity_title string

营销拓展活动标题
例子: This is marketing activity title
utm_source string

标识广告客户、广告网站
例子: www.shopline.com
marketing_activity_extension_id string

营销扩展id
例子: b1ee529b-d71d-41d6-93ba-ee46986d3a4b
marketing_activity_id string

营销拓展活动id
例子: MA_6019932248291157288
utm_medium string

标识来源类型（电子邮件，文章）
例子: email
form_data string

JSON的表单数据序列化为字符串
例子: {\"budget\":{\"frequency\":\"DAILY\",\"currency\":\"TWD\"},\"time\":{\"startTime\":1671275280000,\"endTime\":1671361680000}}
utm_content string

区分同一广告内的不同链接
例子: googleAds
ended_at string

结束时间
例子: 2022-12-15T09:00:00+08:00
started_at string

开始时间
例子: 2022-12-15T09:00:00+08:00
utm_campaign string

标识具体广告标识
例子: google

API Explorer

调试台

示例代码

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201

ParamOptions

Authorization — header required

Body

Body required

{
  "marketing_activity": {
    "remote_id": "53e7f97e-8df5-4a6b-b672-5cda96b90821",
    "utm_source": "www.shopline.com",
    "utm_campaign": "google",
    "utm_term": "this is utm term name",
    "ended_at": "2022-12-15T09:00:00+08:00",
    "status": "draft",
    "utm_content": "googleAds",
    "form_data": "{\\\"budget\\\":{\\\"frequency\\\":\\\"DAILY\\\",\\\"currency\\\":\\\"TWD\\\"},\\\"time\\\":{\\\"startTime\\\":1671275280000,\\\"endTime\\\":1671361680000}}",
    "started_at": "2022-12-15T09:00:00+08:00",
    "marketing_activity_id": "MA_6019932248291157288?",
    "marketing_activity_title": "This is marketing activity title",
    "utm_medium": "email",
    "marketing_activity_extension_id": "b1ee529b-d71d-41d6-93ba-ee46986d3a4b"
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201/sales/marketing_activity_extension.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

这篇文章对你有帮助吗？

SHOPLINE

条款协议