Method: customLists.list

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

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

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

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

پارامترها
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" .

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

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

accessor پارامتر اتحادیه مورد نیاز. مشخص می کند که درخواست در کدام نهاد DV360 در حال انجام است. درخواست LIST فقط موجودیت‌های فهرست سفارشی را برمی‌گرداند که برای موجودیت DV360 شناسایی‌شده در accessor قابل دسترسی هستند. 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 مراجعه کنید.