{"id":5513,"date":"2024-11-07T14:00:09","date_gmt":"2024-11-07T05:00:09","guid":{"rendered":"https:\/\/help-ads.smartnews.com\/?p=5513"},"modified":"2026-01-07T14:16:51","modified_gmt":"2026-01-07T05:16:51","slug":"item-4207","status":"publish","type":"post","link":"https:\/\/help-ads.smartnews.com\/en\/item-4207\/","title":{"rendered":"Getting started with SmartNews Ads Marketing API"},"content":{"rendered":"\n<p>This guide will walk you through the process of integrating with the updated SmartNews Ads Marketing API, designed to help developers programmatically manage SmartNews Ads campaigns and access analytics data.<\/p>\n\n\n\n<p>If you are not a developer and just need help integrating your ad account with a developer app via the API, please check the <a href=\"https:\/\/help-ads.smartnews.com\/en\/item-4207\/#i3\" title=\"\">For advertisers and agencies<\/a> section.<\/p>\n\n\n\n<p><a href=\"https:\/\/ads.smartnews.com\/developers\" target=\"_blank\" rel=\"noopener\" title=\"\"><strong>Marketing API documentation &gt;<\/strong><\/a><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Introducing Marketing API<\/h2>\n\n\n\n<p>The Marketing API provides programmatic access to the SmartNews Ads platform, enabling you to automate campaign management and retrieve detailed performance insights. Key features include:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Campaign Management<\/strong>: Full CRUD (Create, Read, Update, Delete) operations for campaigns, ad groups, and ads<\/li>\n\n\n\n<li><strong>Insights API<\/strong>: Detailed reporting with support for various metrics and breakdowns<\/li>\n\n\n\n<li><strong>Custom audience retrieval<\/strong>: Access to audience data and Pixel information<\/li>\n\n\n\n<li><strong>Authentication<\/strong>: Secure access through OAuth 2.0<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\">For API developers<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\">Submit your application<\/h3>\n\n\n\n<p>Before you can start using the Marketing API, you&#8217;ll need to register as a developer. You\u2019ll also need an existing SmartNews Ads account before completing the following steps:<\/p>\n\n\n\n<h6 class=\"wp-block-heading\"><i>1<\/i><span>Complete the <a href=\"https:\/\/docs.google.com\/forms\/d\/e\/1FAIpQLSdoK26WFfQz2rDw1E7CX067moe79PGAe6uLPOzLdGmvReRnhg\/viewform\" target=\"_blank\" rel=\"noopener\" title=\"\">Developer Application Form<\/a>.<\/span><\/h6>\n\n\n\n<h6 class=\"wp-block-heading\"><i>2<\/i><span>Provide your company information and intended API usage details.<\/span><\/h6>\n\n\n\n<h6 class=\"wp-block-heading\"><i>3<\/i><span>Applications will be reviewed by the SmartNews team. We\u2019ll send you a notification upon approval.<\/span><\/h6>\n\n\n\n<h4 class=\"wp-block-heading\">Note<\/h4>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Each organization is currently limited to a single developer app.<\/li>\n\n\n\n<li>You don\u2019t need to apply as a developer to use an existing app. Only organizations developing a new app using a SmartNews API need to apply.<\/li>\n\n\n\n<li>Only organizations with an existing SmartNews Ads account are eligible to apply.<\/li>\n<\/ul>\n\n\n\n<div style=\"height:0.5em\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3 class=\"wp-block-heading\">Generate your client secret<\/h3>\n\n\n\n<p>Once approved, follow these steps to obtain your client secret. This is your confidential key used for API authentication.<\/p>\n\n\n\n<h6 class=\"wp-block-heading\"><i>1<\/i><span>Log in to Business Manager.<\/span><\/h6>\n\n\n\n<h6 class=\"wp-block-heading\"><i>2<\/i><span>Navigate to the Developer Apps management section and select \u201cApp Registration\u201d from the drop-down menu, followed by \u201cRegister developer app information.\u201d<\/span><\/h6>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"481\" src=\"https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-49-1024x481.png\" alt=\"\" class=\"wp-image-5867\" srcset=\"https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-49-1024x481.png 1024w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-49-300x141.png 300w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-49-768x361.png 768w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-49-1536x722.png 1536w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-49-2048x963.png 2048w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<h6 class=\"wp-block-heading\"><i>3<\/i><span>For the app name, enter the exact name you used when you submitted the Developer Application Form and select \u201cSave and generate API client secret.\u201d<\/span><\/h6>\n\n\n\n<figure class=\"wp-block-image size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"900\" height=\"541\" src=\"https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/12\/image-1-2.png\" alt=\"\" class=\"wp-image-4444\" style=\"width:629px;height:auto\" srcset=\"https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/12\/image-1-2.png 900w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/12\/image-1-2-300x180.png 300w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/12\/image-1-2-768x462.png 768w\" sizes=\"auto, (max-width: 900px) 100vw, 900px\" \/><\/figure>\n\n\n\n<h6 class=\"wp-block-heading\"><i>4<\/i><span>Note and securely store your client secret.<\/span><\/h6>\n\n\n\n<figure class=\"wp-block-image size-large is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"550\" src=\"https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/12\/image-2-2-1024x550.png\" alt=\"\" class=\"wp-image-4445\" style=\"width:631px;height:auto\" srcset=\"https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/12\/image-2-2-1024x550.png 1024w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/12\/image-2-2-300x161.png 300w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/12\/image-2-2-768x412.png 768w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/12\/image-2-2-1536x824.png 1536w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/12\/image-2-2-2048x1099.png 2048w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\">Note<\/h4>\n\n\n\n<p>Your client secret will only be displayed once at generation.<br>Keep your Client Secret secure and never share it publicly.<\/p>\n\n\n\n<div style=\"height:1em\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<p>Once approved, your app\u2019s details should appear under the Developer Apps &gt; App Registration tab as shown below.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"411\" src=\"https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-50-1024x411.png\" alt=\"\" class=\"wp-image-5870\" srcset=\"https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-50-1024x411.png 1024w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-50-300x120.png 300w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-50-768x308.png 768w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-50-1536x616.png 1536w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-50-2048x822.png 2048w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p>To access ad account resources via the Marketing API, the owner of the ad accounts must assign the resources to your developer app.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>If you need to access resources outside your business, please contact the ad account owners and request them to share the resources through Business Manager. They\u2019ll need your developer app ID to complete the process.<\/li>\n\n\n\n<li>If you need to access resources within your business, please refer to the section below (For advertisers and agencies) to associate the ad accounts with your developer app.<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\">For advertisers and agencies<\/h2>\n\n\n\n<p>The following guide is for ad account operators who wish to integrate their ad accounts with their team\u2019s developer apps. These steps require Business Manager Admin permissions. If your user account has access to developer features, your account also has Business Manager Admin permissions.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Assigning ad accounts to a developer app<\/h3>\n\n\n\n<h6 class=\"wp-block-heading\"><i>1<\/i><span>Navigate to the Developer Apps &gt; App Access Management tab in Business Manager.<\/span><\/h6>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"271\" src=\"https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-51-1024x271.png\" alt=\"\" class=\"wp-image-5872\" srcset=\"https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-51-1024x271.png 1024w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-51-300x79.png 300w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-51-768x203.png 768w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-51-1536x406.png 1536w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-51-2048x541.png 2048w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<h6 class=\"wp-block-heading\"><i>2<\/i><span>Select the relevant app on the left-hand side, followed by Assign ad account.<\/span><\/h6>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"524\" src=\"https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-52-1024x524.png\" alt=\"\" class=\"wp-image-5874\" srcset=\"https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-52-1024x524.png 1024w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-52-300x154.png 300w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-52-768x393.png 768w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-52-1536x786.png 1536w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-52-2048x1048.png 2048w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<h6 class=\"wp-block-heading\"><i>3<\/i><span>Enter the Developer App ID and select the advertising accounts you want to link (you can select multiple accounts).<\/span><\/h6>\n\n\n\n<h6 class=\"wp-block-heading\"><i>4<\/i><span>Select appropriate ad account role for all selected accounts.<\/span><\/h6>\n\n\n\n<figure class=\"wp-block-image size-large is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"901\" src=\"https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-2026-01-07T141621.040-1024x901.png\" alt=\"\" class=\"wp-image-9019\" style=\"width:607px;height:auto\" srcset=\"https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-2026-01-07T141621.040-1024x901.png 1024w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-2026-01-07T141621.040-300x264.png 300w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-2026-01-07T141621.040-768x676.png 768w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-2026-01-07T141621.040-1536x1352.png 1536w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/11\/image-2026-01-07T141621.040-2048x1802.png 2048w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<h6 class=\"wp-block-heading\"><i>5<\/i><span>Select \u201cNext\u201d.<\/span><\/h6>\n\n\n\n<h6 class=\"wp-block-heading\"><i>6<\/i><span>A confirmation pop-up will appear, select \u201cSave\u201d to apply your changes.<\/span><\/h6>\n\n\n\n<figure class=\"wp-block-image size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"900\" height=\"686\" src=\"https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/12\/image-6-1.png\" alt=\"\" class=\"wp-image-4450\" style=\"width:606px;height:auto\" srcset=\"https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/12\/image-6-1.png 900w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/12\/image-6-1-300x229.png 300w, https:\/\/help-ads.smartnews.com\/wp-content\/uploads\/2024\/12\/image-6-1-768x585.png 768w\" sizes=\"auto, (max-width: 900px) 100vw, 900px\" \/><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\">FAQ<\/h2>\n\n\n\n<h6 class=\"wp-block-heading\">Q: I\u2019m not an API developer, but I want to use an existing service which uses the SmartNews Ads API. Do I need to apply as a developer?<\/h6>\n\n\n\n<p>A: Unlike the legacy API, you don\u2019t need to apply as a developer to publish the API key and share it with the developers. You only need developer access if you plan on developing a new app using the API.<br><a href=\"https:\/\/help-ads.smartnews.com\/en\/item-4207\/#i3\" title=\"\">Linking developer apps with an ad account<\/a><\/p>\n\n\n\n<h6 class=\"wp-block-heading\">Q: How long do you maintain each API version?<\/h6>\n\n\n\n<p>A: We maintain the latest and previous API versions simultaneously for 6 months. This allows you to test your integration against a new version while still running production traffic through the previous version.<\/p>\n\n\n\n<h6 class=\"wp-block-heading\">Q: Will my code break when you release a new API version?<\/h6>\n\n\n\n<p>A: Response fields or parameters will never be deleted or updated within any given version. However, some breaking changes may be introduced in new versions. You may see these types of changes within a version:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>New fields added to responses<\/li>\n\n\n\n<li>New optional request parameters<\/li>\n\n\n\n<li>New endpoints or features<\/li>\n<\/ul>\n\n\n\n<p>New versions and previous versions will co-exist for 6 months to ensure you have time to make any required updates.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Support and resources<\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li>API Terms of Service\n<ul class=\"wp-block-list\">\n<li><a href=\"https:\/\/ads.smartnews.com\/developers\/tos-en.html\" target=\"_blank\" rel=\"noopener\" title=\"\">English Terms of Service<\/a><\/li>\n\n\n\n<li><a href=\"https:\/\/ads.smartnews.com\/developers\/tos-ja.html\" target=\"_blank\" rel=\"noopener\" title=\"\">Japanese Terms of Service<\/a><\/li>\n<\/ul>\n<\/li>\n\n\n\n<li><a href=\"https:\/\/ads.smartnews.com\/developers\" target=\"_blank\" rel=\"noopener\" title=\"\">API Documentation<\/a><\/li>\n<\/ul>\n\n\n\n<p><\/p>\n","protected":false},"excerpt":{"rendered":"This guide will walk you through the process of integrating with the updated SmartNews Ads Marketing API, designed to help developers programmatically manage SmartNews Ads campaigns and access analytics data. If you are not a developer and just need help integrating your ad account with a developer app via the API, please check the For advertisers and agencies section. Marketing API documentation &gt; Introducing Marketing API The Marketing API provides programmatic access to the SmartNews Ads platform, enabling you to automate campaign management and retrieve detailed performance insights. Key features include: For API developers Submit your application Before you can start using the Marketing API, you&#8217;ll need to register as [&hellip;]","protected":false},"author":4,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"inline_featured_image":false,"footnotes":""},"categories":[206],"tags":[],"label":[],"class_list":["post-5513","post","type-post","status-publish","format-standard","hentry","category-tracking-en"],"acf":[],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/help-ads.smartnews.com\/en\/wp-json\/wp\/v2\/posts\/5513","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help-ads.smartnews.com\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/help-ads.smartnews.com\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/help-ads.smartnews.com\/en\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/help-ads.smartnews.com\/en\/wp-json\/wp\/v2\/comments?post=5513"}],"version-history":[{"count":9,"href":"https:\/\/help-ads.smartnews.com\/en\/wp-json\/wp\/v2\/posts\/5513\/revisions"}],"predecessor-version":[{"id":9023,"href":"https:\/\/help-ads.smartnews.com\/en\/wp-json\/wp\/v2\/posts\/5513\/revisions\/9023"}],"wp:attachment":[{"href":"https:\/\/help-ads.smartnews.com\/en\/wp-json\/wp\/v2\/media?parent=5513"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/help-ads.smartnews.com\/en\/wp-json\/wp\/v2\/categories?post=5513"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/help-ads.smartnews.com\/en\/wp-json\/wp\/v2\/tags?post=5513"},{"taxonomy":"label","embeddable":true,"href":"https:\/\/help-ads.smartnews.com\/en\/wp-json\/wp\/v2\/label?post=5513"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}