MarketingEvent

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

Show definition

# Represents actions that market a merchant's store or products.
type MarketingEvent implements LegacyInteroperability & Node {
  # The app that the marketing event is attributed to.
  app: App!

# The marketing channel used by the marketing event. channel: MarketingChannel

# A human-readable description of the marketing event. description: String

# The date and time when the marketing event ended. endedAt: DateTime

# Globally unique identifier. id: ID!

# The ID of the corresponding resource in the REST Admin API. legacyResourceId: UnsignedInt64!

# The URL where the marketing event can be managed. manageUrl: URL

# The URL where the marketing event can be previewed. previewUrl: URL

# An optional ID that helps Shopify validate engagement data. remoteId: String

# The date and time when the marketing event is scheduled to end. scheduledToEndAt: DateTime

# 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. sourceAndMedium: String!

# The date and time when the marketing event started. startedAt: DateTime!

# The display text for the marketing event type. targetTypeDisplayText: String!

# The marketing event type. type: MarketingTactic!

# The name of the marketing campaign. utmCampaign: String

# The medium that the marketing campaign is using. Example values: cpc, banner. utmMedium: String

# The referrer of the marketing event. Example values: google, newsletter. utmSource: String }

Implements

Fields

app   (App!)

The app that the marketing event is attributed to.

channel   (MarketingChannel)

The marketing channel used by the marketing event.

description   (String)

A human-readable description of the marketing event.

endedAt   (DateTime)

The date and time when the marketing event ended.

id   (ID!)

Globally unique identifier.

legacyResourceId   (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.

manageUrl   (URL)

The URL where the marketing event can be managed.

previewUrl   (URL)

The URL where the marketing event can be previewed.

remoteId   (String)

An optional ID that helps Shopify validate engagement data.

scheduledToEndAt   (DateTime)

The date and time when the marketing event is scheduled to end.

sourceAndMedium   (String!)

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   (DateTime!)

The date and time when the marketing event started.

type   (MarketingTactic!)

The marketing event type.

utmCampaign   (String)

The name of the marketing campaign.

utmMedium   (String)

The medium that the marketing campaign is using. Example values: cpc, banner.

utmSource   (String)

The referrer of the marketing event. Example values: google, newsletter.

Deprecated fields

Show/Hide

targetTypeDisplayText   (String!)

deprecated

The display text for the marketing event type.

Deprecation warning

Use sourceAndMedium instead

Sign up for a Partner account to get started.

Sign up