update

Changes the parameters of smart banner targeting filters.

  1. Restrictions
  2. Request
  3. Response

Restrictions

Maximum of 1000 filters per method call.

Request

Request structure in JSON format:

{
  "method": "update",
  "params": { /* params */
    "SmartAdTargets" : [{ /* SmartAdTargetUpdateItem */
      "Id": (long), /* required */
      "Name": (string),
      "AverageCpc": (long), /* nillable */
      "AverageCpa": (long), /* nillable */
      "StrategyPriority": ( "LOW" | "NORMAL" | "HIGH" ),
      "Audience": ( "INTERESTED_IN_SIMILAR_PRODUCTS" | "VISITED_PRODUCT_PAGE" | "ALL_SEGMENTS" )
    }, ... ]  /* required */
  }
} 
Parameter Type Description Required
Params structure (for JSON) / AddRequest structure (for SOAP)
SmartAdTargets array of SmartAdTargetUpdateItem Filters. Yes
SmartAdTargetUpdateItem structure
Id long The ID of the filter. Yes
Name string Name of the filter (maximum of 100 characters). No
AverageCpc long, nillable Average CPC multiplied by 1,000,000. Integer.

Specified in the advertiser's currency. Restrictions are listed in the currency reference. To get it, use the Dictionaries.get method and specify the Currencies dictionary name in the request.

No
AverageCpa long, nillable Average CPC multiplied by 1,000,000. Integer.

Specified in the advertiser's currency. Restrictions are listed in the currency reference. To get it, use the Dictionaries.get method and specify the Currencies dictionary name in the request.

No
StrategyPriority PriorityEnum Priority: LOW, NORMAL or HIGH. Used only for the AVERAGE_ROI strategy. No
Audience AudienceEnum Target audience:
  • INTERESTED_IN_SIMILAR_PRODUCTS —Users who showed interest in similar products online.
  • VISITED_PRODUCT_PAGE — Users who viewed products on the advertiser's site.
  • ALL_SEGMENTS — Both groups.
No

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 changing filter parameters.
ActionResult structure
Id long The ID of the filter. 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.