Managing a marketing activity extension

This section covers how to create and manage a marketing activity extension from your Partner Dashboard. When you create a marketing extension you provide the extension information, set up the extension preview, and create the configuration fields.

Add a marketing activity extension

  1. From your Partner Dashboard, click Apps.
  2. Click the name of the app that you want to change.
  3. Click Extensions.
  4. Under Marketing activities, click Add marketing activity.
  5. Provide an Activity title and Description.
  6. For Base API path, enter the URL where your app's endpoints are hosted.
  7. Specify the Marketing tactic. The marketing tactic determines settings for Marketing platform and Ad format. The selection of the marketing tactic also determines which default fields are included in the marketing activity. This is described in more detail in Marketing tactic.
  8. Provide the Extension preview settings using Label and Value. You can add a maximum of three preview tabs.
  9. Add the configuration fields.

Marketing tactic

When you create a marketing activity, you can define the tactic and its corresponding marketing platform and ad format:

  • Tactic: Type of marketing action to be taken.
  • Marketing platform: Marketing platform where the action is executed. Tactic determines specific marketing platforms.
  • Ad format: Format in which the ad is delivered. Not all tactics include an Ad format.

The selection of the marketing tactic also determines which default fields are included in the marketing activity. The following table describes the supported fields for the marketing tactics:

Tactic Available marketing platforms Available ad formats
Ad Facebook Carousel ad, Link ad, Dynamic ad
Instagram Carousel ad, Link ad
Google Shopping campaign
Bing Shopping campaign
Snapchat Story
Pinterest Shopping campaign, Link ad
Retargeting Facebook Retargeting
Facebook, Instagram, Google, Pinterest, Bing, Yahoo NA
Post Facebook, Instagram, Pinterest NA
Message Facebook, SMS NA
Transactional Email NA
Newsletter Email NA
Abandoned cart Email NA
Affiliate NA NA
Loyalty NA NA
Link NA NA
Storefront app NA NA

Extension preview

You can use your app's preload endpoint to render what your app's marketing extension will look like on desktop, mobile, or another device.

An example of an extension preview.

Configuration fields

Configuration fields define the marketing activity form that is displayed to merchants in Shopify admin. You can use the steps below to create configuration fields.

Steps:

  1. Click Create field.
  2. On the Add components dialog, select the component that you want to add to your form. Each component has different requirements. To learn more about how to configure a component, see the Marketing activity components reference.
  3. Enter the required information.

Add a divider

You can add a divider to group your app's configuration fields into sections. It's best practice to group fields into sections for longer app forms.

Steps:

  1. In the Configuration fields section hover over any blank space in-between the configuration field cards.
  2. Click on Add title for divider.
  3. Provide a title for the section.
  4. Click anywhere outside the title to save the new section. After the section is saved, a blue box appears around the section so you can easily see which fields are grouped. The section title and grouped fields are visible to the merchant.

An example of an extension preview.

Update a marketing activity extension

You can update a marketing activity extension from your Partner Dashboard. You can modify your app extension by adding, removing, setting, and ordering components. To learn more about the marketing activity components, see the Marketing activity components reference.

We recommend that you limit modifications to cosmetic changes, such as:

  • updating the extension's description
  • changing the components' ordering
  • updating a field's label or placeholder text
  • adding a new title and body display text component

Steps:

  1. From your Partner Dashboard, click Apps.
  2. Click the name of the app that you want to change.
  3. From the app's page, click Extensions.
  4. In the Marketing activities section, select marketing activity that you want to update.
  5. On the Marketing activity page, enter the new information to the field you want to update.
  6. If you want to add new title and body display text component to the form, then click Create field and choose the component.
  7. If you want to reorder fields in marketing activity form, then click and drag the fields to your desired location.
  8. Click Save.

Deprecate a marketing activity extension

You can deprecate a marketing activity extension from your Partner Dashboard when the extension is no longer supported by your app. The steps below guide you through the recommended gradual deprecation process.

Steps:

  1. Start informing merchants about the incoming deprecation through app banners.
  2. Hide the extension.
  3. Support the activity for the next 6 months (recommended).
  4. After 6 months, start updating the old marketing activities with the DISCONNECTED status and error messages, informing merchants that the marketing activity is no longer supported.

Merchants see old marketing activities with the DISCONNECTED status and error message on the marketing activity index page.

  1. Disable the extension.

Hide a marketing activity extension

If you've created a marketing activity extension for you app, but you don't want merchants to be able to use it, you can hide the extension from your Partner Dashboard. There are a few different reasons for hiding an extension:

  • The app that supports the extension is unstable, and you want to temporarily prevent merchants from using it to create marketing activities.
  • The extension is being deprecated or replaced with a new version.

Steps:

  1. In your Partner Dashboard, click Apps, and then click the name of the app whose extension you want to hide.
  2. Click Extensions.
  3. In the Marketing activities section, click the name of the marketing activity that you want to hide.
  4. Click Change status.
  5. On the Change activity status dialog, select Hide activity.
  6. Click Save.

Disable a marketing activity extension

If an extension is being deprecated or replaced with a new version, then you can disable the extension from your Partner Dashboard.

Steps:

  1. From your Partner Dashboard, click Apps.
  2. Click the name of the app that you want to change.
  3. Click Extensions.
  4. In the Marketing activities section, select marketing activity that you want to disable.
  5. Click Change status.
  6. On the Change activity status modal, click Disable activity.
  7. Click Save.

Sign up for a Partner account to get started.

Sign up