https://ads-api-reddit.netlify.app/assets/js/ecb2461d.afaa072a.js

1"use strict";(self.webpackChunkreddit_ads_api_site=self.webpackChunkreddit_ads_api_site||[]).push([[3826],{47136:(e,i,s)=>{s.r(i),s.d(i,{assets:()=>t,contentTitle:()=>l,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>o});const d=JSON.parse('{"id":"guides/programs/campaign/campaign-objective-migration","title":"Campaign Objective Migration","description":"Learn how Reddit Ads API campaign objectives are changing on September 30, with legacy-to-new enum mappings and guidance for integrations.","source":"@site/docs/guides/programs/campaign/campaign-objective-migration.md","sourceDirName":"guides/programs/campaign","slug":"/guides/programs/campaign/campaign-objective-migration","permalink":"/docs/v3/guides/programs/campaign/campaign-objective-migration","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":4,"frontMatter":{"title":"Campaign Objective Migration","description":"Learn how Reddit Ads API campaign objectives are changing on September 30, with legacy-to-new enum mappings and guidance for integrations.","sidebar_position":4,"learn_more":{"defaultTab":"endpoints","tabs":[{"label":"Endpoints","value":"endpoints","path":"/docs/v3/api/reddit-advertising-api","ids":["/docs/v3/api/campaigns","/docs/v3/api/ad-groups","/docs/v3/api/list-ads","/docs/v3/guides/programs/capi","/docs/v3/guides/programs/product-catalogs"]},{"label":"Campaign Objectives","value":"objectives","path":"https://business.reddithelp.com/s/article/Ad-campaign-objectives","ids":["https://business.reddithelp.com/s/article/Conversion-Goals","https://business.reddithelp.com/s/article/catalogs","https://business.reddithelp.com/s/article/About-Reddit-Ads-conversion-tracking"]}]}},"sidebar":"tutorialSidebar","previous":{"title":"Preview an Ad","permalink":"/docs/v3/guides/programs/campaign/preview-an-ad"},"next":{"title":"Conversions API","permalink":"/docs/v3/guides/programs/capi/"}}');var n=s(74848),c=s(28453);const r={title:"Campaign Objective Migration",description:"Learn how Reddit Ads API campaign objectives are changing on September 30, with legacy-to-new enum mappings and guidance for integrations.",sidebar_position:4,learn_more:{defaultTab:"endpoints",tabs:[{label:"Endpoints",value:"endpoints",path:"/docs/v3/api/reddit-advertising-api",ids:["/docs/v3/api/campaigns","/docs/v3/api/ad-groups","/docs/v3/api/list-ads","/docs/v3/guides/programs/capi","/docs/v3/guides/programs/product-catalogs"]},{label:"Campaign Objectives",value:"objectives",path:"https://business.reddithelp.com/s/article/Ad-campaign-objectives",ids:["https://business.reddithelp.com/s/article/Conversion-Goals","https://business.reddithelp.com/s/article/catalogs","https://business.reddithelp.com/s/article/About-Reddit-Ads-conversion-tracking"]}]}},l=void 0,t={},o=[{value:"Objective-specific changes",id:"objective-specific-changes",level:2}];function a(e){const i={a:"a",admonition:"admonition",code:"code",h2:"h2",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,c.R)(),...e.components},{TabItem:s,Tabs:d}=i;return s||j("TabItem",!0),d||j("Tabs",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.p,{children:"On September 30th, Reddit will roll out updated campaign objective values to align more closely with industry naming and conventions."}),"\n",(0,n.jsx)(i.p,{children:"Although legacy enums will continue to be supported for the foreseeable future, developers are recommended to use the following guidance to minimize disruptions to existing integrations."}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Legacy enum"}),(0,n.jsx)(i.th,{children:"New enum"}),(0,n.jsx)(i.th,{children:"Optimization goals"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"IMPRESSIONS"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"BRAND_AWARENESS"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"null"})})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"VIDEO_VIEWABLE_IMPRESSIONS"})}

1),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"BRAND_AWARENESS"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"VIDEO_VIEW_6S"})})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"CONVERSIONS"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"SALES"})}),(0,n.jsx)(i.td,{children:(0,n.jsxs)("ul",{children:[(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"CLICKS"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"PURCHASE"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"ADD_TO_CART"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"PAGE_VISIT"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"SIGN_UP"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"ADD_TO_WISHLIST"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"VIEW_CONTENT"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"LEAD"})})]})})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"CATALOG_SALES"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"SALES"})}),(0,n.jsx)(i.td,{children:(0,n.jsxs)("ul",{children:[(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"CLICKS"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"PURCHASE"})})]})})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"LEAD_GENERATION"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"LEAD_GENERATION"})}),(0,n.jsx)(i.td,{children:(0,n.jsxs)("ul",{children:[(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"LEAD"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"SIGN_UP"})})]})})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"CLICKS"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"CLICKS"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"CLICKS"})})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"APP_INSTALLS"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"APP_INSTALLS"})}),(0,n.jsx)(i.td,{children:(0,n.jsxs)("ul",{children:[(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"MOBILE_CONVERSION_INSTALL"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"MOBILE_CONVERSION_SIGN_UP"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"MOBILE_CONVERSION_ADD_PAYMENT_INFO"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"MOBILE_CONVERSION_ADD_TO_CART"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"MOBILE_CONVERSION_PURCHASE"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"MOBILE_CONVERSION_COMPLETED_TUTORIAL"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"MOBILE_CONVERSION_LEVEL_ACHIEVED"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"MOBILE_CONVERSION_SPEND_CREDITS"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"MOBILE_CONVERSION_REINSTALL"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"MOBILE_CONVERSION_UNLOCK_ACHIEVEMENT"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"MOBILE_CONVERSION_START_TRIAL"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"MOBILE_CONVERSION_SUBSCRIBE"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"MOBILE_CONVERSION_ONBOARD_STARTED"})}),(0,n.jsx)("li",{children:(0,n.jsx)(i.code,{children:"MOBILE_CONVERSION_FIRST_TIME_PURCHASE"})})]})})]})]})]}),"\n",(0,n.jsx)(i.h2,{id:"objective-specific-changes",children:"Objective-specific changes"}),"\n",(0,n.jsxs)(d,{children:[(0,n.jsx)(s,{value:"catalog",label:"Catalog",default:!0,children:(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"objective"})," must be ",(0,n.jsx)(i.code,{children:"SALES"}),"."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"use_catalog=true"})," is required to use a product catalog. When this value is set, ",(0,n.jsx)(i.code,{children:"product_set_id"})," must also be set for all ad groups in the campaign. Catalog usage applies uniformly across ad groups in a ",(0,n.jsx)(i.code,{children:"SALES"})," campaign: either every ad group uses one, or none do."]}),"\n",(0,n.jsxs)(i.li,{children:["Depending on the ",(0,n.jsx)(i.co

1de,{children:"optimization_goal"})," set:","\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"PURCHASE"}),": ",(0,n.jsx)(i.code,{children:"view_through_conversion_type"})," must be set to ",(0,n.jsx)(i.code,{children:"SEVEN_DAY_CLICKS_ONE_DAY_VIEW"})]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"CLICKS"}),": ",(0,n.jsx)(i.code,{children:"view_through_conversion_type"})," must be ",(0,n.jsx)(i.code,{children:"null"}),"."]}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"shopping_ad_type"})," is required for all ad groups."]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.a,{href:"https://business.reddithelp.com/s/article/reddit-pixel#set-up-the-reddit-pixel",children:"Reddit Pixel"})," or ",(0,n.jsx)(i.a,{href:"https://business.reddithelp.com/s/article/Conversions-API#integrate-capi",children:"CAPI"})," setup is still required."]}),"\n"]})}),(0,n.jsxs)(s,{value:"conversions",label:"Conversions",children:[(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.code,{children:"objective"})," must be ",(0,n.jsx)(i.code,{children:"SALES"}),"."]}),(0,n.jsx)(i.admonition,{type:"important",children:(0,n.jsxs)(i.p,{children:["Don't set ",(0,n.jsx)(i.code,{children:"use_catalog=true"}),"\u2014this will restrict optimization goals to only ",(0,n.jsx)(i.code,{children:"PURCHASE"})," or ",(0,n.jsx)(i.code,{children:"CLICKS"}),"."]})})]}),(0,n.jsx)(s,{value:"brand-awareness",label:"Brand Awareness",children:(0,n.jsxs)(i.p,{children:["Ad groups in ",(0,n.jsx)(i.code,{children:"BRAND_AWARENESS"})," campaigns must use the ",(0,n.jsx)(i.strong,{children:"same"})," ",(0,n.jsx)(i.code,{children:"optimization_goal"}),". Mixing goals\u2014such as ",(0,n.jsx)(i.code,{children:"null"})," and ",(0,n.jsx)(i.code,{children:"VIDEO_VIEW_6S"}),"\u2014in one campaign ",(0,n.jsx)(i.strong,{children:"isn't supported"}),"."]})}),(0,n.jsx)(s,{value:"lead-gen",label:"Lead Generation",children:(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"optimization_goal"})," must be ",(0,n.jsx)(i.code,{children:"LEAD"})," or ",(0,n.jsx)(i.code,{children:"SIGN_UP"}),". ",(0,n.jsx)(i.code,{children:"null"})," is no longer supported for new campaigns."]}),"\n",(0,n.jsxs)(i.li,{children:["Onsite lead generation forms are no longer supported. ",(0,n.jsx)(i.a,{href:"https://business.reddithelp.com/s/article/reddit-pixel#set-up-the-reddit-pixel",children:"Reddit Pixel"})," or ",(0,n.jsx)(i.a,{href:"https://business.reddithelp.com/s/article/Conversions-API#integrate-capi",children:"CAPI"})," setup is now required. Use ",(0,n.jsx)(i.a,{href:"/docs/v3/api/list-lead-gen-forms",children:(0,n.jsx)(i.code,{children:"List Lead Generation Forms"})})," or ",(0,n.jsx)(i.a,{href:"/docs/v3/api/get-lead-gen-form",children:(0,n.jsx)(i.code,{children:"Get Lead Generation Forms"})})," to retrieve data before API sunset on September 30th."]}),"\n"]})})]})]})}function h(e={}){const{wrapper:i}={...(0,c.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}function j(e,i){throw new Error("Expected "+(i?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]);