set

Changes the coefficient values in bid adjustments.

  1. Request
  2. Response

Request

Request structure in JSON format:

{
  "method": "set",
  "params": { /* params */
    "BidModifiers": [{  /* BidModifierSetItem */
      "Id": (long), /* required */
      "BidModifier": (int) /* required */
    }, ... ] /* required */
  }
}
Parameter Type Description Required
Params structure (for JSON) / SetRequest structure (for SOAP)
BidModifiers array of BidSetItem Coefficient values. Maximum of 1000 items in the array. Yes
BidModifierSetItem structure
Id long Bid adjustment ID. Yes
BidModifier int

Coefficient value.

Specified as a percent:

  • From 50 to 1300 for mobile and video adjustments.

  • From 0 to 1300 for adjustments for gender, age, and website users.

  • From 10 to 1300 for regional adjustments.

The bid is multiplied by the value of BidModifier/100.

Yes

Response

Response structure in JSON format:

{
  "result": { /* result */
    "SetResults": [{  /* 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) / SetResponse structure (for SOAP)
SetResults array of ActionResult Results of changing coefficients.
ActionResult structure
Id long Bid adjustment 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.