Method: customBiddingAlgorithms.list

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

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

درخواست HTTP

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

نشانی وب از نحو تراتبدیل 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

مثال‌ها:

  • همه الگوریتم‌های پیشنهاد قیمت سفارشی که نام نمایشی آن‌ها حاوی «سیاست» است: 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 ارسال کنید تا صفحه بعدی نتایج بازیابی شود. اگر این فیلد تهی باشد، یعنی این صفحه آخر است.

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

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

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

برای اطلاعات بیشتر، به OAuth 2.0 Overview مراجعه کنید.