Phân trang

API REST của Ad Manager cung cấp các tập hợp dữ liệu, phổ biến nhất là trong List . Các bộ sưu tập có thể được định kích thước tuỳ ý và được phân trang trong API phản hồi.

Thông tin cơ bản

Thông báo yêu cầu đối với bộ sưu tập sẽ xác định một trường số nguyên pageSize không bắt buộc để chỉ định số lượng kết quả tối đa cần trả về.

Nếu bạn không đặt pageSize hoặc đặt 0 thì giá trị mặc định là 50 sẽ được sử dụng. Nếu pageSize vượt quá kích thước trang tối đa là 1000, API sẽ buộc cỡ trang lên 1.000. Giá trị âm dẫn đến lỗi INVALID_ARGUMENT.

API có thể trả về ít kết quả hơn số lượng đã yêu cầu (bao gồm cả số không kết quả), ngay cả khi chúng không nằm ở cuối bộ sưu tập. Sử dụng sự hiện diện của Trường nextPageToken để xác định xem có kết quả bổ sung trong bộ sưu tập.

Thông báo phản hồi cho bộ sưu tập sẽ xác định trường chuỗi nextPageToken có thể dùng để truy xuất trang tiếp theo. Trường nextPageToken sẽ trống khi bộ sưu tập kết thúc đạt được. Đây là cách duy nhất để xác định xem bạn đã xem hết bộ sưu tập.

Thông báo yêu cầu về bộ sưu tập sẽ xác định một trường pageToken dạng chuỗi không bắt buộc để chuyển sang trang tiếp theo trong bộ sưu tập. Cho phép thay đổi pageSize trong yêu cầu cho các trang tiếp theo. Tất cả các đối số khác phải giống nhau; nếu có bất kỳ đối số nào khác nhau, API sẽ trả về lỗi INVALID_ARGUMENT.

Ví dụ:

cURL

Yêu cầu ban đầu

curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500

{
  "adUnits": [ ... ],
  "nextPageToken": "eCGwAcs6hUerggzd2DGv"
}

Yêu cầu trang tiếp theo

curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500&pageToken=eCGwAcs6hUerggzd2DGv

{
  "adUnits": [ ... ]
}

Tổng kích thước

Thông báo phản hồi cho bộ sưu tập cung cấp số nguyên totalSize đại diện tổng số thực thể sau khi áp dụng bộ lọc. Trường này chỉ được điền sẵn khi được yêu cầu trong fieldMask (mặt nạ trường).

GET https://admanager.googleapis.com/v1/networks/123456/adUnits?$fields=adUnits,nextPageToken,totalSize

Kết quả đơn đặt hàng

Thông báo yêu cầu về bộ sưu tập sẽ xác định trường chuỗi orderBy để chỉ định thứ tự sắp xếp.

Giá trị phải là một danh sách các trường được phân tách bằng dấu phẩy. Ví dụ: foo,bar. Thứ tự sắp xếp mặc định là tăng dần. Để chỉ định thứ tự giảm dần cho một trường, thêm một hậu tố desc; ví dụ: foo desc, bar. Các ký tự dấu cách thừa trong cú pháp sẽ bị bỏ qua. Các giá trị orderBy foo, bar desc, foo , bar desc và foo,bar desc đều tương đương. Các trường phụ được chỉ định bằng ký tự ., chẳng hạn như foo.bar hoặc address.street.

Tính năng sắp xếp thứ tự chỉ được hỗ trợ trên các trường gốc.

Bỏ qua kết quả

Các phương thức cho một thao tác được phân trang xác định một trường skip số nguyên cần bỏ qua kết quả. Giá trị bỏ qua là số lượng tài nguyên riêng lẻ cần bỏ qua, chứ không phải số trang.

Ví dụ:

Yêu cầu không có mã trang và giá trị bỏ qua là 30 sẽ trả về một trang duy nhất kết quả bắt đầu bằng kết quả thứ 31.

Yêu cầu có mã thông báo trang tương ứng với kết quả thứ 51 (vì kết quả đầu tiên 50 kết quả được trả về trên trang đầu tiên) và giá trị bỏ qua là 30 sẽ trả về một trang kết quả bắt đầu bằng kết quả thứ 81.

Nếu giá trị bỏ qua được cung cấp khiến con trỏ di chuyển qua cuối nút tập hợp kết quả, phản hồi là 200 OK với tập hợp kết quả trống không có nextPageToken.