delete

Deletes sets of sitelinks.

Learn more

Restrictions

Maximum of 1000 sets per method call.

If a set of sitelinks is assigned to an ad, it can't be deleted.

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

Yes

IdsCriteria structure

Ids

array of long

IDs of sitelink sets to delete (no more than 1000).

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 sitelink sets.

ActionResult object

Id

long

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