Method: partners.channels.sites.list

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

درخواست HTTP

GET https://displayvideo.googleapis.com/v4/partners/{partnerId}/channels/{channelId}/sites

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
channelId

string ( int64 format)

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

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

string ( int64 format)

شناسه شریکی که مالک کانال والد است.

پایان میدان‌های ناسازگار.

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

پارامترها
pageSize

integer

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

pageToken

string

یک توکن که صفحه‌ای از نتایج را که سرور باید برگرداند، مشخص می‌کند.

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

orderBy

string

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

  • urlOrAppId (پیش‌فرض)

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

filter

string

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

سینتکس پشتیبانی شده:

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

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

  • urlOrAppId

مثال‌ها:

  • همه سایت‌هایی که URL یا شناسه برنامه آنها شامل "google" است: urlOrAppId : "google"

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

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

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

string ( int64 format)

شناسه تبلیغ‌کننده‌ای که مالک کانال اصلی است.

پایان میدان‌های ناسازگار.

درخواست بدنه

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

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ شامل نمونه‌ای از ListSitesResponse است.

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

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

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .