Method: advertisers.reachForecast.retrievePlannableUserLists

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

درخواست HTTP

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:retrievePlannableUserLists

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

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

پارامترها
advertiserId

string ( int64 format)

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

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

پارامترها
pageSize

integer

اختیاری. اندازه صفحه درخواستی. باید بین 1 تا 5000 باشد. اگر مشخص نشود، به طور پیش‌فرض 5000 خواهد بود.

pageToken

string

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

filter

string

اختیاری. امکان فیلتر کردن بر اساس ویژگی‌های قابل برنامه‌ریزی لیست کاربران را فراهم می‌کند.

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

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

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

  • plannableStatus
  • displayName
  • userListType
  • name

مثال‌ها:

  • همه لیست‌های کاربران قابل برنامه‌ریزی: plannableStatus="PLANNABLE"
  • فهرست‌های کاربری قابل برنامه‌ریزی با نام نمایشی شامل "خرید": plannableStatus="PLANNABLE" AND displayName:"Shopping"
  • فهرست کاربران شخص اول: userListType="FIRST_PARTY"

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

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

درخواست بدنه

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

بدنه پاسخ

پاسخ برای reachForecast.retrievePlannableUserLists.

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

نمایش JSON 
{
  "plannableUserLists": [
    {
      object (PlannableUserList)
    }
  ],
  "nextPageToken": string
}
فیلدها
plannableUserLists[]

object ( PlannableUserList )

فقط خروجی. فهرست فهرست‌های کاربری قابل برنامه‌ریزی.

nextPageToken

string

فقط خروجی. یک توکن برای بازیابی صفحه بعدی نتایج.

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

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

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

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

لیست کاربران قابل برنامه‌ریزی

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

نمایش JSON 
{
  "displayName": string,
  "userListType": enum (UserListType),
  "name": string,
  "plannableStatus": enum (PlannableStatus)
}
فیلدها
displayName

string

فقط خروجی. نام نمایشی لیست کاربران.

userListType

enum ( UserListType )

فقط خروجی. نوع لیست کاربران.

name

string

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

قالب: advertisers/{advertiserId}/userLists/{user_list_id}

plannableStatus

enum ( PlannableStatus )

فقط خروجی. وضعیت قابلیت برنامه‌ریزی فهرست کاربران.

نوع لیست کاربر

انواع لیست کاربران

انوم‌ها
USER_LIST_TYPE_UNSPECIFIED نوع فهرست کاربران نامشخص.
FIRST_PARTY فهرست کاربران شخص اول.
THIRD_PARTY فهرست کاربران شخص ثالث.

وضعیت قابل برنامه‌ریزی

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

انوم‌ها
PLANNABLE_STATUS_UNSPECIFIED وضعیت قابلیت برنامه‌ریزی نامشخص.
PLANNABLE فهرست کاربران قابل برنامه‌ریزی است.
UNPLANNABLE فهرست کاربران غیرقابل برنامه‌ریزی است.