Method: customBiddingAlgorithms.list

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

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

درخواست HTTP

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

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

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

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

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

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

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