Skip to main content

This type defines the fields that paginate the ads returned by the request. The entire result set consists of 0 or more sequenced response pages, where each page consists of 0 or more items from the complete result set.

Types that use AdPagedCollectionResponse

Not used by any types.

Call that uses AdPagedCollectionResponse

Fields

Field
Type
Description
ads
array of Ad
The list of ads that matched the request criteria.
href
The URI of the current page of results from the result set.
limit
The number of items returned on a single page from the result set. This value can be set in the request with the limit query parameter.

Default: 10

next
The call URI that can be used to retrieve the next page in the result set. Basically, all of the request parameters will remain the same except the offset value, which will be increased to retrieve the next page of results.

Max length: 2048
offset
The number of results skipped in the result set before listing the first result on the current page. This value can be set in the request with the offset query parameter. If the offset value is not set, it defaults to zero.

Default: 0

Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.

prev
The call URI that can be used to retrieve the previous page in the result set. Basically, all of the request parameters will remain the same except the offset value, which will be decreased to retrieve the previous page of results.

Max length: 2048
total
The total number of items retrieved in the result set.

If no items are found, this field is returned with a value of 0.

Got thoughts? Click the feedback button – your insights help us improve!