get

Returns the parameters of Turbo pages.## Learn more

How the "get" method works

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), ... ],
      "BoundWithHrefs": [(string), ...]
    },
    "FieldNames": [( "Id" | "Name" | "Href" | "PreviewHref" | "TurboSiteHref" | "BoundWithHref" ), ... ], /* 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.	No
`BoundWithHrefs`	array of string	Select Turbo pages with the specified links.	No

Response

Response structure in JSON format:

{
  "result": { /* result */
    "TurboPages": [{ /* TurboPageGetItem */
      "Id": (long),
      "Name": (string),
      "Href": (string),
      "PreviewHref": (string),
      "TurboSiteHref": (string),
      "BoundWithHref": (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.
`TurboSiteHref`	string	Link in the format `name.turbo.site`. If the link is not associated with a Turbo page, the value is empty.
`BoundWithHref`	string	The link where the Turbo page was found (it matches the link from the query parameters, without case-folding and normalization).

Was the article helpful?

TurboPages: getting parameters of Turbo pages

VCards: operations with vCards