Method: partners.channels.list

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

درخواست HTTP

GET https://displayvideo.googleapis.com/v5/partners/{partnerId}/channels

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

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

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

string (int64 format)

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

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

پارامترها
pageSize

integer

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

string

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

string

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

  • displayName (پیش‌فرض)
  • channelId

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

string

امکان فیلتر کردن براساس فیلدهای کانال را فراهم می‌کند.

نحو پشتیبانی‌شده:

  • عبارت‌های فیلتر برای کانال فقط می‌تواند حداکثر یک محدودیت داشته باشد.
  • محدودیت به‌صورت {field} {operator} {value} است.
  • همه فیلدها باید از اپراتور HAS (:) استفاده کنند.

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

  • displayName

مثال‌ها:

  • همه کانال‌هایی که نام نمایشی آن‌ها حاوی «google» است: displayName : "google".

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

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

string (int64 format)

شناسه تبلیغ‌کننده‌ای که مالک کانال‌ها است.
پایان فیلدهای متقابلاً انحصاری.

متن درخواست

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

بدنه پاسخ

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

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

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

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

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