MarketingActivity

A marketing activity represents marketing created by an app on behalf of the merchant.

Show definition

# A marketing activity represents marketing created by an app on behalf of the merchant.
type MarketingActivity implements Node {
  # Amount spent on this marketing activity.
  adSpend: MoneyV2

# The app which created this marketing activity. app: App!

# Errors generated when app was trying to complete this activity. appErrors: MarketingActivityExtensionAppErrors

# The budget for this marketing activity. budget: MarketingBudget

# The date and time when the marketing activity was created. createdAt: DateTime!

# Globally unique identifier. id: ID!

# The broad category of marketing, used for reporting aggregation. marketingChannel: MarketingChannel!

# Associated marketing event of this marketing activity. marketingEvent: MarketingEvent

# A contextual description of the marketing activity based on the platform and tactic used. sourceAndMedium: String!

# Status helps to identify if this marketing activity has been completed, queued, failed etc. status: MarketingActivityStatus!

# The method of marketing used for this marketing activity. tactic: MarketingTactic!

# Expected status set by app in prior to an asynchronous operation. targetStatus: MarketingActivityStatus

# Title of this marketing activity. title: String!

# The date and time when the marketing activity was updated. updatedAt: DateTime!

# The set of UTM parameters being tracked for this marketing activity. utmParameters: UTMParameters }

Implements

Fields

adSpend   (MoneyV2)

Amount spent on this marketing activity.

app   (App!)

The app which created this marketing activity.

appErrors   (MarketingActivityExtensionAppErrors)

Errors generated when app was trying to complete this activity.

budget   (MarketingBudget)

The budget for this marketing activity.

createdAt   (DateTime!)

The date and time when the marketing activity was created.

id   (ID!)

Globally unique identifier.

marketingChannel   (MarketingChannel!)

The broad category of marketing, used for reporting aggregation.

marketingEvent   (MarketingEvent)

Associated marketing event of this marketing activity.

sourceAndMedium   (String!)

A contextual description of the marketing activity based on the platform and tactic used.

status   (MarketingActivityStatus!)

Status helps to identify if this marketing activity has been completed, queued, failed etc.

tactic   (MarketingTactic!)

The method of marketing used for this marketing activity.

targetStatus   (MarketingActivityStatus)

Expected status set by app in prior to an asynchronous operation.

title   (String!)

Title of this marketing activity.

updatedAt   (DateTime!)

The date and time when the marketing activity was updated.

utmParameters   (UTMParameters)

The set of UTM parameters being tracked for this marketing activity.

Sign up for a Partner account to get started.

Sign up