促销活动

促销活动

营销事件表示您的应用程序代表商家采取的用于营销产品，收藏，折扣，页面，博客文章和其他功能的操作。营销事件代表针对多个潜在客户而非特定个人的行动。例如，您应该在电子邮件活动级别而不是每个电子邮件上对营销事件建模。

营销活动包括event_type和marketing_channel 属性，可帮助Shopify对您的应用进行排名并以对商家有用的方式在Shopify管理员中显示您的应用。通过为您的营销活动提供UTM参数来处理应用的点击量和订单归因。营销活动中提供的链接中也使用了相同的UTM参数。还可以将参与度添加到营销活动中，以使商家更深入地了解潜在客户如何与您的营销活动进行交互。例如，广告系列的参与度可以包括点击，分享和评论。

您可以使用MarketingEvent做什么

Shopify API使您可以使用MarketingEvent资源执行以下操作。这些常规操作的更详细的版本可能可用：

MarketingEvent属性

remote_id	`plain "remote_id": "123abc"` 市场活动的可选远程标识符。远程标识符使Shopify可以验证参与数据。
事件类型必需的	`plain "event_type": "ad"` 营销活动的类型。有效值：`ad`，`post`，`message`，`retargeting`，`transactional`，`affiliate`，`loyalty`，`newsletter`，`abandoned_cart`。笔记如果您要使用的值不属于上面列出的event_type，请在此处发布您的请求。我们的方法要比使用自由格式的文本更具结构性，但仍允许对大多数类型的营销活动进行分类。
marketing_channel 必需的	`plain "marketing_channel": "social"` 您的营销活动将使用的渠道。有效值：`search`，`display`，`social`，`email`，`referral`。
有薪酬的必需的	`plain "paid": true` 活动是付费的还是自然的。
referring_domain	`plain "referring_domain": "facebook.com"` 营销事件的目标域。如果将`marketing_channel`设置为`search`或，则为必需`social`。
预算	`plain "budget": 10.75` 广告系列的预算。
货币	`plain "currency": "USD"` 预算货币。如果`budget`指定，则为必需。
budget_type	`plain "budget_type": "lifetime"` 预算类型。如果`budget`指定，则为必需。有效值：`daily`，`lifetime`‘。
starts_at 必需的	`plain "started_at": "2021-01-15T11:56:18-04:00"` 营销活动开始的时间。
Scheduled_to_end_at	`plain "scheduled_to_end_at": "2021-01-22T11:56:18-04:00"` 对于具有持续时间的事件，指事件计划结束的时间。
end_at	`plain "ended_at": "2021-01-20T11:56:18-04:00"` 对于具有持续时间的事件，该事件实际结束的时间。
UTM参数	`plain "marketing_event": { "utm_campaign": "CanadaDay2021", "utm_source": "facebook", "utm_medium": "cpc" }` 市场活动中提供的链接中使用的UTM参数。值必须是唯一的，并且不应进行url编码。要做到业务或订单的归属，你必须至少定义`utm_campaign`，`utm_source`和`utm_medium`。
描述	`plain "description": "Facebook carousel ad #{Time.now.utc.year}"` 营销事件的描述。
manage_url	`plain "manage_url": "https://mymarketingapp.com/ad/1234"` 管理营销活动的链接。在大多数情况下，这会链接到创建事件的应用程序。
预览网址	`plain "preview_url": "https://www.facebook.com/123456/"` 指向事件的实时版本或创建该事件的应用程序中的渲染预览的链接。
marketed_resources	`plain "marketed_resources": [ { "type": "product", "id": 12345 } ]` 营销活动中营销的项目列表。包括`type`和`id`的每个项目。有效值为`type`： + `product` + `collection` + `price_rule` + `discount` （在2017年4月20日之后将由price_rule代替。） + `page` + `article` + `homepage`（没有`id`。）

终点

得到/admin/api/2021-01/marketing_events.json 检索所有营销事件的列表。注意：从2019-10版本开始，此端点通过使用响应标头中提供的链接来实现分页。发送<font style="background-color:#F4F6F8;">page</font>参数将返回错误。要了解更多信息，请参阅向分页的REST Admin API端点发出请求。

