Documentation

set

Changes the coefficient values in bid adjustments.

Request

Request structure in JSON format:

{
  "method": "set",
  "params": { 
    "BidModifiers
[no-highlight[

Coefficient values. Maximum of 1000 items in the array.

Required

Yes

]no-highlight]
": [{ /* BidModifierSetItem */ "Id
[no-highlight[

Bid adjustment ID.

Required

Yes

]no-highlight]
": (long), /* required */ "BidModifier
[no-highlight[

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.

Required

Yes

]no-highlight]
": (int) /* required */ }, ... ] /* required */ } }
Parameter Type Description Required
params structure (for JSON) / SetRequest structure (for SOAP)
BidModifiers array of BidSetItemCoefficient values. Maximum of 1000 items in the array.Yes
BidModifierSetItem structure
Id longBid 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": { 
    "SetResults
[no-highlight[

Results of changing coefficients.

]no-highlight]
": [{ /* ActionResult */ "Id
[no-highlight[

Bid adjustment ID. Returned if there are no errors; see the section Operations on object arrays.

]no-highlight]
": (long), "Warnings
[no-highlight[

Warnings that occurred during the operation.

]no-highlight]
": [{ /* ExceptionNotification */ "Code": (int), /* required */ "Message": (string), /* required */ "Details": (string) }, ... ], "Errors
[no-highlight[

Errors that occurred during the operation.

]no-highlight]
": [{ /* ExceptionNotification */ "Code": (int), /* required */ "Message": (string), /* required */ "Details": (string) }, ... ] }, ... ] } }
Parameter Type Description
result structure (for JSON) / SetResponse structure (for SOAP)
SetResults array of ActionResultResults of changing coefficients.
ActionResult structure
Id longBid adjustment ID. Returned if there are no 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.