SmartNews ad API is one of 16 APIs that SmartNews publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Ad. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
6 operations
across 3 paths,
and defines 89 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.
CatalogImageCreativeInfoRequestResponse
object
Required when format is CATALOGIMAGE. Note: This field is not settable for US region ad accounts.
1 property
1 required
SubmissionStatus
string
This is the status of the ad to know whether our customers submit the ad to moderation or not.
CarouselCreativeInfoPatchRequest
object
3 properties
BusinessErrorResponse
object
1 property
1 required
ResourceNotFoundErrorExtension
object
2 properties
2 required
AdSchemas_Name
string
Name of an Ad. It is only used by customers to distinguish their Ads on Ads Manager. Note: Our standard length calculation rules apply to length validation: [S…
UnexpectedErrorResponse
object
1 property
1 required
CatalogCarouselCreativeInfoResponse
object
2 properties
2 required
CreativeRequest
object
6 properties
1 required
ResourceNotFoundError
object
AdCreationParams
object
7 properties
2 required
SponsoredName
string
Name of advertiser/service name/brand name/product name etc which is displayed to users to show the sponsorship of Ad. Note: The validated length is calculated…
PageSize
integer
The number of objects to return per page. The maximum page size is 1000 and the default is 1000.
RejectionReason
object
5 properties
4 required
ServiceUnavailableError
object
PriceLabelEnabled
booleannull
If true, show a price label on the ad. Otherwise, do not show. This field is required when the parent campaign has isdynamicads set to true and ad's creative i…
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…
AdImpressionMeasurement
objectnull
Configuration for 3rd party ad impression measurement Note: This field is not settable for US region ad accounts.
2 properties
2 required
UnexpectedErrorExtension
object
1 property
1 required
LandingPageUrl
string
URL of the Website which is opened when an Ad is clicked.\ It is required when the parent campaign's clickdestinationtype is one of the following. It cannot be…
VideoCreativeInfoPatchRequest
object
3 properties
StoreSetId
integer
Identifier of the store set associated with this campaign for Store Visit measurement. Store sets are managed under Business Management.
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)
CarouselCreativeInfoResponse
object
3 properties
3 required
MediaType
string
The type of the media file.
CarouselCardResponse
object
Caption and Media file combination for carousel format.
2 properties
2 required
OptimizationEvent
stringnull
Optimization event defines which conversion event the campaign is optimized for. | Optimization Goal | Available optimization events | |-----------------------…
RateLimitedErrorResponse
object
1 property
1 required
ImageCreativeInfoPatchRequest
object
4 properties
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:…
Url
string
The storage full url path of the image file.
MediaFileResponse
object
10 properties
7 required
Headline
string
Headline text of a Creative. Note: The validated length is calculated by our standard length calculation rules: [See details](https://help-ads.smartnews.com/it…
UnauthorizedErrorExtension
object
1 property
1 required
ForbiddenErrorExtension
object
2 properties
1 required
CtaLabel
stringnull
If specified, a call to action button with the specified option is displayed on the ad (may not be displayed in all placements).
DeliveryStatusReason
string
An enum field for the reason the delivery status was determined. | Reason | Layers | |-------------------------------------------|-----------| | CAMPAIGNDELETE…
ModerationStatus
string
This is the moderation result of current Ad.
ServiceUnavailableErrorResponse
object
1 property
1 required
CarouselCardRequest
object
Combination of image and caption text for carousel format.
2 properties
2 required
CreativeResponse
object
The response of the creative resource. Only one of imagecreativeinfo, videocreativeinfo, carouselcreativeinfo, catalogcarouselcreativeinfo, or catalogimagecrea…
9 properties
4 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
CarouselCreativeInfoRequest
object
Required when format is CAROUSEL. Note: This field is not settable for US region ad accounts.
3 properties
3 required
CatalogCarouselCreativeInfoRequest
object
Required when format is CATALOGCAROUSEL. Note: This field is not settable for US region ad accounts.
2 properties
2 required
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
ImageCreativeInfoRequest
object
Required when format is IMAGE.
4 properties
4 required
ImageCreativeInfoResponse
object
4 properties
4 required
AdPaginatedResponse
object
2 properties
2 required
ForbiddenErrorResponse
object
1 property
1 required
ImageResponse
object
7 properties
7 required
VideoResponse
object
8 properties
8 required
VendorType
string
The vendor to use for impression measurement
ModerationElementType
object
2 properties
2 required
ValidationErrorResponse
object
1 property
1 required
CreativePatchRequest
object
5 properties
Format
string
The format of the Creative that defines the view attribution of an Ad. Note: CAROUSEL, CATALOGCAROUSEL, and CATALOGIMAGE are not settable for US region ad acco…
PaginationInfoResponse
object
An object describing pagination parameters for this response.
4 properties
4 required
Parent
object
8 properties
3 required
Description
string
Description text of a Creative. This is used when an Ad is displayed in SmartView. - Required if the creative format is IMAGE. - Must be null for other formats…
BusinessErrorExtension
object
1 property
1 required
VideoSchemas_Url
string
The full url path of the video file.
ServiceUnavailableErrorExtension
object
1 property
1 required
ConfiguredStatus
string
The status of the object configured by an ad operator.
UrlTrackingParameters
stringnull
The parameters added to the landing page URL. This field is only supported for Dynamic Ads. The API will return a Validation Error if the field doesn't follow…
BadRequestErrorResponse
object
1 property
1 required
CarouselCardMediaFileId
integer
The Id of the media file. Only image is supported. The image for the carousel needs to be 1:1 aspect ratio.
MediaFileStatus
string
The status of the media file. - ACTIVE: The media file is visible in the Media Library. - INACTIVE: The media file has been soft-deleted and is no longer visib…
DeliveryStatus
string
The delivery status of the object determined by the system. | Delivery status | What it means | |-----------------|---------------| | DELETED | The object is d…
AdPatchRequest
object
8 properties
MediaFileIds
array
List of Media File IDs which will be used for a Creative. Media Files can be created via the POST mediafiles endpoint. The specified Media Files must belong to…
AspectRatioType
string
The predefined enums for the aspect ratio of images and videos.
ResourceNotFoundErrorResponse
object
1 property
1 required
VideoCreativeInfoRequest
object
Required when format is VIDEO.
3 properties
3 required
ValidationErrorExtension
object
2 properties
2 required
VideoCreativeInfoResponse
object
3 properties
4 required
DeliveryStatusObject
object
An Object that provides information about the delivery status of the campaign.
3 properties
3 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs SmartNews publishes across the network.
