SmartNews ad-group API is one of 16 APIs that SmartNews publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include AdGroup. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
7 operations
across 4 paths,
and defines 96 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.
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
CampaignID
integer
The ID of the campaign.
PlacementMediaType
string
UnexpectedErrorResponse
object
1 property
1 required
SmartViewArticleCategoryTargeting
objectnull
SmartView article category targeting settings for ad delivery. It contains article category IDs to include or exclude for delivery. This field is only configur…
2 properties
2 required
AdGroupLocations
array
An array of location IDs to target. A list of location IDs can be obtained via the [locations](tag/locations) endpoint. Note: Only available for US accounts. F…
AdGroupPaginatedResponse
object
2 properties
2 required
UserSegment
string
The type of users to target.
ResourceNotFoundError
object
PageSize
integer
The number of objects to return per page. The maximum page size is 1000 and the default is 1000.
SmartViewArticleKeywordTargeting
objectnull
SmartView article keyword targeting settings for ad delivery. Ads will be delivered to SmartView ad placements of articles which include and/or exclude these k…
2 properties
2 required
DeliveryStatusObject
object
An Object that provides information about the delivery status of the campaign.
3 properties
3 required
ServiceUnavailableError
object
OperatingSystem
objectnull
Target OS and optionally a specific OS version. If it is not specified, all OS and OS versions are targeted.
2 properties
1 required
TargetingType
string
The type of DA targeting. Retargeting is for finding existing user; Prospecting is for finding new user based on existing user log. This value is NOT updatable…
AdGroupArrayResponse
object
1 property
1 required
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…
ConnectionType
stringnull
CustomAudiences
object
Custom audiences to include or exclude for ad delivery. It contains the custom audience IDs to include or exclude for ad delivery. If it's empty, it will be de…
2 properties
UnexpectedErrorExtension
object
1 property
1 required
ProductSetID
integer
The ID of the product set.
ChannelAliasLabels
array
An array of target channels to display the ads in the SmartNews app. If it is null or [], all channels will be targeted. This value can only be set when mediat…
LocationSegmentFixedAreaInfo
object
The configuration for the Fixed Area location segment. Required and only settable when segmentareatype is FIXEDAREA.
1 property
1 required
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)
OptimizationEvent
stringnull
Optimization event defines which conversion event the campaign is optimized for. | Optimization Goal | Available optimization events | |-----------------------…
LocationSegmentRequest
object
4 properties
1 required
RateLimitedErrorResponse
object
1 property
1 required
ZipCode
string
A ZIP code used for ad group location targeting in the United States. - Accepts exactly five numeric digits. Leading zeroes must be included where applicable.…
ConnectionTypes
array
An array of connection types to target.
UnauthorizedErrorExtension
object
1 property
1 required
ForbiddenErrorExtension
object
2 properties
1 required
AdGroupSchemas_Name
string
The name of the ad group. Note: The maximum length is calculated by our standard length calculation rules: [See details](https://help-ads.smartnews.com/item-38…
SegmentAreaType
string
The area type of the segment.
SmartViewArticleCategoryId
integer
DeliveryStatusReason
string
An enum field for the reason the delivery status was determined. | Reason | Layers | |-------------------------------------------|-----------| | CAMPAIGNDELETE…
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
DynamicAdsConfigSchema
object
The Configuration of the dynamic ads. If campaign is for dynamic ads, this object is required.
3 properties
1 required
Genders
array
An array of genders to target. Note: This field is not settable for US region ad accounts.
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
HyperLocationConfigResponse
objectnull
An object containing hyper location targeting configuration.
2 properties
2 required
ForbiddenErrorResponse
object
1 property
1 required
DynamicAdsConfigPatchSchema
object
The Configuration of the dynamic ads for PATCH requests. If campaign is for dynamic ads, this object is required.
2 properties
AudienceResponse
object
15 properties
4 required
AdGroupSchemas_CreatedAt
string
The date-time at which the ad group was created.
Interval
string
The time interval which frequency will be calculated.
ValidationErrorResponse
object
1 property
1 required
PaginationInfoResponse
object
An object describing pagination parameters for this response.
4 properties
4 required
AdGroupID
integer
The ID of the ad group.
Parent
object
8 properties
3 required
BusinessErrorExtension
object
1 property
1 required
AutomatedTargeting
objectnull
Automated targeting settings for the ads to be delivered with SN optimized strategy. If this field is non-null, automated targeting is enabled (even if the obj…
7 properties
ServiceUnavailableErrorExtension
object
1 property
1 required
AdGroupRequest
object
5 properties
2 required
CarrierTypes
array
An array of mobile network carriers to target. Note: This field is not settable for US region ad accounts.
Gender
string
Selected genders of users for the ads to be delivered.
MediaTypes
array
An array of media types defining where the ads will be displayed in the SmartNews app. Note: This field is not settable for US region ad accounts.
HyperLocationConfigRequest
objectnull
An object containing hyper location targeting configuration. Note: This field is not settable for US region ad accounts.
2 properties
2 required
AdGroupPatchRequest
object
5 properties
ConfiguredStatus
string
The status of the object configured by an ad operator.
LocationSegmentPinWithRadiusInfo
object
The configuration for the Pin with Radius location segment. Required and only settable when segmentareatype is PINWITHRADIUS.
5 properties
4 required
Interests
array
An array of IAB Interest IDs to target. A list of IAB Interest IDs can be obtained via the [iabinterestcategories](tag/interests) endpoint. Note: This field is…
ZipCodes
array
An array of ZIP codes to target. The values are combined with locations (states and counties) using OR logic during delivery. The response returns ZIP codes in…
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…
AudienceRequest
object
In Patch Request, if you omit the property, the data will remain unchanged. If you want to remove the current settings, set individual fields to either null or…
15 properties
HyperLocationSchemas_LocationId
integer
The unique identifier of the location. A list of location IDs can be obtained via the [locations](tag/locations) endpoint.
LocationSegmentResponse
object
The response of the hyper location segment resource. Only one of locationsegmentpinwithradiusinfo or locationsegmentfixedareainfo will be returned based on the…
4 properties
2 required
AdGroupSchemas_UpdatedAt
string
The date-time at which the ad group was last updated.
Ages
array
An array of age buckets to target. Note: - This field is not settable for US region ad accounts. - AGEUNDER20 option is deprecated and can no longer be used fo…
ResourceNotFoundErrorResponse
object
1 property
1 required
ValidationErrorExtension
object
2 properties
2 required
RecencyDays
stringnull
The lookback window (in days) for user logs can be used for retargeting. - Required when targetingtype is RETARGETING - Set to null when targetingtype is PROSP…
FrequencyControl
objectnull
Frequency control settings for the ads to be delivered. Only available for Awareness campaign. Note: This field is not settable for US region ad accounts.
2 properties
2 required
LocationSegmentId
integer
The unique identifier of the location segment. If this property is set, the specified location segment will be updated (PATCH request only). If this property i…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs SmartNews publishes across the network.
