SmartNews campaign API is one of 16 APIs that SmartNews publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Campaign. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
5 operations
across 2 paths,
and defines 87 schemas.
It is described by OpenAPI 3.2.0, at version 3.0.1.
Requests are made against a single base URL, https://ads.smartnews.com.
The identity and technical contract details declared by the specification.
AppTrackingConfig
object
4 properties
2 required
IsMigratedFromV1
boolean
A boolean flag that indicates whether the object is migrated from v1.
BusinessErrorResponse
object
1 property
1 required
HasAnyVideoAds
boolean
Whether the ad object has any video ads, including those that have been deleted.
ResourceNotFoundErrorExtension
object
2 properties
2 required
UnexpectedErrorResponse
object
1 property
1 required
BillingEvent
string
The type of event that the ad account wants to pay for the campaign. | Objective | Available billing events | |---------------|--------------------------------…
ResourceNotFoundError
object
PageSize
integer
The number of objects to return per page. The maximum page size is 1000 and the default is 1000.
AppPromotionType
string
The type of app promotion campaign. | Promotion type | Description | |-------------------|-------------------------------------------| | INSTALL | To promote a…
BidAmountMicro
integernull
The bidding amount for MANUAL bidding strategy in [micros](section/About-Currency-Units) of the ad account currency base unit. This field is configurable and r…
DeliveryType
stringnull
Delivery type adjusts the speed of budget spending throughout the day. A delivery type must be configured for MANUAL or TARGETCOST bid strategy, while it must…
ServiceUnavailableError
object
BudgetAutoTargetCpaMicro
integernull
Budget Auto-adjustment Expected CPA in [micros](section/About-Currency-Units) of the ad account currency base unit. This value is only able to be set when camp…
BadRequestErrorExtension
object
1 property
1 required
ReadyForDelivery
boolean
A boolean flag that indicates whether a ready for delivery. The flag is immutable once it turned to true. When the flag is true, the following fields are not u…
CampaignDailySchedule
object
2 properties
2 required
UnexpectedErrorExtension
object
1 property
1 required
UpdatedAt
string
The date-time at which the campaign was last updated.
BidStrategy
string
The strategy that defines how the amount of bid is decided. | Objective | Available bid strategies | Usable for US region ad accounts | |---------------|------…
StoreSetId
integer
Identifier of the store set associated with this campaign for Store Visit measurement. Store sets are managed under Business Management.
CreatedAt
string
The date-time at which the campaign was created.
AcceptLanguage
string
The language to use for system generated text within API responses. The currently supported languages are English (en, en-) and Japanese (ja, ja-JP)
CampaignRequest
object
31 properties
7 required
DailyBudgetAmountMicro
integer
The average budget per day in [micros](section/About-Currency-Units) of the ad account currency base unit. | Ad Account's currency | Minimum value | Maximum Va…
DynamicAdsInfo
object
Configuration specific to dynamic ads campaigns. If isdynamicads is true, this field is required.
1 property
1 required
IsMultiOrderAttribution
boolean
If enabled, multiple Purchase event postbacks generated from the same click are recorded as separate Purchase events. Otherwise, only the first postback will b…
OptimizationEvent
stringnull
Optimization event defines which conversion event the campaign is optimized for. | Optimization Goal | Available optimization events | |-----------------------…
RateLimitedErrorResponse
object
1 property
1 required
AppMmpTrackingUrl
string
A URL used to track and attribute mobile app marketing campaign performance. For detailed validation rules, see the [help page](https://help-ads.smartnews.com/…
ClickDestinationType
stringnull
This defines which components SmartNews opens after an ad is clicked. If clickdestinationtype = null when creating campaign then default value is set as below:…
ConversionAttributionWindow
string
It specifies the time frame in which conversions are counted for the campaign. The default value is THIRTYDAYS if not specified. Available values are dependent…
ViewabilityMeasurement
object
Configuration for 3rd party viewability measurement provider. It is not editable when the campaign is ready for delivery. Currently, only MOAT is supported.
4 properties
4 required
UnauthorizedErrorExtension
object
1 property
1 required
ForbiddenErrorExtension
object
2 properties
1 required
AppTrackingConfigs
array
This field is used to configure app tracking when conversions from both the app and the web need to be tracked. If the campaign's objective = APPPROMOTION, the…
DeliveryStatusReason
string
An enum field for the reason the delivery status was determined. | Reason | Layers | |-------------------------------------------|-----------| | CAMPAIGNDELETE…
CampaignPatchRequest
object
28 properties
ServiceUnavailableErrorResponse
object
1 property
1 required
Page
integer
The page of data to retrieve. The first page starts at 1, and each page will contain at most pagesize items (the last page may contain less). To get the maximu…
ErrorBase
object
2 properties
2 required
SpendingLimitMicro
integer
The life-time spending limit in [micros](section/About-Currency-Units) of the ad account currency base unit. Null means there is no limit. | Ad Account's curre…
AppStoreId
string
The promoted app's App store ID. Each platform has a different format for the ID. For IOS, it is string containing digits only. Example: "579581125" For ANDROI…
CampaignObjective
string
The objective of the campaign. It defines the business goal that customers pursue during a campaign.\ Note: Only TRAFFIC and SALES objectives are usable for US…
UnauthorizedErrorResponse
object
1 property
1 required
StartDateTime
string
The date-time at which the campaign is scheduled to start. Minimum value: ≥ today (ad account based timezone)\ Maximum value: 2099-12-31T23:58:00 (ad account b…
ForbiddenErrorResponse
object
1 property
1 required
AppMmpType
string
The third-party service provider that helps advertisers track, measure, and attribute the performance of their mobile ad campaigns. It is not editable when rea…
CampaignPaginatedResponse
object
2 properties
2 required
IsLargeUnitSquareAds
boolean
A boolean flag that indicates whether ads from this campaign are displayed in the app using the large unit square format. This feature is only available when o…
WebsiteTrackingTag
stringnull
The pixel tag id that is used to report web events generated through a campaign. \ Required if Objective is SALES and Click Destination Type is WEBVIEW This fi…
EndDateTime
stringnull
The date-time at which the campaign is scheduled to end. Minimum value: max(currentdatetime, startdatetime)\ Maximum value: 2099-12-31T23:59:00 (ad account bas…
TotalSpending
string
The current total spending of the campaign. This value is expressed in the base unit of the ad account's currency and it represents the exact monetary amount s…
ValidationErrorResponse
object
1 property
1 required
PaginationInfoResponse
object
An object describing pagination parameters for this response.
4 properties
4 required
MinimalSpendingLimitMicro
integer
The current minimum required value when you attempt to update the spendinglimitmicro. This value considers the factors like the totalspending of the campaign a…
IsLargeUnitAds
boolean
A boolean flag that indicates whether ads from this campaign are displayed in the app using the large unit format. This feature is only available when objectiv…
BusinessErrorExtension
object
1 property
1 required
DailySchedules
array
An array of daily delivery schedules for the campaign. By default, it is empty. If empty, the campaign will run 24/7. To run an overnight schedule, please crea…
IsSKAdNetworkEnabled
boolean
[Coming Soon] This feature is not yet available but will be supported soon. A boolean flag that indicates whether the campaign is using SKAdNetwork to collect…
AppPromotionInfo
object
Configuration specific to App Promotion objective campaigns. It is required when objective is APPPROMOTION
5 properties
5 required
ServiceUnavailableErrorExtension
object
1 property
1 required
CatalogId
integer
The catalog ID to use for this dynamic ads campaign.
OptimizationGoal
stringnull
Optimization goal defines how the campaign is optimized. This is required and configurable unless bidding strategy is MANUAL. | Objective | Bid Strategy | Avai…
ConfiguredStatus
string
The status of the object configured by an ad operator.
TargetCostMicro
integernull
The cost per acquisition in [micros](section/About-Currency-Units) of the ad account currency base unit. This is only required and configurable if and only if…
Name
string
The name of the campaign. Note: The maximum length is calculated by our standard length calculation rules: [See details](https://help-ads.smartnews.com/item-38…
BadRequestErrorResponse
object
1 property
1 required
DeliveryStatus
string
The delivery status of the object determined by the system. | Delivery status | What it means | |-----------------|---------------| | DELETED | The object is d…
AppOperatingSystem
string
The platform of promoted app
IsStickyPlacementsEnabled
boolean
A boolean flag that indicates whether fixed on-scroll sticky placements are included for this campaign. The default value is false if not specified. Note: This…
ResourceNotFoundErrorResponse
object
1 property
1 required
ValidationErrorExtension
object
2 properties
2 required
ChannelViewPlacement
string
The placement of the campaign's ads within the channel view. - INFEED: Shown in between articles in the feed - PRIMARYSLOT: Shown in the first ad slot of the f…
PatchAppPromotionInfo
object
It contains the fields of AppPromotionInfo which are updatable.
2 properties
DeliveryStatusObject
object
An Object that provides information about the delivery status of the campaign.
3 properties
3 required
CampaignID
integer
The ID of the campaign.
IsDynamicAds
boolean
A boolean flag that indicates whether the campaign is dynamic ads or standard ads.\ Note: The US region ad accounts are not allowed to create dynamic ads campa…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs SmartNews publishes across the network.