delete

Deletes ad groups.

Learn more

Restrictions

Maximum of 10,000 groups per method call.

You can only delete an empty group that doesn't contain ads or targeting criteria (keywords, audience targets, or dynamic text ad targets).

You can't delete groups from archived campaigns.

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 groups to delete.

Yes

IdsCriteria structure

Ids

array of long

IDs of the groups that you want 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 groups.

ActionResult structure

Id

long

ID of the deleted group. 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.

Previous
Next