Method: customers.userLists.list

רשימה של רשימות המשתמשים שמנוהלות על ידי הלקוח שצוין ב-Ads Data Hub.

בקשת HTTP

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

כתובת ה-URL כוללת תחביר gRPC קידוד מחדש.

פרמטרים של נתיב

פרמטרים
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 populateTime > "2012-04-21T11:30:00-04-21T11:30:00-04:2
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

תצוגת רשימת משתמשים

Enum כדי לציין אילו שדות יש לכלול בכל רשימת משתמשים שמוחזרת על ידי ה-[userLists.list] API.

Enums
USER_LIST_VIEW_UNSPECIFIED ערך ברירת המחדל / לא מוגדר. ברירת המחדל של ה-API תהיה תצוגה מלאה.
BASIC כוללים שדות מלבד [נמעןAdsDataLinks].
FULL הוסיפו הכול.