Method: customers.userLists.list

يسرد قوائم المستخدمين التي يديرها عميل Ads Data Hub المحدّد.

طلب HTTP

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

يستخدم عنوان URL بنية gRPC Transcoding.

معلّمات المسار

المَعلمات
parent

string

مطلوبة. اسم مورد العميل الرئيسي، مثل 'customers/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فيلTime> "2012-04-21T11:30:00-04:
view

enum (UserListView)

تحدِّد الحقول المطلوب تضمينها في كل قائمة مستخدمين.
showDeleted

boolean

وفي حال ضبطها على "صحيح"، سيتم تضمين قوائم المستخدمين المحذوفة في الرد.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

الرد على طلب userLists.list. تحتوي على قوائم المستخدمين التي يديرها عميل Ads Data Hub المحدّد.

تمثيل JSON 
{
  "userLists": [
    {
      object (UserList)
    }
  ],
  "nextPageToken": string
}
الحقول
userLists[]

object (UserList)

قائمة بقوائم المستخدمين.
nextPageToken

string

رمز مميز يمكن استخدامه لطلب صفحة النتائج التالية. ويكون هذا الحقل فارغًا في حال عدم توفّر نتائج إضافية.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

قائمة المستخدمين

تعداد لتوضيح الحقول المطلوب تضمينها في كل قائمة مستخدمين والتي تعرضها واجهة برمجة التطبيقات [userLists.list].

عمليات التعداد
USER_LIST_VIEW_UNSPECIFIED القيمة التلقائية / بدون ضبط. وسيتم ضبط واجهة برمجة التطبيقات تلقائيًا على العرض الكامل.
BASIC أدرِج الحقول باستثناء [ReceivedAdsDataLinks].
FULL تضمين كل شيء.