stack

Home > @infiniteobjects/shopify-data-manager > AdminTypes > MarketingEvent

AdminTypes.MarketingEvent interface

Represents actions that market a merchant’s store or products.

Signature:

export interface MarketingEvent extends LegacyInteroperability, Node 

Extends: LegacyInteroperability, Node

Properties

Property Modifiers Type Description
app   App The app that the marketing event is attributed to.
channel?   Maybe<MarketingChannel | `${MarketingChannel}`> (Optional) The marketing channel used by the marketing event.
description?   Maybe<Scalars[‘String’][‘output’]> (Optional) A human-readable description of the marketing event.
endedAt?   Maybe<Scalars[‘DateTime’][‘output’]> (Optional) The date and time when the marketing event ended.
id   Scalars[‘ID’][‘output’] A globally-unique ID.
legacyResourceId   Scalars[‘UnsignedInt64’][‘output’] The ID of the corresponding resource in the REST Admin API.
manageUrl?   Maybe<Scalars[‘URL’][‘output’]> (Optional) The URL where the marketing event can be managed.
previewUrl?   Maybe<Scalars[‘URL’][‘output’]> (Optional) The URL where the marketing event can be previewed.
remoteId?   Maybe<Scalars[‘String’][‘output’]> (Optional) An optional ID that helps Shopify validate engagement data.
scheduledToEndAt?   Maybe<Scalars[‘DateTime’][‘output’]> (Optional) The date and time when the marketing event is scheduled to end.
sourceAndMedium   Scalars[‘String’][‘output’] Where the MarketingEvent occurred and what kind of content was used. Because utmSource and utmMedium are often used interchangeably, this is based on a combination of marketingChannel, referringDomain, and type to provide a consistent representation for any given piece of marketing regardless of the app that created it.
startedAt   Scalars[‘DateTime’][‘output’] The date and time when the marketing event started.
targetTypeDisplayText   Scalars[‘String’][‘output’] The display text for the marketing event type.
type   MarketingTactic | `${MarketingTactic}` The marketing event type.
utmCampaign?   Maybe<Scalars[‘String’][‘output’]> (Optional) The name of the marketing campaign.
utmMedium?   Maybe<Scalars[‘String’][‘output’]> (Optional) The medium that the marketing campaign is using. Example values: cpc, banner.
utmSource?   Maybe<Scalars[‘String’][‘output’]> (Optional) The referrer of the marketing event. Example values: google, newsletter.