Dziel wyniki zapytania na strony

Aby obsługiwać zbiory wyników zawierające dużą liczbę wierszy, język zapytań Merchant Center obsługuje podział na strony. Dostępne są 2 parametry służące do kontrolowania podziału na strony w ciele żądania reports.search: page_sizepage_token, a także 1 pole wyjściowe w ciele odpowiedzi: next_page_token.

Parametr page_size określa maksymalną liczbę wierszy do pobrania w pojedynczym żądaniu. Jeśli nie zostanie podany, zostanie automatycznie ustawiony maksymalny rozmiar strony wynoszący 1000 wierszy.

Parametr page_token określa token strony, która ma zostać zwrócona. Jeśli nie jest określony, zwracana jest pierwsza strona. Aby pobrać kolejną stronę, wartość otrzymana jako next_page_token z poprzedniego wywołania reports.search powinna być podana jako page_token. Gdy podany jest parametr page_token, wszystkie inne parametry wywołania powinny być takie same jak w poprzednim wywołaniu, które zwróciło parametr page_token, aby uniknąć nieoczekiwanego działania.

Przykład:

SELECT
  segments.offer_id,
  metrics.impressions,
  metrics.clicks,
  metrics.ctr
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2021-12-01' AND '2021-12-31'

W przypadku tego zapytania załóżmy, że konto zawiera 1 000 offer_ids,a wartość parametru page_size to 200. W pierwszej odpowiedzi zbiór wyników będzie zawierać 200 obiektów ReportRow oraz obiekt next_page_token.

Aby pobrać kolejne 200 wierszy, wyślij żądanie ponownie z tym samym rozmiarem strony, ale zaktualizuj parametr page_token na next_page_token z poprzedniej odpowiedzi.

Oto przykład treści odpowiedzi (pierwsze 5 wyników plus next_page_token):

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