Marketing
The input fields for creating an externally-managed marketing activity.
Anchor to FieldsFields
- Anchor to adSpendad•Money
Spend Input The amount spent on the marketing activity.
- Anchor to budgetbudget•Marketing
Activity Budget Input The budget for this marketing activity.
- Anchor to channelHandlechannel•String
Handle The unique string identifier of the channel to which this activity belongs. For the correct handle for your channel, contact your partner manager.
- •Date
Time The date and time at which the activity ended. If omitted or set to
null, the current time will be used if the status is set toor.- Anchor to hierarchyLevelhierarchy•Marketing
Level Activity Hierarchy Level The hierarchy level of the activity within a campaign. The hierarchy level can't be updated.
- Anchor to marketingChannelTypemarketing•Marketing
Channel Type Channel! non-null The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.
- Anchor to parentActivityIdparent•ID
Activity Id The ID for the parent marketing activity, if creating hierarchical activities.
- Anchor to parentRemoteIdparent•String
Remote Id The remote ID for the parent marketing activity, if creating hierarchical activities.
- Anchor to referringDomainreferring•String
Domain The domain from which ad clicks are forwarded to the shop.
- Anchor to remoteIdremote•String
Id A custom unique identifier for the marketing activity, which can be used to manage the activity and send engagement metrics without having to store our marketing activity ID in your systems.
- Anchor to remotePreviewImageUrlremote•URL
Preview Image Url The URL for a preview image that's used for the marketing activity.
- Anchor to remoteUrlremote•URL!
Url non-null The URL for viewing and/or managing the activity outside of Shopify.
- Anchor to scheduledEndscheduled•Date
End Time The date and time at which the activity is scheduled to end.
- Anchor to scheduledStartscheduled•Date
Start Time The date and time at which the activity is scheduled to start.
- Anchor to startstart•Date
Time The date and time at which the activity started. If omitted or set to
null, the current time will be used.- Anchor to statusstatus•Marketing
Activity External Status The status of the marketing activity. If status isn't set it will default to UNDEFINED.
- Anchor to tactictactic•Marketing
Tactic! non-null The method of marketing used for this marketing activity. The marketing tactic determines which default fields are included in the marketing activity.
- Anchor to titletitle•String!non-null
The title of the marketing activity.
- Anchor to urlParameterValueurl•String
Parameter Value Value for a query parameter that gets inserted into storefront URLs for matching storefront traffic to this activity. This feature is currently available on a limited basis to some partners only. UTMs should continue to be used for most partners. Both the URL parameter value and UTM parameters can be set.
- •UTMInput
Specifies the Urchin Traffic Module (UTM) parameters that are associated with a related marketing campaign. Either the URL parameter value or UTM can be set, but not both.
- Anchor to channelchannel•Marketing
Channel Deprecated