delete

Deletes keywords and autotargetings.

  1. Restrictions
  2. Request
  3. Response

Restrictions

Maximum of 10,000 objects per method call.

Request

Request structure in JSON format:

{
  "method": "delete",
  "params": { /* params */
    "SelectionCriteria": {  /* IdsCriteria */
      "Ids": [(long), ... ] /* required */ 
    } /* required */
  } 
}
Parameter Type Description Required
Params structure (for JSON) / DeleteRequest structure (for SOAP)
SelectionCriteria IdsCriteria Criteria for selecting the keywords and autotargetings to delete. Yes
IdsCriteria structure
Ids array of long IDs of keywords and autotargetings to delete (maximum of 10,000). Yes
Parameter Type Description Required
Params structure (for JSON) / DeleteRequest structure (for SOAP)
SelectionCriteria IdsCriteria Criteria for selecting the keywords and autotargetings to delete. Yes
IdsCriteria structure
Ids array of long IDs of keywords and autotargetings to delete (maximum of 10,000). Yes

Response

Response structure in JSON format:

{
  "result": {  /* result */
    "DeleteResults": [{  /* 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) / DeleteResponse structure (for SOAP)
DeleteResults array of ActionResult Results of deleting keywords or autotargetings.
ActionResult structure
Id long ID of the deleted keyword or autotargeting. 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) / DeleteResponse structure (for SOAP)
DeleteResults array of ActionResult Results of deleting keywords or autotargetings.
ActionResult structure
Id long ID of the deleted keyword or autotargeting. 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.