صفحه بندی

Ad Manager API مجموعه‌ای از داده‌ها را فراهم می‌کند که معمولاً در روش‌های فهرست هستند. مجموعه ها می توانند دلخواه اندازه شوند و در پاسخ های API صفحه بندی شوند.

مبانی

پیام‌های درخواستی برای مجموعه‌ها، یک فیلد pageSize با عدد صحیح اختیاری برای تعیین حداکثر تعداد نتایج برای بازگشت تعریف می‌کنند.

اگر pageSize تنظیم نشده باشد یا 0 باشد، از مقدار پیش فرض 50 استفاده می شود. اگر اندازه pageSize از حداکثر اندازه صفحه 1000 بیشتر شود، API اندازه صفحه را به 1000 تغییر می دهد. مقادیر منفی منجر به خطای INVALID_ARGUMENT می شود.

API ممکن است نتایج کمتری نسبت به تعداد درخواستی (شامل نتایج صفر) نشان دهد، حتی اگر در انتهای مجموعه نباشد. از وجود قسمت nextPageToken برای تعیین اینکه آیا نتایج اضافی در مجموعه وجود دارد یا خیر استفاده کنید.

پیام های پاسخ برای مجموعه ها یک رشته رشته nextPageToken را تعریف می کنند که می تواند برای بازیابی صفحه بعدی استفاده شود. فیلد nextPageToken با رسیدن به پایان مجموعه خالی است. این تنها راه برای تعیین اینکه آیا به پایان یک مجموعه رسیده اید یا خیر.

پیام‌های درخواستی برای مجموعه‌ها یک فیلد رشته pageToken اختیاری را برای رفتن به صفحه بعدی مجموعه تعریف می‌کنند. تغییر در pageSize در درخواست برای صفحات بعدی مجاز است. همه استدلال های دیگر باید یکسان باشند. اگر هر یک از آرگومان‌ها متفاوت باشد، API یک خطای INVALID_ARGUMENT را برمی‌گرداند.

مثال

CURL

درخواست اولیه

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

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

درخواست صفحه بعد

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

{
  "adUnits": [ ... ]
}

اندازه کل

پیام های پاسخ برای مجموعه ها یک عدد صحیح totalSize ارائه می دهند که نشان دهنده تعداد کل موجودیت ها پس از اعمال فیلتر است. این فیلد فقط در صورت درخواست در فیلد ماسک پر می شود.

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

نتایج را سفارش دهید

پیام‌های درخواستی برای مجموعه‌ها، یک رشته orderBy را برای تعیین ترتیب مرتب‌سازی تعریف می‌کنند.

مقادیر باید فهرستی از فیلدها باشد که با کاما از هم جدا شده اند. به عنوان مثال: foo,bar . ترتیب مرتب سازی پیش فرض صعودی است. برای تعیین ترتیب نزولی برای یک فیلد، پسوند desc را اضافه کنید. برای مثال: foo desc, bar . کاراکترهای فضای اضافی در نحو نادیده گرفته می شوند. مقادیر orderBy foo, bar desc ، foo , bar desc و foo,bar desc همگی معادل هستند. زیر فیلدها با علامت مشخص می شوند . نویسه، مانند foo.bar یا address.street .

سفارش فقط در زمینه های ابتدایی پشتیبانی می شود.

رد شدن از نتایج

روش‌های یک عملیات صفحه‌بندی شده، یک فیلد skip عدد صحیح را برای پرش نتایج تعریف می‌کنند. مقدار پرش به تعداد منابع فردی برای پرش اشاره دارد، نه تعداد صفحات.

به عنوان مثال:

درخواستی بدون نشانه صفحه و مقدار پرش 30 یک صفحه از نتایج را که با نتیجه 31 شروع می شود، برمی گرداند.

درخواستی با نشانه صفحه مربوط به نتیجه 51 (زیرا 50 نتیجه اول در صفحه اول برگردانده شد) و مقدار پرش 30 یک صفحه از نتایج را که با نتیجه 81 شروع می شود برمی گرداند.

اگر یک مقدار پرش ارائه شود که باعث شود مکان نما از انتهای مجموعه نتایج عبور کند، پاسخ 200 OK با یک نتیجه خالی بدون nextPageToken است.

مهم: فیلد skip نباید به عنوان جایگزینی برای صفحه بندی استفاده شود. توکن صفحه‌بندی تضمین می‌کند که پاسخ از همان مجموعه نتایج اولیه است.