SmartNews custom-audience API
The custom-audience API from SmartNews — 4 operation(s) for custom-audience.
SmartNews custom-audience API is one of 16 APIs that SmartNews publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include custom-audience. 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 130 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.
7 operations
4 paths
130 schemas
1 DELETE3 GET1 PATCH2 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
SmartNews custom-audience API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (ApiKeyAuth).
By default, every request must be authenticated.
Paths & Operations 7
Across 4 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
custom-audience 7
GET
/api/ma/v3/ad_accounts/{ad_account_id}/custom_audiences
List custom audiences
POST
/api/ma/v3/ad_accounts/{ad_account_id}/custom_audiences
Create a Custom Audience
GET
/api/ma/v3/ad_accounts/{ad_account_id}/custom_audiences/{custom_audience_id}
Get a Custom Audience
PATCH
/api/ma/v3/ad_accounts/{ad_account_id}/custom_audiences/{custom_audience_id}
Update a Custom Audience
DELETE
/api/ma/v3/ad_accounts/{ad_account_id}/custom_audiences/{custom_audience_id}
Delete a Custom Audience
GET
/api/ma/v3/ad_accounts/{ad_account_id}/custom_audiences/{custom_audience_id}/ad_groups
Get ad groups by custom audience.
POST
/api/ma/v3/ad_accounts/{ad_account_id}/audience_id_list_files
Create a audience ID list file.
Schemas 130
The contract defines 130 schemas that model the data the API accepts and returns. The most detailed are AudienceResponse (15 properties), AudienceRequest (15 properties), CustomAudienceResponse (12 properties), CustomAudienceCreationRequest (8 properties). Each schema is shown below with its type and property counts.
IsMigratedFromV1
boolean
A boolean flag that indicates whether the object is migrated from v1.
CustomAudienceResponse
object
In Legacy Custom Audiences (type: LEGACY), only the name, customaudienceid and type fields are valid. Other fields are dummy data.
12 properties
8 required
IABInterestId
integer
AudienceIdListRuleCreationRequest
object
1 property
1 required
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…
RulesCombiningLogic
string
How the rules will be combined for this custom audience.
UserSegment
string
The type of users to target.
ResourceNotFoundError
object
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
KeywordWindow
string
Period Window for the keyword mapping of keyword custom audience.
AudienceIdListFileRequest
object
3 properties
3 required
DeliveryStatusObject
object
An Object that provides information about the delivery status of the campaign.
3 properties
3 required
ServiceUnavailableError
object
CustomAudiencePatchRequest
object
7 properties
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
Type
string
The type of the custom audience. LEGACY custom audiences are those that were created in AMv1.
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…
BadRequestError
object
ConnectionType
stringnull
TimePeriod
string
Past number of days of user activity to consider when creating the uuid list for the rule. Only certain ad accounts can use LAST365DAYS and LAST540DAYS.
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
BusinessError
object
AvailabilityStatus
string
The status of the custom audience processing, indicating whether it is ready to be used in AdGroup targeting or not.
GatewayTimeoutErrorResponse
object
1 property
1 required
AudienceIdListFileId
integer
Unique identifier of the audience ID list file.
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…
CustomAudienceSchemas_Name
string
The name of the custom audience. Please check [this document](https://help-ads.smartnews.com/item-3888/) for how the length is calculated.
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)
KeywordRuleResponse
object
6 properties
6 required
OptimizationEvent
stringnull
Optimization event defines which conversion event the campaign is optimized for. | Optimization Goal | Available optimization events | |-----------------------…
UnexpectedError
object
LocationSegmentRequest
object
4 properties
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.…
LocationId
integer
AdsEngagementRuleResponse
object
6 properties
6 required
AdAccountId
integer
Unique ID of the ad account.
Events
array
The events to target for this rule.
Keywords
array
Keywords for keyword custom audience. If there is a duplicated keyword, it will return an error. Empty strings are not allowed. The following characters are no…
ConnectionTypes
array
An array of connection types to target.
CustomAudienceResult
object
The result of the custom audience backend processing.
4 properties
4 required
UniqueAudienceCount
integernull
The number of unique users in the custom audience. This field is only valid when the availabilitystatus is AVAILABLE/TOONARROW/NARROW.
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…
CarrierType
string
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
Action
string
The user action to consider as engagement.
UnauthorizedError
object
CustomAudienceRequestType
string
The type of the custom audience. Note: KEYWORD type is not available for US ad accounts.
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
ChannelAliasLabel
string
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
ValidationError
object
AudienceIdListRulePatchRequest
object
2 properties
HyperLocationConfigResponse
objectnull
An object containing hyper location targeting configuration.
2 properties
2 required
ForbiddenErrorResponse
object
1 property
1 required
CustomAudienceCreationRequest
object
8 properties
4 required
AudienceResponse
object
15 properties
4 required
AdGroupSchemas_CreatedAt
string
The date-time at which the ad group was created.
AdGroupIds
array
An array of Ad Group IDs to target engagement for.
CommonSchemas_CreatedAt
string
The DateTime when the object was created.
ForbiddenError
object
Interval
string
The time interval which frequency will be calculated.
ValidationErrorResponse
object
1 property
1 required
CustomAudienceEvent
stringnull
Conversion event for custom audience to target.
AudienceIdListRuleResponse
object
6 properties
6 required
WebActivityRuleResponse
object
7 properties
7 required
OriginalFileName
string
Filename of the audience ID list file.
WebActivityRulePatchRequest
object
5 properties
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
AdsEngagementRuleCreationRequest
object
3 properties
3 required
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.
Urls
array
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.
CustomAudienceArrayResponse
object
1 property
1 required
HyperLocationConfigRequest
objectnull
An object containing hyper location targeting configuration. Note: This field is not settable for US region ad accounts.
2 properties
2 required
WebActivityRuleSchemas_PixelTagId
string
The pixeltagid of the pixel to target for this rule
CommonSchemas_UpdatedAt
string
The DateTime when the object was last updated.
AdsEngagementRulePatchRequest
object
4 properties
ConfiguredStatus
string
The status of the object configured by an ad operator.
AudienceIdListFileResponse
object
5 properties
5 required
Age
string
AdGroupResponse
LocationSegmentPinWithRadiusInfo
object
The configuration for the Pin with Radius location segment. Required and only settable when segmentareatype is PINWITHRADIUS.
5 properties
4 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…
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
KeywordRulePatchRequest
object
4 properties
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
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.
AdGroupSchemas_UpdatedAt
string
The date-time at which the ad group was last updated.
WebActivityRuleCreationRequest
object
4 properties
4 required
FileType
string
The type of the audience ID list file.
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
KeywordRuleCreationRequest
object
3 properties
3 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
CustomAudienceConfiguredStatus
string
- ACTIVE: The audience will be updated periodically based on the latest data. - PAUSED: The audience will not be updated until reactivated. - DELETED: The audi…
KeywordFrequency
integer
Frequency for the keyword mapping of keyword custom audience.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from SmartNews 12
Other APIs SmartNews publishes across the network.
SmartNews ad API
SmartNews ad-group API
SmartNews article category API
SmartNews campaign API
SmartNews catalog API
SmartNews channel alias label API
SmartNews developer-app API
SmartNews insights API
SmartNews interests API
SmartNews locations API
SmartNews media-file API
SmartNews oauth API
#custom-audience
Where this information came from
This is an independent, third-party profile of SmartNews custom-audience API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.