限制	返回的结果量。（默认值：`50` 最大：`250` ）
抵消	要跳过的营销事件数。

检索所有营销事件

GET /admin/api/2021-01/marketing_events.json

查看回应

得到/admin/api/2021-01/marketing_events/count.json 检索所有营销事件的计数

检索所有营销事件的计数

GET /admin/api/2021-01/marketing_events/count.json

查看回应

得到/admin/api/2021-01/marketing_events/{marketing_event_id}.json 检索一次营销活动

通过ID检索单个营销事件

GET /admin/api/2021-01/marketing_events/998730532.json

查看回应

邮政/admin/api/2021-01/marketing_events.json 创建营销活动

创建营销活动

POST /admin/api/2021-01/marketing_events.json

{

“ marketing_event” ： {

“started_at” ：“2021年12月15日”，
“ utm_campaign” ：“ Christmas2021”，
“ utm_source” ：“ facebook”，
“ utm_medium” ：“ cpc”，
“ event_type” ：“ ad”，
“ referring_domain” ：“ facebook.com”，
“ marketing_channel” ：“社交”，
“付费” ：true

}

查看回应

放/admin/api/2021-01/marketing_events/{marketing_event_id}.json 更新营销活动

更新营销活动。只能修改时间戳，remote_id和预算/货币。

PUT /admin/api/2021-01/marketing_events/998730532.json

{

“ marketing_event” ： {

“ id” ：998730532，
“ remote_id” ：“ 1000：2000”，
“ started_at” ：“ 2021-02-02T00：00 +00：00”，
“ ended_at” ：“ 2021-02-03T00 ：00 +00：00”，
“ scheduled_to_end_at” ：“ 2021-02-04T00：00 +00：00”，
“预算” ：“ 11.1”，
“ budget_type” ：“每日”，
“ currency” ：“ CAD”，
“ utm_campaign” ：“其他”，
“ utm_source” ：“其他”，
“ utm_medium” ：“其他”，
“ event_type” ：“ ad”，
“ referring_domain” ：“ instagram.com”

}

查看回应

删除/admin/api/2021-01/marketing_events/{marketing_event_id}.json 删除营销活动

删除营销活动

删除/admin/api/2021-01/marketing_events/998730532.json

查看回应

邮政/admin/api/2021-01/marketing_events/{marketing_event_id}/engagements.json

对营销活动的参与表示在客户到达商店网站之前针对营销事件进行的客户活动。并非所有类型的营销事件都必须具有参与度，并且大多数类型的营销事件将仅使用可能的参与类型的子集。

参与度每天汇总。但是，如果有可用信息，则每天发送数据的次数可能会超过每天一次。如果您创建的参与度与occurred_on现有参与度具有相同的值，则新的参与度将覆盖先前的参与度。

发生必需的	参与这些活动的日期，格式为“ YYYY-MM-DD”。
impressions_count	当天的总展示次数。当通过电子邮件或通过营销渠道将营销事件提供给客户时，就会产生印象。
views_count	一天的总观看次数。当客户阅读向他们提供的营销事件时，例如，如果客户打开电子邮件或花时间看Facebook帖子，就会发生视图。
clicks_count	当天营销活动的总点击次数。
share_count	当天的股份总数。
favorite_count	当天收藏夹的总数。
comments_count	当天的评论总数。
ad_spend	如果行销活动是每日支出的付费广告，则当天的总广告支出。
is_cumulative	参与度是否报告为生命周期值而不是每日总计。

将参与添加到营销参与中

POST /admin/api/2021-01/marketing_events/998730532/engagements.json

{

“参与度” ： [

{
  “ occurred_on” ：“ 2021-01-15”，
  “ views_count” ：0，
  “ clicks_count” ：0，
  “ favorites_count” ：0，
  “ ad_spend” ：10.0，
  “ is_cumulative” ：true
}，
{
  “ occurred_on” ：“ 2021-01-16”，
  “ views_count” ：100，
  “ clicks_count” ：50，
  “ is_cumulative” ：true
}，
{
  “ occurred_on” ：“ 2021-01-17”，
  “ views_count” ：200，
  “ clicks_count” ：100，
  “ is_cumulative” ：true
}

]

}

查看回应