Creates a marketing event

POST

/admin/api/{api_version}/marketing_events.json

Marketing events can be created to track ad campaigns that target a specific time of year. For example, a marketing event can be created to track a Facebook ad campaign
for Christmas 2022. When creating the marketing event, the body of the request includes the UTM parameters that must be included in the links provided in the marketing event.
Each marketing event also includes the event_type and marketing_channel properties that help Shopify to rank your app and surface it within
Shopify admin.

After a marketing event is created in Shopify, you can start to drive traffic to Shopify. Make sure that the links for the marketing event contain the same
UTM parameters that were defined in the marketing event. For example, marketing activities for the Christmas 2022 ad campaign would use the following URL convention:

https://storename.com/product?utm_source=facebook&utm_medium=cpc&utm_campaign=Christmas2022-12142018

请求参数

Path 参数

api_version

string

必需

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢201Creates a marketing event

application/json

Body

marketing_event

object (MarketingEvent)

可选

remote_id

string

可选

An optional remote identifier for a marketing event. The remote identifier lets Shopify validate engagement data.

event_type

string

必需

The type of marketing event. Valid values: ad, post, message, retargeting, transactional, affiliate, loyalty, newsletter, abandoned_cart.

Note

If there are values that you’d like to use for event_type that are not in the list above, then please post your request here. Our approach is to be more structured than using freeform text, but to still allow for categorization of most types of marketing actions.

marketing_channel

string

必需

The channel that your marketing event will use. Valid values: search, display, social, email, referral.

paid

string

必需

Whether the event is paid or organic.

referring_domain

string

可选

The destination domain of the marketing event. Required if the marketing_channel is set to search or social.

budget

string

可选

The budget of the ad campaign.

currency

string

可选

The currency for the budget. Required if budget is specified.

budget_type

string

可选

The type of the budget. Required if budget is specified. Valid values: daily, lifetime.'

started_at

string

必需

The time when the marketing action was started.

scheduled_to_end_at

string

可选

For events with a duration, the time when the event was scheduled to end.

ended_at

string

可选

For events with a duration, the time when the event actually ended.

UTM parameters

string

可选

The UTM parameters used in the links provided in the marketing event. Values must be unique and should not be url-encoded.

To do traffic or order attribution you must at least define utm_campaign, utm_source, and utm_medium.

description

string

可选

A description of the marketing event.

manage_url

string

可选

A link to manage the marketing event. In most cases, this links to the app that created the event.

preview_url

string

可选

A link to the live version of the event, or to a rendered preview in the app that created it.

marketed_resources

string

可选

A list of the items that were marketed in the marketing event. Includes the type and id of each item. Valid values for type are:

product
collection
price_rule
discount (Will be replaced by price_rule after April 20, 2017.)
page
article
homepage (Doesn't have an id.)

示例值:

{"type":"product","id":12345}

示例

{
  "marketing_event": {
    "id": 1069063883,
    "event_type": "ad",
    "remote_id": null,
    "started_at": "2023-12-14T19:00:00-05:00",
    "ended_at": null,
    "scheduled_to_end_at": null,
    "budget": null,
    "currency": null,
    "manage_url": null,
    "preview_url": null,
    "utm_campaign": "Christmas2023",
    "utm_source": "facebook",
    "utm_medium": "cpc",
    "budget_type": null,
    "description": null,
    "marketing_channel": "social",
    "paid": true,
    "referring_domain": "facebook.com",
    "breadcrumb_id": null,
    "marketing_activity_id": 1063897333,
    "admin_graphql_api_id": "gid://shopify/MarketingEvent/1069063883",
    "marketed_resources": []
  }
}

修改于 2023-01-29 12:00:31

Retrieves a list of all marketing events

Retrieves a count of all marketing events