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" ), ... ], /* required */
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  } 
}
ParameterTypeDescriptionRequired
Params structure (for JSON) / GetRequest (for SOAP)
SelectionCriteriaIdsCriteria

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

No
FieldNamesarray of SitelinksSetFieldEnum

The names of parameters to get.

Yes
PageLimitOffset

Structure that defines the page for paginated selection of data.

No
IdsCriteria structure
Idsarray of long

IDs of sets to get.

Yes

Response

Note. The response contains only those parameters that were indicated in the FieldName input parameter.

Response structure in JSON format:

{
  "result": { /* result */
    "SitelinksSets": [{  /* SitelinksSetGetItem */
      "Id": (long),
      "Sitelinks": [{  /* Sitelink */
        "Title": (string), /* required */
        "Href": (string), /* required */
        "Description": (string)  
     }, ... ] 
    }, ... ],
    "LimitedBy": (long)
  }
}
ParameterTypeDescription
Result structure (for JSON) / GetResponse (for SOAP)
SitelinksSetsarray of SitelinksSetGetItemSets of sitelinks.
LimitedBylongSequential 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
IdlongID of a set of sitelinks.
DescriptionstringSitelink description for displaying the ad in expanded format.