MarketingEvent - admin-graphql - OBJECT

Version: 2024-10

Description:

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

Access Scopes

`read_marketing_events` access scope.

Fields

• app: App! - The app that the marketing event is attributed to.
• channel: MarketingChannel - The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.
• channelHandle: String - The unique string identifier of the channel to which this activity belongs. For the correct handle for your channel, contact your partner manager.
• description: String - A human-readable description of the marketing event.
• endedAt: DateTime - The date and time when the marketing event ended.
• id: ID! - A globally-unique ID.
• legacyResourceId: UnsignedInt64! - The ID of the corresponding resource in the REST Admin API.
• manageUrl: URL - The URL where the marketing event can be managed.
• marketingChannelType: MarketingChannel - The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.
• 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.
• targetTypeDisplayText: String! - The display text for the marketing event type.
• 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`.

Connections

Related queries

• marketingEvent Returns a MarketingEvent resource by ID.
• marketingEvents A list of marketing events associated with the marketing app.

Related mutations

Related Unions

Examples

• Retrieves a single marketing event

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query MarketingEventShow { marketingEvent(id: \\\"gid://shopify/MarketingEvent/425025702\\\") { id type remoteId startedAt endedAt scheduledToEndAt manageUrl previewUrl utmCampaign utmMedium utmSource description marketingChannelType sourceAndMedium } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query MarketingEventShow {\n    marketingEvent(id: \"gid://shopify/MarketingEvent/425025702\") {\n      id\n      type\n      remoteId\n      startedAt\n      endedAt\n      scheduledToEndAt\n      manageUrl\n      previewUrl\n      utmCampaign\n      utmMedium\n      utmSource\n      description\n      marketingChannelType\n      sourceAndMedium\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query MarketingEventShow {\n    marketingEvent(id: \"gid://shopify/MarketingEvent/425025702\") {\n      id\n      type\n      remoteId\n      startedAt\n      endedAt\n      scheduledToEndAt\n      manageUrl\n      previewUrl\n      utmCampaign\n      utmMedium\n      utmSource\n      description\n      marketingChannelType\n      sourceAndMedium\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query MarketingEventShow {\n    marketingEvent(id: \"gid://shopify/MarketingEvent/425025702\") {\n      id\n      type\n      remoteId\n      startedAt\n      endedAt\n      scheduledToEndAt\n      manageUrl\n      previewUrl\n      utmCampaign\n      utmMedium\n      utmSource\n      description\n      marketingChannelType\n      sourceAndMedium\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query MarketingEventShow {\n    marketingEvent(id: \"gid://shopify/MarketingEvent/425025702\") {\n      id\n      type\n      remoteId\n      startedAt\n      endedAt\n      scheduledToEndAt\n      manageUrl\n      previewUrl\n      utmCampaign\n      utmMedium\n      utmSource\n      description\n      marketingChannelType\n      sourceAndMedium\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query MarketingEventShow {\n  marketingEvent(id: \"gid://shopify/MarketingEvent/425025702\") {\n    id\n    type\n    remoteId\n    startedAt\n    endedAt\n    scheduledToEndAt\n    manageUrl\n    previewUrl\n    utmCampaign\n    utmMedium\n    utmSource\n    description\n    marketingChannelType\n    sourceAndMedium\n  }\n}"
        

  input: null

  response: {
    "data": {
      "marketingEvent": {
        "id": "gid://shopify/MarketingEvent/425025702",
        "type": "NEWSLETTER",
        "remoteId": null,
        "startedAt": "2024-11-08T20:47:51Z",
        "endedAt": null,
        "scheduledToEndAt": null,
        "manageUrl": null,
        "previewUrl": null,
        "utmCampaign": "asdf",
        "utmMedium": "newsletter",
        "utmSource": "email",
        "description": null,
        "marketingChannelType": "EMAIL",
        "sourceAndMedium": "Email newsletter"
      }
    }
  }