add

Creates sets of sitelinks.

  1. Restrictions
  2. Request
  3. Response

Restrictions

Maximum of 1000 sets of sitelinks per method call.

If all the fields in the sets are identical, only one set is created.

Request

Request structure in JSON format:

{
  "method": "add",
  "params": { /* params */
    "SitelinksSets": [{  /* SitelinksSetAddItem */
      "Sitelinks": [{  /* Sitelink */
        "Title": (string), /* required */
        "Href": (string), 
        "Description": (string),
        "TurboPageId": (long) 
       }, ... ] /* required */ 
    }, ... ] /* required */
  } 
}
Parameter Type Description Required
Params structure (for JSON) / AddRequest structure (for SOAP)
SitelinksSets array of SitelinksSetAddItem The sets of sitelinks to add. Yes
SitelinksSetAddItem structure
TurboPageId long ID of the Turbo page.

Response

Response structure in JSON format:

{
  "result": { /* result */
    "AddResults": [{  /* 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) / AddResponse structure (for SOAP)
AddResults array of ActionResult Results of adding sets of sitelinks.
ActionResult object
Id long ID of the created 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.