set
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 percentage:
The bid is multiplied by the value of BidModifier/100. | Yes |
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 percentage:
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 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) / SetResponse structure (for SOAP) | ||
---|---|---|
SetResults | array of ActionResult | Results of changing coefficients. |
ActionResult structure | ||
Id | long | Bid adjustment ID. 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. |