Method: customBiddingAlgorithms.list

الگوریتم‌های مناقصه سفارشی را که برای کاربر فعلی قابل دسترسی هستند و می‌توانند در استراتژی‌های مناقصه استفاده شوند، فهرست می‌کند.

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

درخواست HTTP

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

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

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

پارامترها
pageSize

integer

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

pageToken

string

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

orderBy

string

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

  • displayName (پیش‌فرض)

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

filter

string

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

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

  • عبارات فیلتر از یک یا چند محدودیت تشکیل شده‌اند.
  • محدودیت‌ها را می‌توان با AND ترکیب کرد. یک توالی از محدودیت‌ها به طور ضمنی از AND استفاده می‌کند.
  • یک محدودیت به شکل {field} {operator} {value} است.
  • فیلد customBiddingAlgorithmType باید از عملگر EQUALS (=) استفاده کند.
  • فیلد displayName باید از عملگر HAS (:) استفاده کند.

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

  • customBiddingAlgorithmType
  • displayName

مثال‌ها:

  • تمام الگوریتم‌های مناقصه سفارشی که نام نمایشی آنها شامل "politics" است: displayName:"politics" .
  • تمام الگوریتم‌های مناقصه سفارشی که نوع آنها "SCRIPT_BASED" است: customBiddingAlgorithmType=SCRIPT_BASED

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

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

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

string ( int64 format)

شناسه‌ی شریک DV360 که به الگوریتم پیشنهاد قیمت سفارشی دسترسی دارد.

advertiserId

string ( int64 format)

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

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

درخواست بدنه

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

بدنه پاسخ

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

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

object ( CustomBiddingAlgorithm )

فهرست الگوریتم‌های مناقصه سفارشی.

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

nextPageToken

string

یک توکن برای بازیابی صفحه بعدی نتایج. این مقدار را در فیلد pageToken در فراخوانی بعدی متد ListCustomBiddingAlgorithmsRequest برای بازیابی صفحه بعدی نتایج ارسال کنید. اگر این فیلد null باشد، به این معنی است که این آخرین صفحه است.

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

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

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

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