Paginate query results

Merchant Center 查詢語言提供下列分頁欄位:

  • pageSize:單一要求中可擷取的資料列數量上限。預設為 1000 列的頁面大小上限。
  • pageToken:要傳回的網頁權杖。如未指定,系統會傳回第一頁。
  • nextPageToken:從 accounts.reports.search 呼叫取得下一頁的 pageToken 值。

提供 pageToken 時,呼叫中的所有其他參數都必須與上一個呼叫相符,以免發生非預期的行為。

舉例來說,如果您對擁有 100,000 個 offer_id 值的帳戶執行以下查詢,且 pageSize 設為 200,則結果只會在第一個回應中傳回 200 個 ReportRow 物件,以及一個 nextPageToken

SELECT offer_id, impressions, clicks, click_through_rate
FROM product_performance_view
WHERE date BETWEEN '2023-12-01' AND '2023-12-31'

以下是回應範例 (前五個結果和 nextPageToken):

{
  "results": [
    {
      "productPerformanceView": {
        "offerId": "12345",
        "clicks": "0",
        "impressions": "59",
        "clickThroughRate": 0
      }
    },
    {
      "productPerformanceView": {
        "offerId": "12346",
        "clicks": "9625",
        "impressions": "276695",
        "clickThroughRate": 0.034785594246372356
      }
    },
    {
      "productPerformanceView": {
        "offerId": "12347",
        "clicks": "148",
        "impressions": "22045",
        "clickThroughRate": 0.0067135404853708325
      }
    },
    {
      "productPerformanceView": {
        "offerId": "12348",
        "clicks": "11",
        "impressions": "1100",
        "clickThroughRate": 0.01
      }
    },
    {
      "productPerformanceView": {
        "offerId": "12349",
        "clicks": "569",
        "impressions": "62977",
        "clickThroughRate": 0.0090350445400701838
      }
    },
    ...
  ],
  "nextPageToken": "CMgB"
}

如要擷取接下來的 200 列,請再次傳送要求,並使用相同的頁面大小,但將要求的 pageToken 更新為先前回應中的 nextPageToken