get

Returns the parameters of Turbo pages.

  1. Restrictions
  2. Request
  3. Response

Restrictions

The method returns a maximum of 10,000 objects.

The method returns only published Turbo pages.

Request

Request structure in JSON format:

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

Criteria for selecting Turbo pages.

To get all of an advertiser's published Turbo pages, omit SelectionCriteria.

No
FieldNames array of TurboPageFieldEnum Names of top-level parameters to get. Yes
Page LimitOffset

Structure that defines the page for paginated selection of data.

No
IdsCriteria structure
Ids array of long Selects Turbo pages with the specified IDs. From 1 to 10,000 items in the array. Yes

Response

Response structure in JSON format:

{
  "result": { /* result */
    "TurboPages": [{ /* TurboPageGetItem */ 
      "Id": (long), 
      "Name": (string),
      "Href": (string),
      "PreviewHref": (string)
    }, ... ],
    "LimitedBy": (long)
  }
}
Parameter Type Description
Result structure (for JSON) / GetResponse (for SOAP)
TurboPages array of TurboPageGetItem Turbo page parameters.
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.
TurboPageGetItem structure
Id long ID of the Turbo page.
Name string Name of the Turbo page.
Href string

Link to the published Turbo page.

PreviewHref string

Link for previewing the Turbo page.