Method: customLists.list

لیست‌های سفارشی را فهرست می‌کند.

ترتیب توسط پارامتر orderBy تعریف می‌شود.

درخواست HTTP

GET https://displayvideo.googleapis.com/v4/customLists

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای پرس و جو

پارامترها
pageSize

integer

اندازه صفحه درخواستی. باید بین 1 تا 200 باشد. اگر مشخص نشود، پیش‌فرض 100 خواهد بود. اگر مقدار نامعتبر مشخص شود، کد خطای INVALID_ARGUMENT را برمی‌گرداند.

pageToken

string

یک توکن که صفحه‌ای از نتایج را که سرور باید برگرداند، مشخص می‌کند. معمولاً این مقدار nextPageToken است که از فراخوانی قبلی متد customLists.list برگردانده شده است. اگر مشخص نشود، صفحه اول نتایج برگردانده خواهد شد.

orderBy

string

فیلدی که لیست بر اساس آن مرتب می‌شود. مقادیر قابل قبول عبارتند از:

  • customListId (پیش‌فرض)
  • displayName

ترتیب مرتب‌سازی پیش‌فرض صعودی است. برای تعیین ترتیب نزولی برای یک فیلد، باید پسوند "desc" به نام فیلد اضافه شود. مثال: displayName desc .

filter

string

امکان فیلتر کردن بر اساس فیلدهای لیست سفارشی را فراهم می‌کند.

سینتکس پشتیبانی شده:

  • عبارات فیلتر برای لیست‌های سفارشی فقط می‌توانند حداکثر شامل یک محدودیت باشند.
  • یک محدودیت به شکل {field} {operator} {value} است.
  • همه فیلدها باید از عملگر HAS (:) استفاده کنند.

فیلدهای پشتیبانی شده:

  • displayName

مثال‌ها:

  • تمام لیست‌های سفارشی که نام نمایشی آنها شامل "Google" است: displayName:"Google" .

طول این فیلد نباید بیش از ۵۰۰ کاراکتر باشد.

برای اطلاعات بیشتر به راهنمای درخواست‌های LIST فیلتر ما مراجعه کنید.

الزامی. مشخص می‌کند که درخواست در کدام موجودیت DV360 انجام می‌شود. درخواست LIST فقط موجودیت‌های لیست سفارشی را برمی‌گرداند که برای موجودیت DV360 شناسایی شده در accessor قابل دسترسی هستند. در زیر لیستی از فیلدهای ناسازگار آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
advertiserId

string ( int64 format)

شناسه‌ی تبلیغ‌کننده‌ی DV360 که به فهرست‌های سفارشی واکشی‌شده دسترسی دارد.

پایان میدان‌های ناسازگار.

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "customLists": [
    {
      object (CustomList)
    }
  ],
  "nextPageToken": string
}
فیلدها
customLists[]

object ( CustomList )

فهرست فهرست‌های سفارشی.

در صورت خالی بودن، این لیست وجود نخواهد داشت.

nextPageToken

string

یک توکن برای بازیابی صفحه بعدی نتایج. این مقدار را در فیلد pageToken در فراخوانی بعدی متد customLists.list برای بازیابی صفحه بعدی نتایج ارسال کنید.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/display-video

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .