Method: customBiddingAlgorithms.rules.list

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

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

درخواست HTTP

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

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

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

پارامترها
customBiddingAlgorithmId

string ( int64 format)

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

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

پارامترها
pageSize

integer

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

pageToken

string

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

orderBy

string

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

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

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

accessor پارامتر اتحادیه مورد نیاز. موجودیت DV360 را که مالک الگوریتم مناقصه سفارشی والد است، شناسایی می کند. این می تواند یک شریک یا یک تبلیغ کننده باشد. accessor می تواند تنها یکی از موارد زیر باشد:
partnerId

string ( int64 format)

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

advertiserId

string ( int64 format)

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

درخواست بدن

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

بدن پاسخگو

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

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

object ( CustomBiddingAlgorithmRules )

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

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

nextPageToken

string

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

محدوده مجوز

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

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

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