Marketing
Requires access scope.
Represents actions that market a merchant's store or products.
Anchor to FieldsFields
- •App!non-null
The app that the marketing event is attributed to.
- 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.
- Anchor to descriptiondescription•String
A human-readable description of the marketing event.
- Anchor to endedAtended•Date
At Time The date and time when the marketing event ended.
- •ID!non-null
A globally-unique ID.
- Anchor to legacyResourceIdlegacy•Unsigned
Resource Id Int64! non-null The ID of the corresponding resource in the REST Admin API.
- Anchor to manageUrlmanage•URL
Url The URL where the marketing event can be managed.
- Anchor to marketingChannelTypemarketing•Marketing
Channel Type Channel The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.
- Anchor to previewUrlpreview•URL
Url The URL where the marketing event can be previewed.
- Anchor to remoteIdremote•String
Id An optional ID that helps Shopify validate engagement data.
- Anchor to scheduledToEndAtscheduled•Date
To End At Time The date and time when the marketing event is scheduled to end.
- Anchor to sourceAndMediumsource•String!
And Medium non-null Where the
occurred and what kind of content was used. Becauseandare often used interchangeably, this is based on a combination of,, andtypeto provide a consistent representation for any given piece of marketing regardless of the app that created it.- Anchor to startedAtstarted•Date
At Time! non-null The date and time when the marketing event started.
- Anchor to typetype•Marketing
Tactic! non-null The marketing event type.
- Anchor to utmCampaignutm•String
Campaign The name of the marketing campaign.
- Anchor to utmMediumutm•String
Medium The medium that the marketing campaign is using. Example values:
cpc,banner.- Anchor to utmSourceutm•String
Source The referrer of the marketing event. Example values:
google,newsletter.
Deprecated fields
- Anchor to channelchannel•Marketing
Channel Deprecated - Anchor to targetTypeDisplayTexttarget•String!
Type Display Text non-nullDeprecated
Anchor to QueriesQueries
- •query
Returns a
resource by ID.- •ID!required
The ID of the
to return.
Arguments
- •ID!
- •query
A list of marketing events associated with the marketing app.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Marketing
Key Event Sort Keys Default:ID Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
Arguments