Method: customBiddingAlgorithms.rules.list

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

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

درخواست HTTP

GET https://displayvideo.googleapis.com/v5/customBiddingAlgorithms/{customBiddingAlgorithmId}/rules

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

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

پارامترها
customBiddingAlgorithmId

string (int64 format)

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

پارامترهای پُرسمان

پارامترها
pageSize

integer

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

pageToken

string

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

orderBy

string

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

  • createTime desc (پیش‌فرض)

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

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

string (int64 format)

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

advertiserId

string (int64 format)

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

پایان فیلدهای متقابلاً انحصاری.

متن درخواست

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

بدنه پاسخ

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

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

object (CustomBiddingAlgorithmRules)

فهرست منابع CustomBiddingAlgorithmRules.

اگر این فهرست خالی باشد، نمایش داده نخواهد شد.

nextPageToken

string

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

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

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

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

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