请求中的分页 Yandex Market API 卖家须知

有些查询不会完整返回结果，而是逐页返回结果。 要获得完整结果，请运行多个连续查询。 — 在每个新请求中，传递一个带有下一页结果的参数。

根据需要传递哪个参数，分页可以有两种类型:

• 与页面ID — 参数 pageToken;
• 与页码 — 参数 page.

如果方法中两种类型的分页都可用，请使用page ID（pageToken），而不是她的号码。

使用页面ID进行分页

方法的例子:

• POST v2/businesses/{businessId}/offer-cards
• POST v2/campaigns/{campaignId}/offer-prices
• GET v2/campaigns/{campaignId}/returns
• POST v1/businesses/{businessId}/orders

要获得完整的结果:

1. 在哪里提出要求:

   • 不要把它传递出去 pageToken.
   • 如果需要，发送 limit. 在参数的每个方法的规范中 limit 值被指定 minimum, maximum 和 default. 如果不传递参数，将使用默认值。

   自动减少 limit

   有些方法会自动减少传递的值。 limit 以前 maximum 如果超过允许的最大值 — 这在参数描述中指示。 limit 这样的方法。

   方法的例子:

   • GET v2/campaigns/{campaignId}/returns
   • POST v1/businesses/{businessId}/orders

   响应将返回参数 paging.

2. 如果在 paging 返回的参数 nextPageToken 所以，有结果的下一页。 重复请求，其中传递值 nextPageToken 在参数中 pageToken.

   参数值 nextPageToken

   这不是页码，而是需要在请求中传递的字符串。

   如果没有参数，则返回最后一页。 提出更多要求 不需要.

3. 继续执行请求，直到它返回 nextPageToken.

用页码分页

方法的例子:

• GET v2/campaigns
• GET v2/regions/{regionId}/children

要获得完整的结果:

1. 在哪里提出要求:

   • 不要把它传递出去 page.
   • 如果需要，发送 pageSize. 然后这个参数将需要在每个后续请求中传递。

   响应将返回参数 pager 与结果页数 pagesCount.

2. 如果在 pagesCount 返回多个页面，重复请求 — 在参数中 page 发送页码(2, 3 到最后一个）。