This type defines the fields that paginate the campaigns 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 CampaignPagedCollectionResponse
Not used by any types.
Call that uses CampaignPagedCollectionResponse
GET
Fields
campaigns
array of Campaign
This array contains all of the seller's campaign that match the request criteria.
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.
next
The call URI that can be used to retrieve the next page in the result set. This value is returned only if there is an additional page of results to display from the result set.
Max length: 2048
Max length: 2048
offset
The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter.
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
Max length: 2048
total
The total number of campaigns retrieved in the result set.
If no campaigns are found, this field is returned with a value of
If no campaigns are found, this field is returned with a value of
0
.