update

Changes ad parameters.

Learn more

Restrictions

To manage product ads, use the URL: https://api.direct.yandex.com/v501/.

Maximum of 1000 ads per method call.

You can't edit ads with the ARCHIVED status. See Ad status and state.

Request

Request structure in JSON format:

{
  "method": "update",
  "params": { /* params */
    "Ads": [{  /* AdUpdateItem */
      "Id": (long), /* required */
      "TextAd": {  /* TextAdUpdate */
        "Title": (string),
        "Title2": (string), /* nillable */
        "Text": (string),
        "Href": (string), /* nillable */
        "AgeLabel": ( "AGE_0" | ... | "MONTHS_12" ),
        "DisplayUrlPath": (string), /* nillable */
        "VCardId": (long), /* nillable */
        "AdImageHash": (string), /* nillable */
        "SitelinkSetId": (long), /* nillable */
        "CalloutSetting": {  /* AdExtensionSetting */
          "AdExtensions": [{  /* AdExtensionSettingItem */
            "AdExtensionId": (long), /* required */
            "Operation": ( "ADD" | "REMOVE" | "SET" ) /* required */
          }, ... ] /* required */
        }, /* nillable */
        "VideoExtension": {  /* VideoExtensionUpdateItem */
          "CreativeId": (long) /* nillable */
        },
        "PriceExtension": {  /* PriceExtensionUpdateItem */
          "Price": (long),
          "OldPrice": (long), /* nillable */
          "PriceQualifier": ( "FROM" | "UP_TO" | "NONE" ),
          "PriceCurrency": ( "RUB" | "BYN" | "CHF" | "EUR" | "KZT" | "TRY" | "UAH" | "USD" | "UZS" )
        }, /* nillable */
        "TurboPageId": (long), /* nillable */
        "BusinessId": (long), /* nillable */
        "PreferVCardOverBusiness": ( "YES" | "NO" ),
        "ErirAdDescription" : (string) /* nillable */
      },
      "TextImageAd": {  /* TextImageAdUpdate */
        "AdImageHash": (string),
        "Href": (string), /* nillable */
        "TurboPageId": (long), /* nillable */
        "ErirAdDescription" : (string) /* nillable */
      },
      "TextAdBuilderAd": {  /* TextAdBuilderAdUpdate */
        "Creative": { /* AdBuilderAdUpdateItem */
          "CreativeId": (long) /* required */
        },
        "Href": (string), /* nillable */
        "TurboPageId": (long), /* nillable */
        "ErirAdDescription" : (string) /* nillable */
      },
      "CpmBannerAdBuilderAd": {  /* CpmBannerAdBuilderAdUpdate */
        "Creative": { /* AdBuilderAdUpdateItem */
          "CreativeId": (long) /* required */
        },
        "Href": (string), /* nillable */
        "TrackingPixels": { /* ArrayOfString */
          "Items": [(string), ... ] /* required */
        }, /* nillable */
        "TurboPageId": (long), /* nillable */
        "ErirAdDescription" : (string) /* nillable */
      },
      "CpmVideoAdBuilderAd": {  /* CpmVideoAdBuilderAdUpdate */
        "Creative": { /* AdBuilderAdUpdateItem */
          "CreativeId": (long) /* required */
        },
        "Href": (string),  /* nillable */
        "TrackingPixels": { /* ArrayOfString */
          "Items": [(string), ... ] /* required */
        }, /* nillable */
        "TurboPageId": (long),
        "ErirAdDescription" : (string) /* nillable */
      },
      "ShoppingAd" : {
          "SitelinkSetId" : (long) /* nillable */,
          "CalloutSetting" : { /* nillable */
            "AdExtensions" : [{ /* required */
                "AdExtensionId" : (long) /* required */,
                "Operation" : ("ADD"|"REMOVE"|"SET") /* required */
            }, ... ]
          },
          "BusinessId" : (long) /* nillable */,
          "FeedFilterConditions" : { /* nillable */
            "Items" : [{ /* required */
                "Operand" : (string) /* required */,
                "Operator" : ("CONTAINS_ANY"|"EQUALS_ANY"|"EXISTS"|"GREATER_THAN"|"IN_RANGE"|"LESS_THAN"|"NOT_CONTAINS_ALL") /* required */,
                "Arguments" : [ (string) ] /* required */
            }, ... ]
          },
          "TitleSources" : { /* nillable */
              "Items" : [ (string) ] /* required */
          },
          "TextSources" : { /* nillable */
              "Items" : [ (string) ] /* required */
          },
          "DefaultTexts" : [ (string) ]
      },
      "ListingAd" : {
          "SitelinkSetId" : (long) /* nillable */,
          "CalloutSetting" : { /* nillable */
            "AdExtensions" : [{ /* required */
                "AdExtensionId" : (long) /* required */,
                "Operation" : ("ADD"|"REMOVE"|"SET") /* required */
            }, ... ]
          },
          "BusinessId" : (long) /* nillable */,
          "FeedFilterConditions" : { /* nillable */
            "Items" : [{ /* required */
                "Operand" : (string) /* required */,
                "Operator" : ("CONTAINS_ANY"|"EQUALS_ANY"|"EXISTS"|"GREATER_THAN"|"IN_RANGE"|"LESS_THAN"|"NOT_CONTAINS_ALL") /* required */,
                "Arguments" : [ (string) ] /* required */
            }, ... ]
          },
          "TitleSources" : { /* nillable */
              "Items" : [ (string) ] /* required */
          },
          "TextSources" : { /* nillable */
              "Items" : [ (string) ] /* required */
          },
          "DefaultTexts" : [ (string) ]
      }
    }, ... ] /* required */
  }
}

