Method: users.list

उन उपयोगकर्ताओं की सूची बनाता है जिन्हें मौजूदा उपयोगकर्ता ऐक्सेस कर सकता है. अगर दो उपयोगकर्ताओं के पास एक ही पार्टनर या विज्ञापन देने वाले व्यक्ति या कंपनी के लिए उपयोगकर्ता की भूमिकाएं हैं, तो वे एक-दूसरे को ऐक्सेस कर सकते हैं.

इस तरीके से पुष्टि करने के लिए, खास शर्तें पूरी करनी होती हैं. इस तरीके का इस्तेमाल करने से पहले, उपयोगकर्ताओं को मैनेज करने के लिए बनी गाइड में दी गई ज़रूरी शर्तें पढ़ें.

"यह तरीका आज़माएं" सुविधा, इस तरीके के लिए काम नहीं करती.

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

GET https://displayvideo.googleapis.com/v3/users

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

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

पैरामीटर
pageSize

integer

पेज का अनुरोध किया गया साइज़. यह वैल्यू 1 और 200 के बीच होनी चाहिए. अगर कोई वैल्यू नहीं दी गई है, तो डिफ़ॉल्ट रूप से 100 लागू हो जाएगा.
pageToken

string

नतीजों के उस पेज की पहचान करने वाला टोकन जिसे सर्वर को दिखाना चाहिए. आम तौर पर, यह users.list वाले तरीके के पिछले कॉल से मिली nextPageToken की वैल्यू होती है. अगर कोई नंबर नहीं दिया जाता है, तो नतीजों का पहला पेज दिखेगा.
orderBy

string

वह फ़ील्ड जिससे सूची को क्रम से लगाया जा सकता है. स्वीकार की जा सकने वाली वैल्यू:

  • displayName (डिफ़ॉल्ट)

डिफ़ॉल्ट रूप से, डेटा को बढ़ते क्रम में क्रम से लगाया जाता है. किसी फ़ील्ड के लिए, डेटा को घटते क्रम में लगाने के लिए, फ़ील्ड के नाम में "desc" सफ़िक्स जोड़ें. उदाहरण के लिए, displayName desc.
filter

string

उपयोगकर्ता फ़ील्ड के हिसाब से फ़िल्टर करने की अनुमति देता है.

इस्तेमाल किए जा सकने वाले सिंटैक्स:

  • फ़िल्टर एक्सप्रेशन में एक या उससे ज़्यादा पाबंदियां होती हैं.
  • लॉजिकल ऑपरेटर AND की मदद से, पाबंदियों को जोड़ा जा सकता है.
  • पाबंदी का फ़ॉर्मैट {field} {operator} {value} होता है.
  • displayName और email फ़ील्ड में HAS (:) ऑपरेटर का इस्तेमाल करना ज़रूरी है.
  • lastLoginTime फ़ील्ड में LESS THAN OR EQUAL TO (<=) या GREATER THAN OR EQUAL TO (>=) ऑपरेटर का इस्तेमाल करना ज़रूरी है.
  • अन्य सभी फ़ील्ड में EQUALS (=) ऑपरेटर का इस्तेमाल करना ज़रूरी है.

इस्तेमाल किए जा सकने वाले फ़ील्ड:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType: यह AssignedUserRole का सिंथेटिक फ़ील्ड है, जिसका इस्तेमाल फ़िल्टर करने के लिए किया जाता है. इससे उस इकाई के टाइप की पहचान होती है जिसे उपयोगकर्ता की भूमिका असाइन की गई है. मान्य वैल्यू Partner और Advertiser हैं.
  • assignedUserRole.parentPartnerId: यह AssignedUserRole का सिंथेटिक फ़ील्ड है, जिसका इस्तेमाल फ़िल्टर करने के लिए किया जाता है. उस इकाई के पैरंट पार्टनर की पहचान करता है जिसे उपयोगकर्ता की भूमिका असाइन की गई है.
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email
  • lastLoginTime (ISO 8601 फ़ॉर्मैट में इनपुट या YYYY-MM-DDTHH:MM:SSZ)

उदाहरण:

  • "foo" वाला displayName वाला उपयोगकर्ता: displayName:"foo"
  • email में "bar" वाला उपयोगकर्ता: email:"bar"
  • स्टैंडर्ड यूज़र रोल वाले सभी उपयोगकर्ता: assignedUserRole.userRole="STANDARD"
  • पार्टनर 123 के लिए उपयोगकर्ता की भूमिकाएं रखने वाले सभी उपयोगकर्ता: assignedUserRole.partnerId="123"
  • विज्ञापन देने वाले 123 के लिए उपयोगकर्ता भूमिकाएं रखने वाले सभी उपयोगकर्ता: assignedUserRole.advertiserId="123"
  • पार्टनर लेवल की उपयोगकर्ता भूमिकाएं रखने वाले सभी उपयोगकर्ता: entityType="PARTNER"
  • पार्टनर 123 के लिए उपयोगकर्ता भूमिकाएं रखने वाले सभी उपयोगकर्ता और पार्टनर 123 के तहत विज्ञापन देने वाले: parentPartnerId="123"
  • ऐसे सभी उपयोगकर्ता जिन्होंने पिछली बार 01-01-2023T00:00:00Z (ISO 8601 फ़ॉर्मैट) को या उसके बाद लॉग इन किया था: lastLoginTime>="2023-01-01T00:00:00Z"

इस फ़ील्ड में 500 से ज़्यादा वर्ण नहीं होने चाहिए.

ज़्यादा जानकारी के लिए, LIST अनुरोधों को फ़िल्टर करने से जुड़ी हमारी गाइड देखें.

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

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

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

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

JSON के काेड में दिखाना 
{
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
users[]

object (User)

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

अगर यह सूची खाली है, तो यह नहीं दिखेगी.
nextPageToken

string

नतीजों का अगला पेज पाने के लिए टोकन. नतीजों का अगला पेज पाने के लिए, users.list तरीके के अगले कॉल में pageToken फ़ील्ड में यह वैल्यू पास करें. अगर कोई और नतीजा नहीं है, तो यह टोकन नहीं दिखेगा.

अनुमति के दायरे

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

  • https://www.googleapis.com/auth/display-video-user-management

ज़्यादा जानकारी के लिए, OAuth 2.0 Overview देखें.