Method: customers.userLists.list

उन उपयोगकर्ताओं की सूचियां बनाता है जिन्हें खास Ads Data Hub ग्राहक मैनेज करता है.

एचटीटीपी अनुरोध

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

यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल होता है.

पाथ पैरामीटर

पैरामीटर
parent

string

ज़रूरी है. पैरंट ग्राहक संसाधन का नाम, जैसे, #33;customers/123'

क्वेरी पैरामीटर

पैरामीटर
pageSize

integer

लौटाए जाने वाले सामान की ज़्यादा से ज़्यादा संख्या. अगर 0 है, तो सर्वर रिटर्न की जाने वाली उपयोगकर्ता सूचियों की संख्या तय करेगा.
pageToken

string

पिछले कॉल से मिले पेज टोकन का इस्तेमाल, नतीजों के अगले पेज का अनुरोध करने के लिए किया जाता है.
filter

string

उदाहरण फ़िल्टर: शीर्षक = "user*" AND title = "*name*" AND -type = FREQUENCY_BASED AND CreateEmail = "creator@email.com " AND listSize > 10 AND popTimeTime > "2012-04-00:30:30:30:0
view

enum (UserListView)

इससे पता चलता है कि हर उपयोगकर्ता सूची में कौनसे फ़ील्ड शामिल करने हैं.
showDeleted

boolean

अगर नीति को 'सही है' पर सेट किया जाता है, तो मिटाए गए उपयोगकर्ता सूचियों को जवाब में शामिल किया जाएगा.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

userLists.list अनुरोध का जवाब. इसमें, बताई गई ऐसी उपयोगकर्ता सूचियां होती हैं जिन्हें Ads Data Hub के ज़रिए मैनेज किया जाता है.

जेएसओएन के काेड में दिखाना 
{
  "userLists": [
    {
      object (UserList)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
userLists[]

object (UserList)

उपयोगकर्ता सूचियों की सूची.
nextPageToken

string

एक टोकन जिसे अगले परिणाम पेज के लिए अनुरोध करने के लिए उपयोग किया जा सकता है. कोई अतिरिक्त परिणाम नहीं होने पर यह फ़ील्ड खाली होता है.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

यूज़रलिस्ट व्यू

[userLists.list] एपीआई से मिली हर उपयोगकर्ता सूची में शामिल किए जाने वाले फ़ील्ड की जानकारी देने के लिए Enum.

Enums
USER_LIST_VIEW_UNSPECIFIED डिफ़ॉल्ट / सेट नहीं की गई वैल्यू. एपीआई डिफ़ॉल्ट रूप से पूरे व्यू पर सेट होगा.
BASIC [यहां adsAdsLinks] को छोड़कर, फ़ील्ड शामिल करें.
FULL हर चीज़ शामिल करें.