Method: advertisers.channels.sites.list

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

درخواست HTTP

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/channels/{channelId}/sites

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

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

پارامترها
channel Id

string ( int64 format)

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

owner پارامتر اتحادیه مورد نیاز. موجودیت DV360 را که مالک کانال اصلی است شناسایی می کند. این می تواند یک شریک یا یک تبلیغ کننده باشد. owner تنها می تواند یکی از موارد زیر باشد:
advertiser Id

string ( int64 format)

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

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

پارامترها
page Size

integer

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

page Token

string

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

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

order By

string

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

  • urlOrAppId (پیش‌فرض)

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

filter

string

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

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

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

زمینه های پشتیبانی شده:

  • urlOrAppId

مثال ها:

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

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

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

owner پارامتر اتحادیه مورد نیاز. موجودیت DV360 را که مالک کانال اصلی است شناسایی می کند. این می تواند یک شریک یا یک تبلیغ کننده باشد. owner تنها می تواند یکی از موارد زیر باشد:
partner Id

string ( int64 format)

شناسه شریک مالک کانال اصلی.

درخواست بدن

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

بدن پاسخگو

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

محدوده مجوز

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

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

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