stack

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

AdminTypes.MarketingActivity interface

The marketing activity resource represents marketing that a merchant created through an app.

Signature:

export interface MarketingActivity extends Node 

Extends: Node

Properties

Property Modifiers Type Description
activityListUrl?   Maybe<Scalars[‘URL’][‘output’]> (Optional) The URL of the marketing activity listing page in the marketing section.
adSpend?   Maybe<MoneyV2> (Optional) The amount spent on the marketing activity.
app   App The app which created this marketing activity.
appErrors?   Maybe<MarketingActivityExtensionAppErrors> (Optional) The errors generated when an app publishes the marketing activity.
budget?   Maybe<MarketingBudget> (Optional) The allocated budget for the marketing activity.
createdAt   Scalars[‘DateTime’][‘output’] The date and time when the marketing activity was created.
formData?   Maybe<Scalars[‘String’][‘output’]> (Optional) The completed content in the marketing activity creation form.
id   Scalars[‘ID’][‘output’] A globally-unique ID.
inMainWorkflowVersion   Scalars[‘Boolean’][‘output’] Whether the marketing activity is in the main workflow version of the marketing automation.
marketingChannel   MarketingChannel | `${MarketingChannel}` The available marketing channels for a marketing activity.
marketingEvent?   Maybe<MarketingEvent> (Optional) Associated marketing event of this marketing activity.
sourceAndMedium   Scalars[‘String’][‘output’] A contextual description of the marketing activity based on the platform and tactic used.
status   MarketingActivityStatus | `${MarketingActivityStatus}` The current state of the marketing activity.
statusBadgeType?   Maybe<MarketingActivityStatusBadgeType | `${MarketingActivityStatusBadgeType}`> (Optional) The severity of the marketing activity’s status.
statusBadgeTypeV2?   Maybe<BadgeType | `${BadgeType}`> (Optional) The severity of the marketing activity’s status.
statusLabel   Scalars[‘String’][‘output’] The rendered status of the marketing activity.
statusTransitionedAt?   Maybe<Scalars[‘DateTime’][‘output’]> (Optional) The [date and time]( https://help.shopify.com/https://en.wikipedia.org/wiki/ISO_8601 ) when the activity’s status last changed.
tactic   MarketingTactic | `${MarketingTactic}` The method of marketing used for this marketing activity.
targetStatus?   Maybe<MarketingActivityStatus | `${MarketingActivityStatus}`> (Optional) The status to which the marketing activity is currently transitioning.
title   Scalars[‘String’][‘output’] The marketing activity’s title, which is rendered on the marketing listing page.
updatedAt   Scalars[‘DateTime’][‘output’] The date and time when the marketing activity was updated.
utmParameters?   Maybe<UtmParameters> (Optional) The set of [Urchin Tracking Module]( https://help.shopify.com/https://en.wikipedia.org/wiki/UTM_parameters ) used in the URL for tracking this marketing activity.