Parameter	Type	Description	Required
params structure (for JSON) / UpdateRequest structure (for SOAP)
`Ads`	array of AdUpdateItem	Ads to change parameters for.	Yes
AdUpdateItem structure
`Id`	long	The ID of the ad to change parameters for.	Yes
`TextAd`	TextAdUpdate	Parameters of a Text & Image ad. See Ad type.	Use either `TextAd` or `MobileAppAd` or `DynamicTextAd` or `TextImageAd` or `MobileAppImageAd` or `MobileAppCpcVideoAdBuilderAd` or `TextAdBuilderAd` or `MobileAppAdBuilderAd` or `CpcVideoAdBuilderAd` or `CpmBannerAdBuilderAd` or `CpmVideoAdBuilderAd` or `SmartAdBuilderAd`.
`TextImageAd`	TextImageAdUpdate	Parameters of an image ad that was generated from an image (in a group of Text & Image ads).
`TextAdBuilderAd`	TextAdBuilderAdUpdate	Parameters of an image ad that was generated from a creative (in a group of Text & Image ads).
`CpmBannerAdBuilderAd`	CpmBannerAdBuilderAdUpdate	Display ad parameters.
`CpmVideoAdBuilderAd`	CpmVideoAdBuilderAdUpdate	Parameters of a display video ad in a display campaign.
`ShoppingAd`	ShoppingAdUpdate	Product ad parameters.
`ListingAd`	ListingAdUpdate	Parameters of an ad for catalog pages.
TextAdUpdate structure
`Title`	string	Title 1. Maximum of 56 characters, counting "narrow" characters. Maximum of 22 characters per word. When using a template, the # character doesn't count towards the length. Note "Narrow" characters are: `!,.;:"`	No
`Title2`	string, nillable	Title 2. A maximum of 30 characters not counting “narrow” characters, plus up to 15 “narrow” characters. Maximum of 22 characters per word. When using a template, the # character doesn't count towards the length. Note "Narrow" characters are: `!,.;:"`	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. When using a template, the # character doesn't count towards the length. Note "Narrow" characters are: `!,.;:"`	No
`Href`	string, nillable	The page URL where the ad will direct users. Maximum of 1024 characters. When using a template, the # character doesn't count towards the length. It must include the protocol and domain name. May contain substitution variables.	No
`AgeLabel`	AgeLabelEnum	Age category. If an ad does not have an age label, this parameter can't be set (the value is ignored).	No
`DisplayUrlPath`	string, nillable	Display link. Allowed only with the `Href` parameter. Maximum of 20 characters. When using a template, the # character doesn't count towards the length. It may contain letters, numbers, and the symbols -, №, /, %, #. Spaces, underscores (_), and double characters -- and // are not allowed. See Display link in the Yandex Direct Help.	No
`VCardId`	long, nillable	ID of the vCard. The vCard must belong to the same campaign as the ad. Alert This parameter is deprecated. The passed value won't be saved.	No
`AdImageHash`	string, nillable	Hash of the image. For text and image ads, only images with the REGULAR or WIDE type are acceptable. See Image type.	No
`SitelinkSetId`	long, nillable	ID of a set of sitelinks. Allowed only with the `Href` or `TurboPageId` parameter.	No
`CalloutSetting`	AdExtensionSetting, nillable	Callouts for an ad: To edit an existing set of callouts, use the ADD and REMOVE types of actions (see the description for the Operation parameter). To replace an existing set of callouts with a new set, use the SET action. To unassign all callouts, pass the nil (null) value.	No
`VideoExtension`	VideoExtensionUpdateItem	Video extension. See Video extensions in the Yandex Direct Help.	No
`PriceExtension`	PriceExtensionUpdateItem, nillable	Price in the ad.	No
`TurboPageId`	long, nillable	ID of the Turbo page. Alert This parameter is deprecated. The passed value won't be saved.	No
`BusinessId`	long, nillable	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/<profile_id>`	No
`PreferVCardOverBusiness`	YesNoEnum	Indicates which data source takes priority when displaying an ad: YES — vCard, NO — business profile. Alert This parameter is deprecated. Regardless of the value passed, it will default to `NO`.	No
`ErirAdDescription`	string	Description of a promoted object.	No
AdExtensionSetting structure
`AdExtensions`	array of AdExtensionSettingItem	Extensions to assign to the ad or unassign from the ad.	Yes
AdExtensionSettingItem structure
`AdExtensionId`	long	Extension ID.	Yes
`Operation`	AdExtensionTypeEnum	Type of action with the set of extensions: ADD — Assign the extension to the ad. REMOVE — Unassign the extension from the ad. SET — Replace the set of extensions and assign the extension to the ad as part of the new set. You can use SET with ADD and REMOVE. Make sure all items in the `AdExtensions` array are of the SET type. See the examples.	Yes
VideoExtensionUpdateItem structure
`CreativeId`	long, nillable	ID of the creative. To get the ID of a creative, use the Creatives.get method.	Yes
PriceExtensionUpdateItem 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.	No
`OldPrice`	long, nillable	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: FROM — "From". UP_TO — "To". NONE — No explanation.	No
`PriceCurrency`	PriceCurrencyEnum	The currency that the price is shown in.	No
MobileAppAdFeatureItem structure
`Feature`	MobileAppFeatureEnum	Type of extension: PRICE — price ICON — icon CUSTOMER_RATING — rating RATINGS — number of ratings (shown only if the rating is displayed) If the add-on type is omitted from the `Features` array, the add-on won't be displayed.	Yes
`Enabled`	YesNoEnum	Whether to display an add-on in the ad. Note If the add-on couldn't be downloaded from the app store, the YES value is available, but this add-on is not shown when displaying the ad. The number of ratings is only shown together with the average rating: if NO is set for the CUSTOMER_RATING type, but YES is set for RATINGS, the number of ratings is not displayed.	Yes
TextImageAdUpdate structure
`AdImageHash`	string	Hash of the image. For image ads, only images of the FIXED_IMAGE type are acceptable. See Type of image.	No
`Href`	string, nillable	The page URL where the ad will direct users. Maximum of 1024 characters. When using a template, the # character doesn't count towards the length. It must include the protocol and domain name. May contain substitution variables.	No
`TurboPageId`	long, nillable	ID of the Turbo page.	No
`ErirAdDescription`	string	Description of a promoted object.	No
TextAdBuilderAdUpdate structure
`Creative`	AdBuilderAdUpdateItem	A creative that was designed in the Ad Builder. See Creative Ad Builder for image ads in the Yandex Direct Help.	No
`Href`	string, nillable	The page URL where the ad will direct users. Maximum of 1024 characters. When using a template, the # character doesn't count towards the length. It must include the protocol and domain name. May contain substitution variables.	No
`TurboPageId`	long, nillable	ID of the Turbo page.	No
`ErirAdDescription`	string	Description of a promoted object.	No
CpmBannerAdBuilderAdUpdate structure
`Creative`	AdBuilderAdUpdateItem	A creative that was uploaded in the web interface or created in the Ad Builder. See Creating a display campaign in the Yandex Direct Help.	No
`Href`	string, nillable	The page URL where the ad will direct users. Maximum of 1024 characters. When using a template, the # character doesn't count towards the length. It must include the protocol and domain name. May contain substitution variables.	No
`TrackingPixels`	ArrayOfString, nillable	Can contain a maximum of two strings: A Yandex Audience pixel (see Pixel in the Yandex Audience Help). An ADFOX tracking tag. The tag must have the `%random%` or `%aw_random%` macro. The maximum length of each string is 1024 characters.	No
`TurboPageId`	long, nillable	ID of the Turbo page.	No
`ErirAdDescription`	string	Description of a promoted object.	No
CpmVideoAdBuilderAdUpdate structure
`Creative`	AdBuilderAdUpdateItem	A creative that was designed in the Ad Builder. See Video advertising / How to launch in Yandex Direct Help.	No
`Href`	string, nillable	The page URL where the ad will direct users. Maximum of 1024 characters. When using a template, the # character doesn't count towards the length. It must include the protocol and domain name. May contain substitution variables.	No
`TurboPageId`	long, nillable	ID of the Turbo page.	No
`TrackingPixels`	ArrayOfString, nillable	An ADFOX tracking tag. The tag must have the `%random%` or `%aw_random%` macro. Maximum of 1024 characters.	No
`ErirAdDescription`	string	Description of a promoted object.	No
AdBuilderAdUpdateItem structure
`CreativeId`	long	ID of the creative. To get the ID of a creative, use the Creatives.get method.	Yes
ShoppingAdUpdate structure
`SitelinkSetId`	long	ID of a set of sitelinks.	No
`CalloutSetting`	CalloutSetting	CalloutSetting	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/<profile_id>`	No
`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 retrieve the acceptable field names through the `TitleAndTextSources` field of the feeds.get method.	No
`TextSources`	array of string	Names of feed fields used to generate ad texts. You can retrieve the acceptable field names through the `TitleAndTextSources` field of the feeds.get method.	No
`DefaultTexts`	array of string	Default texts. You can specify only one value.	Yes
ListingAdUpdate structure
`SitelinkSetId`	long	ID of a set of sitelinks.	No
`CalloutSetting`	CalloutSetting	CalloutSetting	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/<profile_id>`	No
`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 retrieve the acceptable field names through the `TitleAndTextSources` field of the feeds.get method.	No
`TextSources`	array of string	Names of feed fields used to generate ad texts. You can retrieve the acceptable field names through the `TitleAndTextSources` field of the feeds.get method.	No
`DefaultTexts`	array of string	Default texts. You can specify only one value.	Yes
CalloutSetting structure
`AdExtensions`	AdExtensions	Extensions for an ad.	Yes
AdExtensions structure
`AdExtensionId`	long	Extension ID.	Yes
`Operation`	string	Action. Possible values: ADD REMOVE SET	Yes
FeedFilterConditionsItem structure
`Operand`	string	Feed parameter. For a description of the fields for each feed type, see Configuring filters in the Yandex Direct Help.	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 */
    "UpdateResults": [{  /* ActionResult */
      "Id": (long),
      "Warnings": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
       }, ...
      ],
      "Errors": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
       }, ...
      ]
    }, ... ] /* required */
  }
}

Parameter	Type	Description
result structure (for JSON) / UpdateResponse structure (for SOAP)
`UpdateResults`	array of ActionResult	Results of updating ad parameters.
ActionResult structure
`Id`	long	The ad ID. Returned if there aren't any errors. See the section Operations on object arrays.
`Warnings`	array of ExceptionNotification	Warnings that occurred during the operation.
`Errors`	array of ExceptionNotification	Errors that occurred during the operation.

Examples

Making changes to the set of ad extensions

The callouts with the IDs 111, 112, and 113 were assigned to the ad.

Executing the request will assign the callouts with the IDs 111, 112, 114, and 115 to the ad.

    {
      "method": "update",
      "params": {
        "Ads": [{
          "Id": 7654321,
          "TextAd": {
            "CalloutSetting": {
              "AdExtensions": [{
                "AdExtensionId": 114,
                "Operation": "ADD"
              },
              {
                "AdExtensionId": 115,
                "Operation": "ADD"
              },
              {
                "AdExtensionId": 113,
                "Operation": "REMOVE"
              }]
            }
          }
        }]
      }
    }

Replacing the set of extensions

The callouts with the IDs 111, 112, and 113 were assigned to the ad.

Executing the request will assign the callouts with the IDs 113 and 114 to the ad.

    {
      "method": "update",
      "params": {
        "Ads": [{
          "Id": 7654321,
          "TextAd": {
            "CalloutSetting": {
              "AdExtensions": [{
                "AdExtensionId": 113,
                "Operation": "SET"
              },
              {
                "AdExtensionId": 114,
                "Operation": "SET"
              }]
            }
          }
        }]
      }
    }

Was the article helpful?

unarchive

AdVideos: Operations with videos