Method: customers.userLists.list

فهرست‌های کاربرانی را که توسط مشتری Ads Data Hub مدیریت می‌شوند، فهرست می‌کند.

درخواست HTTP

GET https://adsdatahub.googleapis.com/v1/{parent=customers/*}/userLists

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

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

مولفه های
parent

string

ضروری. نام منبع مشتری والدین، به عنوان مثال «مشتریان/123».

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

مولفه های
pageSize

integer

حداکثر تعداد اقلام برای بازگشت. اگر 0 باشد، سرور تعداد لیست های کاربر را برای بازگشت تعیین می کند.

pageToken

string

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

filter

string

فیلتر مثال: title = "user*" AND title = "*name*" AND -type = FREQUENCY_BASED AND createEmail = "creator@email.com" AND listSize > 10 AND populateTime > "2012-04-21T11:30:00- 04:00 "

view

enum ( UserListView )

مشخص می کند که کدام فیلدها را در لیست هر کاربر قرار دهد.

showDeleted

boolean

اگر روی true تنظیم شود، لیست های کاربران حذف شده در پاسخ گنجانده می شود.

درخواست بدن

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

بدن پاسخگو

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

پاسخ به درخواست userLists.list. حاوی لیست های کاربری است که توسط مشتری مشخص شده Ads Data Hub مدیریت می شود.

نمایندگی JSON
{
  "userLists": [
    {
      object (UserList)
    }
  ],
  "nextPageToken": string
}
زمینه های
userLists[]

object ( UserList )

لیستی از لیست های کاربران

nextPageToken

string

نشانه ای که می تواند برای درخواست صفحه نتایج بعدی استفاده شود. در صورت عدم وجود نتایج اضافی، این فیلد خالی است.

محدوده مجوز

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

  • https://www.googleapis.com/auth/adsdatahub

UserListView

Enum برای نشان دادن اینکه کدام فیلدها باید در هر لیست کاربری که توسط [userLists.list] API بازگردانده شده باشد، گنجانده شود.

Enums
USER_LIST_VIEW_UNSPECIFIED مقدار پیش فرض / تنظیم نشده. API به طور پیش فرض در نمای FULL خواهد بود.
BASIC شامل فیلدها به جز [recipientAdsDataLinks].
FULL همه چیز را شامل شود.