MarketingActivityCreateExternalInput
The input fields for creating an externally-managed marketing activity.
Anchor to FieldsFields
- Anchor to adSpendad•
Spend The amount spent on the marketing activity.
- Anchor to budgetbudget•
The budget for this marketing activity.
- Anchor to channelHandlechannel•
Handle The unique string identifier of the channel to which this activity belongs. For the correct handle for your channel, contact your partner manager.
- •
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•
Level The hierarchy level of the activity within a campaign. The hierarchy level can't be updated.
- Anchor to marketingChannelTypemarketing•
Channel Type MarketingChannel! non-null The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.
- Anchor to parentActivityIdparent•
Activity Id The ID for the parent marketing activity, if creating hierarchical activities.
- Anchor to parentRemoteIdparent•
Remote Id The remote ID for the parent marketing activity, if creating hierarchical activities.
- Anchor to referringDomainreferring•
Domain The domain from which ad clicks are forwarded to the shop.
- Anchor to remoteIdremote•
Id The ID of an activity that's hosted outside of Shopify.
- Anchor to remotePreviewImageUrlremote•
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•
End The date and time at which the activity is scheduled to end.
- Anchor to scheduledStartscheduled•
Start The date and time at which the activity is scheduled to start.
- Anchor to startstart•
The date and time at which the activity started. If omitted or set to
null, the current time will be used.- Anchor to statusstatus•
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•
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.
- •
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 The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation. This field was renamed for clarity, please switch to using marketingChannelType when migrating to the latest API version.