Method: partners.channels.sites.list

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

درخواست HTTP

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

نشانی وب از نحو تراتبدیل 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

مثال‌ها:

  • همه سایت‌هایی که نشانی وب یا شناسه برنامه آن‌ها حاوی «google» است: urlOrAppId : "google"

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

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

string (int64 format)

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

متن درخواست

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

بدنه پاسخ

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

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

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

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

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