get

Returns sets of sitelinks that match the specified criteria.

  1. Restrictions
  2. Request
  3. Response

Restrictions

The method returns a maximum of 10,000 objects.

Request

Request structure in JSON format:

{
  "method": "get",
  "params": {  /* params */
    "SelectionCriteria": {  /* IdsCriteria */
      "Ids": [(long), ... ] /* required */ 
    },
    "FieldNames": [( "Id" | "Sitelinks" ), ... ], 
    "SitelinkFieldNames": [( "Title" | "Href" | "Description" | "TurboPageId" ), ... ],
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  } 
}
Parameter Type Description Required
Params structure (for JSON) / GetRequest (for SOAP)
SelectionCriteria IdsCriteria

Criteria for selecting sets. If omitted, all the advertiser's sets are returned.

No
FieldNames array of SitelinksSetFieldEnum

Names of top-level parameters to get.

If the Sitelinks value is specified, then the Sitelinks array returns the following sitelink fields: Title, Href, Description.

If you need to get a different set of fields, list their names in the SitelinkFieldNames parameter, and do not specify the Sitelinks value in the FieldNames parameter.

No
SitelinkFieldNames array of SitelinkFieldEnum Names of sitelink fields to get. No
Page LimitOffset

Structure that defines the page for paginated selection of data.

No
IdsCriteria structure
Ids array of long

IDs of sets to get.

Yes

Response

Response structure in JSON format:

{
  "result": { /* result */
    "SitelinksSets": [{  /* SitelinksSetGetItem */
      "Id": (long),
      "Sitelinks": [{  /* Sitelink */
        "Title": (string), 
        "Href": (string), /* nillable */ 
        "Description": (string), /* nillable */ 
        "TurboPageId": (long) /* nillable */ 
      }, ... ] 
    }, ... ],
    "LimitedBy": (long)
  }
}
Parameter Type Description
Result structure (for JSON) / GetResponse (for SOAP)
SitelinksSets array of SitelinksSetGetItem Sets of sitelinks.
LimitedBy long Sequential number of the last object returned. It is included if there was a limit on the number of objects in the response. See the section Paginated data selection.
SitelinksSetGetItem structure
Id long ID of a set of sitelinks.