add
Creates ads.
Restrictions
To manage product ads, use the URL: https://api.direct.yandex.com/v501/
.
The ad type must match the ad group type (see the table in the section Ad type).
You can't add ads to an archived campaign.
Maximum of 1000 ads per method call.
To get the limit on the number of ads per group for an advertiser, use the method Clients.get or AgencyClients.get (see the ADS_TOTAL_PER_ADGROUP element in the Restrictions array).
Request
Request structure in JSON format:
{
"method": "add",
"params": { /* params */
"Ads": [{ /* AdAddItem */
"AdGroupId": (long), /* required */
"TextAd": { /* TextAdAdd */
"Title": (string), /* required */
"Title2": (string),
"Text": (string), /* required */
"Href": (string),
"Mobile": ( "YES" | "NO" ), /* required */
"DisplayUrlPath": (string),
"VCardId": (long),
"AdImageHash": (string),
"SitelinkSetId": (long),
"AdExtensionIds": [(long), ... ],
"VideoExtension": { /* VideoExtensionAddItem */
"CreativeId": (long)
},
"PriceExtension": { /* PriceExtensionAddItem */
"Price": (long), /* required */
"OldPrice": (long),
"PriceQualifier": ( "FROM" | "UP_TO" | "NONE" ), /* required */
"PriceCurrency": ( "RUB" | "BYN" | "CHF" | "EUR" | "KZT" | "TRY" | "UAH" | "USD" | "UZS" ) /* required */
},
"TurboPageId": (long),
"BusinessId": (long),
"PreferVCardOverBusiness": ( "YES" | "NO" ),
"ErirAdDescription" : (string)
},
"DynamicTextAd": { /* DynamicTextAdAdd */
"VCardId": (long),
"AdImageHash": (string),
"SitelinkSetId": (long),
"AdExtensionIds": [(long), ... ],
"Text": (string) /* required */
},
"MobileAppAd": { /* MobileAppAdAdd */
"AdImageHash": (string),
"Text": (string), /* required */
"Title": (string), /* required */
"TrackingUrl": (string),
"Action": ( "DOWNLOAD" | "GET" | "INSTALL" | "MORE" | "OPEN" | "UPDATE" | "PLAY" | "BUY_AUTODETECT" ), /* required */
"Features": [{ /* MobileAppAdFeatureItem */
"Feature": ( "PRICE" | "ICON" | "CUSTOMER_RATING" | "RATINGS" ), /* required */
"Enabled": ( "YES" | "NO" ) /* required */
}, ... ],
"AgeLabel": ( "AGE_0" | ... | "AGE_18" ),
"VideoExtension": { /* VideoExtensionAddItem */
"CreativeId": (long)
},
"ErirAdDescription" : (string)
},
"TextImageAd": { /* TextImageAdAdd */
"AdImageHash": (string), /* required */
"ErirAdDescription" : (string),
"Href": (string),
"TurboPageId": (long)
},
"MobileAppImageAd": { /* MobileAppImageAdAdd */
"AdImageHash": (string), /* required */
"ErirAdDescription" : (string),
"TrackingUrl": (string)
},
"TextAdBuilderAd": { /* TextAdBuilderAdAdd */
"Creative": { /* AdBuilderAdAddItem */
"CreativeId": (long) /* required */
}, /* required */
"ErirAdDescription" : (string),
"Href": (string),
"TurboPageId": (long)
},
"MobileAppAdBuilderAd": { /* MobileAppAdBuilderAdAdd */
"Creative": { /* AdBuilderAdAddItem */
"CreativeId": (long) /* required */
}, /* required */
"ErirAdDescription" : (string),
"TrackingUrl": (string)
},
"MobileAppCpcVideoAdBuilderAd" : { /* MobileAppCpcVideoAdBuilderAdAdd */
"Creative" : { /* AdBuilderAdAddItem */
"CreativeId" : (long) /* required */
},
"ErirAdDescription" : (string),
"TrackingUrl" : (string)
}, /* required */
"CpmBannerAdBuilderAd": { /* CpmBannerAdBuilderAdAdd */
"Creative": { /* AdBuilderAdAddItem */
"CreativeId": (long) /* required */
}, /* required */
"ErirAdDescription" : (string),
"Href": (string),
"TrackingPixels": { /* ArrayOfString */
"Items": [(string), ... ] /* required */
},
"TurboPageId": (long)
},
"CpcVideoAdBuilderAd": { /* CpcVideoAdBuilderAdAdd */
"Creative": { /* AdBuilderAdAddItem */
"CreativeId": (long) /* required */
}, /* required */
"ErirAdDescription" : (string),
"Href": (string),
"TurboPageId": (long)
},
"CpmVideoAdBuilderAd": { /* CpmVideoAdBuilderAdAdd */
"Creative": { /* AdBuilderAdAddItem */
"CreativeId": (long) /* required */
}, /* required */
"ErirAdDescription" : (string),
"Href": (string),
"TrackingPixels": { /* ArrayOfString */
"Items": [(string), ... ] /* required */
},
"TurboPageId": (long)
},
"SmartAdBuilderAd": { /* SmartAdBuilderAdAdd */
"Creative": { /* AdBuilderAdAddItem */
"CreativeId": (long) /* required */
}, /* required */
"ErirAdDescription" : (string)
},
"ShoppingAd" : {
"SitelinkSetId" : (long),
"AdExtensionIds" : [ (long) ],
"BusinessId" : (long),
"FeedId" : (long) /* required */,
"FeedFilterConditions" : [ {
"Operand" : (string) /* required */,
"Operator" : ("CONTAINS_ANY"|"EQUALS_ANY"|"EXISTS"|"GREATER_THAN"|"IN_RANGE"|"LESS_THAN"|"NOT_CONTAINS_ALL") /* required */,
"Arguments" : [ (string) ] /* required */
}, ... ],
},
"TitleSources" : [ (string) ],
"TextSources" : [ (string) ],
"DefaultTexts" : [ (string) ] /* required */
},
"ListingAd" : {
"SitelinkSetId" : (long),
"AdExtensionIds" : [ (long) ],
"BusinessId" : (long),
"FeedId" : (long) /* required */,
"FeedFilterConditions" : [ {
"Operand" : (string) /* required */,
"Operator" : ("CONTAINS_ANY"|"EQUALS_ANY"|"EXISTS"|"GREATER_THAN"|"IN_RANGE"|"LESS_THAN"|"NOT_CONTAINS_ALL") /* required */,
"Arguments" : [ (string) ] /* required */
}, ... ],
},
"TitleSources" : [ (string) ],
"TextSources" : [ (string) ],
"DefaultTexts" : [ (string) ] /* required */
}
}, ... ] /* required */
}
}
Parameter | Type | Description | Required |
Params structure (for JSON) / AddRequest structure (for SOAP) | |||
---|---|---|---|
Ads | array of AdAddItem | Ads to add. | Yes |
AdAddItem structure | |||
AdGroupId | long | ID of the group that the ad is being created in. | Yes |
TextAd | TextAdAdd | Parameters of a Text & Image ad. See Ad typewhen calling finance methods. | Either TextAd, or MobileAppAd, or DynamicTextAd, or TextImageAd, or MobileAppImageAd, or TextAdBuilderAd, or MobileAppAdBuilderAd, or MobileAppCpcVideoAdBuilderAd, or CpcVideoAdBuilderAd, or CpmBannerAdBuilderAd, or CpmVideoAdBuilderAd, or SmartAdBuilderAd |
DynamicTextAd | DynamicTextAdAdd | Parameters of a dynamic ad. | |
MobileAppAd | MobileAppAdAdd | Parameters of a mobile app ad. | |
TextImageAd | TextImageAdAdd | Parameters of an image ad to create from an image (when adding it to a group of Text & Image ads). | |
MobileAppImageAd | MobileAppImageAdAdd | Parameters of an image ad to create from an image (when adding it to a group of mobile app ads). | |
TextAdBuilderAd | TextAdBuilderAdAdd | Parameters of an image ad to create from a creative (when adding it to a group of Text & Image ads). | |
MobileAppAdBuilderAd | MobileAppAdBuilderAdAdd | Parameters of an image ad to create from a creative (when adding it to a group of mobile app ads). | |
MobileAppCpcVideoAdBuilderAd | MobileAppCpcVideoAdBuilderAdAdd | Parameters of a video ad to create from a creative (when adding it to a group of ads for mobile apps). | |
CpmBannerAdBuilderAd | CpmBannerAdBuilderAdAdd | Display ad parameters. | |
CpcVideoAdBuilderAd | CpcVideoAdBuilderAdAdd | Video ad parameters (in “Text & Image ads” campaigns). | |
CpmVideoAdBuilderAd | CpmVideoAdBuilderAdAdd | Parameters of a display video ad (in a “Display campaign”). | |
SmartAdBuilderAd | SmartAdBuilderAdAdd | Smart banner parameters. | |
ShoppingAd | ShoppingAdAdd | Product ad parameters. | |
ListingAd | ListingAdAdd | Parameters of ads for catalog pages. | |
TextAdAdd structure | |||
Title | string | Title 1. Maximum of 56 characters, counting "narrow" characters. Maximum of 22 characters per word. If using a template, the # symbol isn't counted in the length. | Yes |
Title2 | string | Title 2. Maximum of 30 characters not counting "narrow" characters, plus up to 15 "narrow" characters. Maximum of 22 characters per word. If using a template, the # symbol isn't counted in the length. | No |
Text | string | Ad text. Maximum of 81 characters not counting "narrow" characters, plus up to 15 "narrow" characters. Maximum of 23 characters per word. If using a template, the # symbol isn't counted in the length. | Yes |
Mobile | YesNoEnum | Indicates whether this is a mobile ad: YES or NO. See Mobile ads in the Help for Yandex Direct. | Yes |
Href | string | Link to the advertiser's website. Maximum of 1024 characters. If using a template, the # symbol isn't counted in the length. It must include the protocol and domain name. May contain substitution variables. | At least one of the parameters Href, TurboPageId, VCardId, or BusinessId (or all may be present) |
TurboPageId | long | ID of the Turbo page. | |
VCardId | long | ID of the vCard. The vCard must belong to the same campaign as the ad. | |
BusinessId | long | ID of the business profile on Yandex. To get data from business profiles, use the Businesses.get method. A business profile can be linked to an ad only if the YES value is returned for the IsPublished parameter. Note. The business profile is available at https://yandex.ru/profile/<id_profile> . | |
PreferVCardOverBusiness | YesNoEnum | Indicates which data source takes priority when displaying an ad: YES — vCard, NO — business profile. Restriction. This parameter is used if the VCardID and BusinessId values are filled in. If one of these values is deleted, you must set the PreferVCardOverBusiness parameter to NO. | No |
ErirAdDescription | string | Ad object description. | No |
AdImageHash | string | Hash of the image. For Text & Image ads, only images with the REGULAR or WIDE type are acceptable. See Type of image. | No |
SitelinkSetId | long | ID of a set of sitelinks. Allowed only with the Href or TurboPageId parameter. | No |
DisplayUrlPath | string | Display link. Allowed only with the Href parameter. Maximum of 20 characters. If using a template, the # symbol isn't counted in the length. It may contain letters, numbers, and the symbols -, №, /, %, #. Spaces, underscores (_), and double characters -- and // are not allowed. See Display link in the Help for Yandex Direct. | No |
AdExtensionIds | array of long | IDs of extensions. Maximum of 50 items in the array. | No |
VideoExtension | VideoExtensionAddItem | Video extension. See See Video extensions in the Help for Yandex Direct. | No |
PriceExtension | PriceExtensionAddItem | Price in the ad. | No |
VideoExtensionAddItem structure | |||
CreativeId | long | ID of the creative. | Yes |
PriceExtensionAddItem structure | |||
Price | long | The price of a product or service multiplied by 1,000,000. An integer that is a multiple of 10,000 (the price with two digits after the decimal point). Maximum value: 10,000,000,000,000,000. | Yes |
OldPrice | long | The previous price of a product or service multiplied by 1,000,000. An integer that is a multiple of 10,000. The old price must be higher than the current price. | No |
PriceQualifier | PriceQualifierEnum | Text explanation of the price:
| Yes |
PriceCurrency | PriceCurrencyEnum | The currency that the price is shown in. | Yes |
DynamicTextAdAdd structure | |||
VCardId | long | ID of the vCard. The vCard must belong to the same campaign as the ad. | No |
AdImageHash | string | Hash of the image. For dynamic ads, only images with the REGULAR or WIDE type are acceptable. See Type of image. | No |
SitelinkSetId | long | ID of a set of sitelinks. | No |
AdExtensionIds | array of long | IDs of extensions. Maximum of 50 items in the array. | No |
Text | string | Ad text. Maximum of 81 characters not counting "narrow" characters, plus up to 15 "narrow" characters. Maximum of 23 characters per word. If using a template, the # symbol isn't counted in the length. | Yes |
MobileAppAdAdd structure | |||
AdImageHash | string | Hash of the image. For mobile app ads, only images with the WIDE type are acceptable. See Type of image. | No |
Text | string | Ad text. Maximum of 75 characters, counting “narrow” characters. Maximum of 23 characters per word. If using a template, the # symbol isn't counted in the length. | Yes |
Title | string | Title. Maximum of 56 characters, counting “narrow” characters. Maximum of 22 characters per word. If using a template, the # symbol isn't counted in the length. | Yes |
TrackingUrl | string | Tracking link for tracking app installations. Maximum of 1024 characters. It must include the protocol and domain name. | No |
Action | MobileAppAdActionEnum | The button label:
| Yes |
Features | array of MobileAppAdFeatureItem | Add-ons that need to be automatically downloaded from the app store and displayed in the ad. | No |
AgeLabel | MobAppAgeLabelEnum | Age restriction. The default value is AGE_18. | No |
VideoExtension | VideoExtensionAddItem | Video extension. See See Video extensions in the Help for Yandex Direct. | No |
ErirAdDescription | string | Ad object description. | No |
MobileAppAdFeatureItem structure | |||
Feature | MobileAppFeatureEnum | Type of extension:
If the add-on type is omitted from the Features array, the add-on is not shown. | Yes |
Enabled | YesNoEnum | Whether to display an add-on in the ad. Note.
| Yes |
TextImageAdAdd structure | |||
AdImageHash | string | Hash of the image. For image ads, only images with the FIXED_IMAGE type are acceptable. See Type of image. | Yes |
ErirAdDescription | string | Ad object description. | No |
Href | string | Link to the advertiser's website. Maximum of 1024 characters. If using a template, the # symbol isn't counted in the length. It must include the protocol and domain name. May contain substitution variables. | One or both of the Href and TurboPageId parameters |
TurboPageId | long | ID of the Turbo page. | |
MobileAppImageAdAdd structure | |||
AdImageHash | string | Hash of the image. For image ads, only images with the FIXED_IMAGE type are acceptable. See Type of image. | Yes |
ErirAdDescription | string | Ad object description. | No |
TrackingUrl | string | Tracking link for tracking app installations. Maximum of 1024 characters. It must include the protocol and domain name. | No |
TextAdBuilderAdAdd structure | |||
Creative | AdBuilderAdAddItem | A creative that was created in the Ad Builder. See Ad Builder for image ads in the Help for Yandex Direct. | Yes |
ErirAdDescription | string | Ad object description. | No |
Href | string | Link to the advertiser's website. Maximum of 1024 characters. If using a template, the # symbol isn't counted in the length. It must include the protocol and domain name. May contain substitution variables. | One or both of the Href and TurboPageId parameters |
TurboPageId | long | ID of the Turbo page. | |
MobileAppAdBuilderAdAdd structure | |||
Creative | AdBuilderAdAddItem | A creative that was created in the Ad Builder. See Ad Builder for image ads in the Help for Yandex Direct. | Yes |
ErirAdDescription | string | Ad object description. | No |
TrackingUrl | string | Tracking link for tracking app installations. Maximum of 1024 characters. It must include the protocol and domain name. | No |
MobileAppCpcVideoAdBuilderAdAdd structure | |||
Creative | AdBuilderAdAddItem | A creative that was created in the Ad Builder. See See Ad Builder for video ads in the Help for Yandex Direct. | Yes |
ErirAdDescription | string | Ad object description. | No |
TrackingUrl | string | Tracking link for tracking app installations. Maximum of 1024 characters. It must include the protocol and domain name. | No |
CpmBannerAdBuilderAdAdd structure | |||
Creative | AdBuilderAdAddItem | A creative that was uploaded in the web interface or created in the Ad Builder. See How to launch a display campaign in the Help for Yandex Direct. | Yes |
ErirAdDescription | string | Ad object description. | No |
Href | string | Link to the advertiser's website. Maximum of 1024 characters. If using a template, the # symbol isn't counted in the length. It must include the protocol and domain name. May contain substitution variables. | One or both of the Href and TurboPageId parameters |
TurboPageId | long | ID of the Turbo page. | |
TrackingPixels | ArrayOfString | Can contain a maximum of two strings:
The maximum length of each string is 1024 characters. | No |
CpcVideoAdBuilderAdAdd structure | |||
Creative | AdBuilderAdAddItem | A creative that was created in the Ad Builder. See Video ads / Ad Builder in the Help for Yandex Direct. | Yes |
ErirAdDescription | string | Ad object description. | No |
Href | string | Link to the advertiser's website. Maximum of 1024 characters. If using a template, the # symbol isn't counted in the length. It must include the protocol and domain name. May contain substitution variables. | One or both of the Href and TurboPageId parameters |
TurboPageId | long | ID of the Turbo page. | |
CpmVideoAdBuilderAdAdd structure | |||
Creative | AdBuilderAdAddItem | A creative that was created in the Ad Builder. See Video advertising / How to launch in the Help for Yandex Direct. | Yes |
ErirAdDescription | string | Ad object description. | No |
Href | string | Link to the advertiser's website. Maximum of 1024 characters. If using a template, the # symbol isn't counted in the length. It must include the protocol and domain name. May contain substitution variables. | One or both of the Href and TurboPageId parameters |
TurboPageId | long | ID of the Turbo page. | |
TrackingPixels | ArrayOfString | An ADFOX tracking tag. The tag must have the %random% or %aw_random% macro. Maximum of 1024 characters. | No |
SmartAdBuilderAdAdd structure | |||
Creative | AdBuilderAdAddItem | A creative that was created in the Ad Builder. See Ad Builder for smart banners in the Help for Yandex Direct. | Yes |
ErirAdDescription | string | Ad object description. | No |
AdBuilderAdAddItem structure | |||
CreativeId | long | ID of the creative. | Yes |
ShoppingAdAdd structure | |||
SitelinkSetId | long | ID of a set of sitelinks. | No |
AdExtensionIds | array of long | IDs of extensions. Maximum of 50 items in the array. | No |
BusinessId | long | ID of the business profile on Yandex. To get data from business profiles, use the Businesses.get method. A business profile can be linked to an ad only if the YES value is returned for the IsPublished parameter. Note. The business profile is available at https://yandex.ru/profile/<id_profile> . | No |
FeedId | long | ID of the feed to generate ads from. | Yes |
FeedFilterConditions | FeedFilterConditionsItem | Rules for selecting product offers. No more than 30 filters in the array. The total length of the selection rules is a maximum of 65 KB (in JSON). A product offer is selected for ad generation if it meets all the selection rules at the same time. If this parameter is omitted, all product offers from the feed are used for ad generation. | No |
TitleSources | array of string | Names of feed fields used to generate ad titles. You can get the acceptable field names in the TitleAndTextSources field of the feeds.get method. | No |
TextSources | array of string | Names of feed fields used to generate ad texts. You can get the acceptable field names in the TitleAndTextSources field of the feeds.get method. | No |
DefaultTexts | array of string | Default texts. You can specify only one value. | Yes |
ListingAdAdd structure | |||
SitelinkSetId | long | ID of a set of sitelinks. | No |
AdExtensionIds | array of long | IDs of extensions. Maximum of 50 items in the array. | No |
BusinessId | long | ID of the business profile on Yandex. To get data from business profiles, use the Businesses.get method. A business profile can be linked to an ad only if the YES value is returned for the IsPublished parameter. Note. The business profile is available at https://yandex.ru/profile/<id_profile> . | No |
FeedId | long | ID of the feed to generate ads from. | Yes |
FeedFilterConditions | FeedFilterConditionsItem | Rules for selecting product offers. No more than 30 filters in the array. The total length of the selection rules is a maximum of 65 KB (in JSON). A product offer is selected for ad generation if it meets all the selection rules at the same time. If this parameter is omitted, all product offers from the feed are used for ad generation. | No |
TitleSources | array of string | Names of feed fields used to generate ad titles. You can get the acceptable field names in the TitleAndTextSources field of the feeds.get method. | No |
TextSources | array of string | Names of feed fields used to generate ad texts. You can get the acceptable field names in the TitleAndTextSources field of the feeds.get method. | No |
DefaultTexts | array of string | Default texts. You can specify only one value. | Yes |
FeedFilterConditionsItem structure | |||
Operand | string | Feed parameter. For a description of fields for each type of feed, see Configuring filters in the Help for Yandex Direct. | Yes |
Operator | StringConditionOperatorEnum | Comparison operator. For information on the compatibility of feed fields and operators, as well as restrictions on values, see Rules for selecting product ads.. | Yes |
Arguments | array of string | An array of strings to compare the operand to. | Yes |
Parameter | Type | Description | Required |
Params structure (for JSON) / AddRequest structure (for SOAP) | |||
---|---|---|---|
Ads | array of AdAddItem | Ads to add. | Yes |
AdAddItem structure | |||
AdGroupId | long | ID of the group that the ad is being created in. | Yes |
TextAd | TextAdAdd | Parameters of a Text & Image ad. See Ad typewhen calling finance methods. | Either TextAd, or MobileAppAd, or DynamicTextAd, or TextImageAd, or MobileAppImageAd, or TextAdBuilderAd, or MobileAppAdBuilderAd, or MobileAppCpcVideoAdBuilderAd, or CpcVideoAdBuilderAd, or CpmBannerAdBuilderAd, or CpmVideoAdBuilderAd, or SmartAdBuilderAd |
DynamicTextAd | DynamicTextAdAdd | Parameters of a dynamic ad. | |
MobileAppAd | MobileAppAdAdd | Parameters of a mobile app ad. | |
TextImageAd | TextImageAdAdd | Parameters of an image ad to create from an image (when adding it to a group of Text & Image ads). | |
MobileAppImageAd | MobileAppImageAdAdd | Parameters of an image ad to create from an image (when adding it to a group of mobile app ads). | |
TextAdBuilderAd | TextAdBuilderAdAdd | Parameters of an image ad to create from a creative (when adding it to a group of Text & Image ads). | |
MobileAppAdBuilderAd | MobileAppAdBuilderAdAdd | Parameters of an image ad to create from a creative (when adding it to a group of mobile app ads). | |
MobileAppCpcVideoAdBuilderAd | MobileAppCpcVideoAdBuilderAdAdd | Parameters of a video ad to create from a creative (when adding it to a group of ads for mobile apps). | |
CpmBannerAdBuilderAd | CpmBannerAdBuilderAdAdd | Display ad parameters. | |
CpcVideoAdBuilderAd | CpcVideoAdBuilderAdAdd | Video ad parameters (in “Text & Image ads” campaigns). | |
CpmVideoAdBuilderAd | CpmVideoAdBuilderAdAdd | Parameters of a display video ad (in a “Display campaign”). | |
SmartAdBuilderAd | SmartAdBuilderAdAdd | Smart banner parameters. | |
ShoppingAd | ShoppingAdAdd | Product ad parameters. | |
ListingAd | ListingAdAdd | Parameters of ads for catalog pages. | |
TextAdAdd structure | |||
Title | string | Title 1. Maximum of 56 characters, counting "narrow" characters. Maximum of 22 characters per word. If using a template, the # symbol isn't counted in the length. | Yes |
Title2 | string | Title 2. Maximum of 30 characters not counting "narrow" characters, plus up to 15 "narrow" characters. Maximum of 22 characters per word. If using a template, the # symbol isn't counted in the length. | No |
Text | string | Ad text. Maximum of 81 characters not counting "narrow" characters, plus up to 15 "narrow" characters. Maximum of 23 characters per word. If using a template, the # symbol isn't counted in the length. | Yes |
Mobile | YesNoEnum | Indicates whether this is a mobile ad: YES or NO. See Mobile ads in the Help for Yandex Direct. | Yes |
Href | string | Link to the advertiser's website. Maximum of 1024 characters. If using a template, the # symbol isn't counted in the length. It must include the protocol and domain name. May contain substitution variables. | At least one of the parameters Href, TurboPageId, VCardId, or BusinessId (or all may be present) |
TurboPageId | long | ID of the Turbo page. | |
VCardId | long | ID of the vCard. The vCard must belong to the same campaign as the ad. | |
BusinessId | long | ID of the business profile on Yandex. To get data from business profiles, use the Businesses.get method. A business profile can be linked to an ad only if the YES value is returned for the IsPublished parameter. Note. The business profile is available at https://yandex.ru/profile/<id_profile> . | |
PreferVCardOverBusiness | YesNoEnum | Indicates which data source takes priority when displaying an ad: YES — vCard, NO — business profile. Restriction. This parameter is used if the VCardID and BusinessId values are filled in. If one of these values is deleted, you must set the PreferVCardOverBusiness parameter to NO. | No |
ErirAdDescription | string | Ad object description. | No |
AdImageHash | string | Hash of the image. For Text & Image ads, only images with the REGULAR or WIDE type are acceptable. See Type of image. | No |
SitelinkSetId | long | ID of a set of sitelinks. Allowed only with the Href or TurboPageId parameter. | No |
DisplayUrlPath | string | Display link. Allowed only with the Href parameter. Maximum of 20 characters. If using a template, the # symbol isn't counted in the length. It may contain letters, numbers, and the symbols -, №, /, %, #. Spaces, underscores (_), and double characters -- and // are not allowed. See Display link in the Help for Yandex Direct. | No |
AdExtensionIds | array of long | IDs of extensions. Maximum of 50 items in the array. | No |
VideoExtension | VideoExtensionAddItem | Video extension. See See Video extensions in the Help for Yandex Direct. | No |
PriceExtension | PriceExtensionAddItem | Price in the ad. | No |
VideoExtensionAddItem structure | |||
CreativeId | long | ID of the creative. | Yes |
PriceExtensionAddItem structure | |||
Price | long | The price of a product or service multiplied by 1,000,000. An integer that is a multiple of 10,000 (the price with two digits after the decimal point). Maximum value: 10,000,000,000,000,000. | Yes |
OldPrice | long | The previous price of a product or service multiplied by 1,000,000. An integer that is a multiple of 10,000. The old price must be higher than the current price. | No |
PriceQualifier | PriceQualifierEnum | Text explanation of the price:
| Yes |
PriceCurrency | PriceCurrencyEnum | The currency that the price is shown in. | Yes |
DynamicTextAdAdd structure | |||
VCardId | long | ID of the vCard. The vCard must belong to the same campaign as the ad. | No |
AdImageHash | string | Hash of the image. For dynamic ads, only images with the REGULAR or WIDE type are acceptable. See Type of image. | No |
SitelinkSetId | long | ID of a set of sitelinks. | No |
AdExtensionIds | array of long | IDs of extensions. Maximum of 50 items in the array. | No |
Text | string | Ad text. Maximum of 81 characters not counting "narrow" characters, plus up to 15 "narrow" characters. Maximum of 23 characters per word. If using a template, the # symbol isn't counted in the length. | Yes |
MobileAppAdAdd structure | |||
AdImageHash | string | Hash of the image. For mobile app ads, only images with the WIDE type are acceptable. See Type of image. | No |
Text | string | Ad text. Maximum of 75 characters, counting “narrow” characters. Maximum of 23 characters per word. If using a template, the # symbol isn't counted in the length. | Yes |
Title | string | Title. Maximum of 56 characters, counting “narrow” characters. Maximum of 22 characters per word. If using a template, the # symbol isn't counted in the length. | Yes |
TrackingUrl | string | Tracking link for tracking app installations. Maximum of 1024 characters. It must include the protocol and domain name. | No |
Action | MobileAppAdActionEnum | The button label:
| Yes |
Features | array of MobileAppAdFeatureItem | Add-ons that need to be automatically downloaded from the app store and displayed in the ad. | No |
AgeLabel | MobAppAgeLabelEnum | Age restriction. The default value is AGE_18. | No |
VideoExtension | VideoExtensionAddItem | Video extension. See See Video extensions in the Help for Yandex Direct. | No |
ErirAdDescription | string | Ad object description. | No |
MobileAppAdFeatureItem structure | |||
Feature | MobileAppFeatureEnum | Type of extension:
If the add-on type is omitted from the Features array, the add-on is not shown. | Yes |
Enabled | YesNoEnum | Whether to display an add-on in the ad. Note.
| Yes |
TextImageAdAdd structure | |||
AdImageHash | string | Hash of the image. For image ads, only images with the FIXED_IMAGE type are acceptable. See Type of image. | Yes |
ErirAdDescription | string | Ad object description. | No |
Href | string | Link to the advertiser's website. Maximum of 1024 characters. If using a template, the # symbol isn't counted in the length. It must include the protocol and domain name. May contain substitution variables. | One or both of the Href and TurboPageId parameters |
TurboPageId | long | ID of the Turbo page. | |
MobileAppImageAdAdd structure | |||
AdImageHash | string | Hash of the image. For image ads, only images with the FIXED_IMAGE type are acceptable. See Type of image. | Yes |
ErirAdDescription | string | Ad object description. | No |
TrackingUrl | string | Tracking link for tracking app installations. Maximum of 1024 characters. It must include the protocol and domain name. | No |
TextAdBuilderAdAdd structure | |||
Creative | AdBuilderAdAddItem | A creative that was created in the Ad Builder. See Ad Builder for image ads in the Help for Yandex Direct. | Yes |
ErirAdDescription | string | Ad object description. | No |
Href | string | Link to the advertiser's website. Maximum of 1024 characters. If using a template, the # symbol isn't counted in the length. It must include the protocol and domain name. May contain substitution variables. | One or both of the Href and TurboPageId parameters |
TurboPageId | long | ID of the Turbo page. | |
MobileAppAdBuilderAdAdd structure | |||
Creative | AdBuilderAdAddItem | A creative that was created in the Ad Builder. See Ad Builder for image ads in the Help for Yandex Direct. | Yes |
ErirAdDescription | string | Ad object description. | No |
TrackingUrl | string | Tracking link for tracking app installations. Maximum of 1024 characters. It must include the protocol and domain name. | No |
MobileAppCpcVideoAdBuilderAdAdd structure | |||
Creative | AdBuilderAdAddItem | A creative that was created in the Ad Builder. See See Ad Builder for video ads in the Help for Yandex Direct. | Yes |
ErirAdDescription | string | Ad object description. | No |
TrackingUrl | string | Tracking link for tracking app installations. Maximum of 1024 characters. It must include the protocol and domain name. | No |
CpmBannerAdBuilderAdAdd structure | |||
Creative | AdBuilderAdAddItem | A creative that was uploaded in the web interface or created in the Ad Builder. See How to launch a display campaign in the Help for Yandex Direct. | Yes |
ErirAdDescription | string | Ad object description. | No |
Href | string | Link to the advertiser's website. Maximum of 1024 characters. If using a template, the # symbol isn't counted in the length. It must include the protocol and domain name. May contain substitution variables. | One or both of the Href and TurboPageId parameters |
TurboPageId | long | ID of the Turbo page. | |
TrackingPixels | ArrayOfString | Can contain a maximum of two strings:
The maximum length of each string is 1024 characters. | No |
CpcVideoAdBuilderAdAdd structure | |||
Creative | AdBuilderAdAddItem | A creative that was created in the Ad Builder. See Video ads / Ad Builder in the Help for Yandex Direct. | Yes |
ErirAdDescription | string | Ad object description. | No |
Href | string | Link to the advertiser's website. Maximum of 1024 characters. If using a template, the # symbol isn't counted in the length. It must include the protocol and domain name. May contain substitution variables. | One or both of the Href and TurboPageId parameters |
TurboPageId | long | ID of the Turbo page. | |
CpmVideoAdBuilderAdAdd structure | |||
Creative | AdBuilderAdAddItem | A creative that was created in the Ad Builder. See Video advertising / How to launch in the Help for Yandex Direct. | Yes |
ErirAdDescription | string | Ad object description. | No |
Href | string | Link to the advertiser's website. Maximum of 1024 characters. If using a template, the # symbol isn't counted in the length. It must include the protocol and domain name. May contain substitution variables. | One or both of the Href and TurboPageId parameters |
TurboPageId | long | ID of the Turbo page. | |
TrackingPixels | ArrayOfString | An ADFOX tracking tag. The tag must have the %random% or %aw_random% macro. Maximum of 1024 characters. | No |
SmartAdBuilderAdAdd structure | |||
Creative | AdBuilderAdAddItem | A creative that was created in the Ad Builder. See Ad Builder for smart banners in the Help for Yandex Direct. | Yes |
ErirAdDescription | string | Ad object description. | No |
AdBuilderAdAddItem structure | |||
CreativeId | long | ID of the creative. | Yes |
ShoppingAdAdd structure | |||
SitelinkSetId | long | ID of a set of sitelinks. | No |
AdExtensionIds | array of long | IDs of extensions. Maximum of 50 items in the array. | No |
BusinessId | long | ID of the business profile on Yandex. To get data from business profiles, use the Businesses.get method. A business profile can be linked to an ad only if the YES value is returned for the IsPublished parameter. Note. The business profile is available at https://yandex.ru/profile/<id_profile> . | No |
FeedId | long | ID of the feed to generate ads from. | Yes |
FeedFilterConditions | FeedFilterConditionsItem | Rules for selecting product offers. No more than 30 filters in the array. The total length of the selection rules is a maximum of 65 KB (in JSON). A product offer is selected for ad generation if it meets all the selection rules at the same time. If this parameter is omitted, all product offers from the feed are used for ad generation. | No |
TitleSources | array of string | Names of feed fields used to generate ad titles. You can get the acceptable field names in the TitleAndTextSources field of the feeds.get method. | No |
TextSources | array of string | Names of feed fields used to generate ad texts. You can get the acceptable field names in the TitleAndTextSources field of the feeds.get method. | No |
DefaultTexts | array of string | Default texts. You can specify only one value. | Yes |
ListingAdAdd structure | |||
SitelinkSetId | long | ID of a set of sitelinks. | No |
AdExtensionIds | array of long | IDs of extensions. Maximum of 50 items in the array. | No |
BusinessId | long | ID of the business profile on Yandex. To get data from business profiles, use the Businesses.get method. A business profile can be linked to an ad only if the YES value is returned for the IsPublished parameter. Note. The business profile is available at https://yandex.ru/profile/<id_profile> . | No |
FeedId | long | ID of the feed to generate ads from. | Yes |
FeedFilterConditions | FeedFilterConditionsItem | Rules for selecting product offers. No more than 30 filters in the array. The total length of the selection rules is a maximum of 65 KB (in JSON). A product offer is selected for ad generation if it meets all the selection rules at the same time. If this parameter is omitted, all product offers from the feed are used for ad generation. | No |
TitleSources | array of string | Names of feed fields used to generate ad titles. You can get the acceptable field names in the TitleAndTextSources field of the feeds.get method. | No |
TextSources | array of string | Names of feed fields used to generate ad texts. You can get the acceptable field names in the TitleAndTextSources field of the feeds.get method. | No |
DefaultTexts | array of string | Default texts. You can specify only one value. | Yes |
FeedFilterConditionsItem structure | |||
Operand | string | Feed parameter. For a description of fields for each type of feed, see Configuring filters in the Help for Yandex Direct. | Yes |
Operator | StringConditionOperatorEnum | Comparison operator. For information on the compatibility of feed fields and operators, as well as restrictions on values, see Rules for selecting product ads.. | Yes |
Arguments | array of string | An array of strings to compare the operand to. | Yes |
Response
Response structure in JSON format:
{
"result": { /* result */
"AddResults": [{ /* ActionResult */
"Id": (long),
"Warnings": [{ /* ExceptionNotification */
"Code": (int), /* required */
"Message": (string), /* required */
"Details": (string)
}, ... ],
"Errors": [{ /* ExceptionNotification */
"Code": (int), /* required */
"Message": (string), /* required */
"Details": (string)
}, ... ]
}, ... ]
}
}
Parameter | Type | Description |
Result structure (for JSON) / AddResponse structure (for SOAP) | ||
---|---|---|
AddResults | array of ActionResult | Results of adding ads. |
ActionResult structure | ||
Id | long | ID of the ad that was created. Returned if there are no errors, see Operations on object arrays. |
Warnings | array of ExceptionNotification | Warnings that occurred during the operation. |
Errors | array of ExceptionNotification | Errors that occurred during the operation. |
Parameter | Type | Description |
Result structure (for JSON) / AddResponse structure (for SOAP) | ||
---|---|---|
AddResults | array of ActionResult | Results of adding ads. |
ActionResult structure | ||
Id | long | ID of the ad that was created. Returned if there are no errors, see Operations on object arrays. |
Warnings | array of ExceptionNotification | Warnings that occurred during the operation. |
Errors | array of ExceptionNotification | Errors that occurred during the operation. |