Method: advertisers.reachForecast.retrievePlannableUserLists

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

درخواست HTTP

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

نشانی وب از نحو تراتبدیل 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"
  • فهرست‌های کاربر قابل‌برنامه‌ریزی با نام نمایشی حاوی «Shopping»: plannableStatus="PLANNABLE" AND displayName:"Shopping"
  • فهرست‌های کاربر طرف اول: userListType="FIRST_PARTY"

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

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

متن درخواست

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

بدنه پاسخ

Response for 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 مراجعه کنید.

PlannableUserList

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

نمایش 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)

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

UserListType

انواع فهرست‌های کاربر.

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

PlannableStatus

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

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