Delete

Deletes retargetings.

Alert

Disabled method. Use version 5 of the API.

For information about the compatibility of methods between versions Live 4 and 5, see the Migration guide.

Input data

The input data structure in JSON is shown below.

{
   "method": "Retargeting",
   "param": {
      /* RetargetingRequest */
      "Action": (string),
      "Login": (string), 
      "SelectionCriteria": {
         /* RetargetingSelectionCriteria */
         "RetargetingConditionIDS": [
            (int)
            ...
         ],
         "RetargetingIDS": [
            (int)
            ...
         ],
         "AdIDS": [
            (long)
            ...
         ]
      }
   }
}

Parameters are described below.

Parameter

Description

Required

RetargetingRequest object

Action

Action: Delete.

Yes

Login

The username of the client to delete the retargeting for.

For advertisers, this parameter is ignored.

For agencies

SelectionCriteria

The RetargetingSelectionCriteria object, which sets criteria for selecting retargeting objects to delete.

Yes

RetargetingSelectionCriteria object

RetargetingConditionIDS

Array of IDs of retargeting conditions to perform the operation for. Maximum of 1000 items in the array.

One of the parameters RetargetingConditionIDS, RetargetingIDS or AdIDS

RetargetingIDS

Array of retargeting IDs to perform the operation for. Maximum of 1000 items in the array.

AdIDS

Array of ad IDs to perform the operation for. Maximum of 1000 items in the array.

Notes

If the SelectionCriteria structure has more than one criterion set, the operation will be performed for those retargetings that simultaneously match all the criteria. For example, if the parameters RetargetingConditionIDS and AdIDS are set, the operation will be made for retargetings that have a condition ID that is in the RetargetingConditionIDS array, and an ad ID that is in the AdIDS array.

Output data

Returns an empty structure:

{ }

Examples of input data

Python

{
   'Action': 'Delete',
   'Login': 'agrom', 
   'SelectionCriteria': {
      'AdIDS': [2571703, 2571705, 2571707]
   }
}

PHP

array(
   'Action' => 'Delete',
   'Login' => 'agrom', 
   'SelectionCriteria' => array(
      'AdIDS' => array(2571703, 2571705, 2571707)
   )
)

Perl

{
   'Action' => 'Delete',
   'Login' => 'agrom',
   'SelectionCriteria' ={
      'AdIDS' => [2571703, 2571705, 2571707]
   }
}
Previous
Update
Next
Get